diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2021-04-12 10:40:14 -0700 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2021-04-12 10:40:14 -0700 |
| commit | 91b76672a759de4cd368260e709b94d70b2f2e40 (patch) | |
| tree | a7f7882e91229be740e74c985fcea054a706a86e /guide/src | |
| parent | b61e2e020a9249ab04be7484f4159a9dc1ca4a83 (diff) | |
| download | fatcat-91b76672a759de4cd368260e709b94d70b2f2e40.tar.gz fatcat-91b76672a759de4cd368260e709b94d70b2f2e40.zip | |
guide and openapi schema: fix QA URLs, and disclaim QA instance
Diffstat (limited to 'guide/src')
| -rw-r--r-- | guide/src/editing_quickstart.md | 4 | ||||
| -rw-r--r-- | guide/src/http_api.md | 4 |
2 files changed, 4 insertions, 4 deletions
diff --git a/guide/src/editing_quickstart.md b/guide/src/editing_quickstart.md index 05728d58..56fb2357 100644 --- a/guide/src/editing_quickstart.md +++ b/guide/src/editing_quickstart.md @@ -4,8 +4,8 @@ This tutorial describes how to make edits to the Fatcat catalog using the web interface. We will add a new `file` to an existing `release`, then update the release to point at a different `container`. You can follow these directions on -either the [QA](https://qa.fatcat.wiki) or [production](https://fatcat.wiki) -public catalogs. You will: +either the [QA](https://qa.fatcat.wiki) (NOTE: QA not available as of Spring +2021) or [production](https://fatcat.wiki) public catalogs. You will: - create an editor account and log-in - create a new `file` entity diff --git a/guide/src/http_api.md b/guide/src/http_api.md index e1b7f557..7c6fc2aa 100644 --- a/guide/src/http_api.md +++ b/guide/src/http_api.md @@ -7,7 +7,7 @@ A declarative specification of all API endpoints, JSON data models, and response types is available in OpenAPI 2.0 format. Code generation tools are used to generate both server-side type-safe endpoint routes and client-side libraries. Auto-generated reference documentation is, for now, available at -<https://api.qa.fatcat.wiki>. +<https://api.fatcat.wiki>. All API traffic is over HTTPS; there is no HTTP endpoint, even for read-only operations. All endpoints accept and return only JSON serialized content. @@ -67,7 +67,7 @@ metadata, it is possible to include linked entities in responses using the includes an optional `container_id` field which points to a container entity. If the `expand` parameter is set: - https://api.qa.fatcat.wiki/v0/release/aaaaaaaaaaaaarceaaaaaaaaam?expand=container + https://api.fatcat.wiki/v0/release/aaaaaaaaaaaaarceaaaaaaaaam?expand=container Then the full container model will be included under the `container` field. Multiple expand parameters can be passed, comma-separated. |