Skip to content

Commit 84ad808

Browse files
committed
doc clarification
1 parent 6587a84 commit 84ad808

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

docs/src/open-api-docs.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,17 @@
44

55
This project uses [utoipa](https://crates.io/crates/utoipa) and [utoipa-swagger-ui](https://crates.io/crates/utoipa-swagger-ui) to provide interactive API documentation.
66

7-
### Accessing the Documentation
7+
### Accessing and Working With the Documentation
8+
It is suggested to use the stage instance of Sync and/or Tokenserver when playing with the API,
9+
though you may also interact with your data in the production instance.
810

11+
Please take care to select the URL for Tokenserver for Tokenserver requests and the Syncstorage URL for Syncstorage requests.
12+
13+
The Prod and Stage environments below will be available as a drop-down in the SwaggerUI:
14+
- **Sync Stage**: `https://sync-us-west1-g.sync.services.allizom.org`.
15+
- **Sync Prod**: `https://sync-1-us-west1-g.sync.services.mozilla.com`.
16+
- **Tokenserver Stage**: `https://stage-tokenserver.sync.nonprod.webservices.mozgcp.net`.
17+
- **Tokenserver Prod**: `https://prod-tokenserver.sync.prod.webservices.mozgcp.net`.
918
#### On GitHub Pages (Static Documentation):
1019

1120
The project automatically publishes API documentation to GitHub Pages:
@@ -15,14 +24,7 @@ The project automatically publishes API documentation to GitHub Pages:
1524
- **OpenAPI/Swagger UI**: https://mozilla-services.github.io/syncstorage-rs/swagger-ui/
1625

1726
#### When the service is running (live deployment):
18-
It is suggested to use the stage instance of Sync and/or Tokenserver when playing with the API,
19-
though you may also interact with your data in the production instance.
20-
21-
The Prod and Stage environments below will be available as a drop-down in the SwaggerUI:
22-
- **Sync Stage**: `https://sync-us-west1-g.sync.services.allizom.org`.
23-
- **Sync Prod**: `https://sync-1-us-west1-g.sync.services.mozilla.com`.
24-
- **Tokenserver Stage**: `https://stage-tokenserver.sync.nonprod.webservices.mozgcp.net`.
25-
- **Tokenserver Prod**: `https://prod-tokenserver.sync.prod.webservices.mozgcp.net`.
27+
I
2628

2729
URLs for Swagger and OpenAPI Spec:
2830
- **Swagger UI (Interactive)**: `https://<your-deployment-url>/swagger-ui/`

0 commit comments

Comments
 (0)