Skip to content

Commit ac9e11f

Browse files
committed
tokenserver url and doc refs
1 parent b6d9aa6 commit ac9e11f

2 files changed

Lines changed: 14 additions & 10 deletions

File tree

docs/src/open-api-docs.md

Lines changed: 10 additions & 8 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.
10+
11+
Please take care to select the URL for Tokenserver for Tokenserver requests and the Syncstorage URL for Syncstorage requests.
812

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,13 +24,6 @@ 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 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-
- **Stage**: `https://sync-us-west1-g.sync.services.allizom.org`.
23-
- **Prod**: `https://sync-1-us-west1-g.sync.services.mozilla.com`.
24-
2527
URLs for Swagger and OpenAPI Spec:
2628
- **Swagger UI (Interactive)**: `https://<your-deployment-url>/swagger-ui/`
2729
- **OpenAPI Spec (JSON)**: `https://<your-deployment-url>/api-doc/openapi.json`

syncserver/src/server/mod.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,10 @@ pub fn cfg_path(path: &str) -> String {
8787
description = "OpenAPI documentation for Syncstorage and Tokenserver endpoints."
8888
),
8989
servers(
90-
(url = "https://sync-us-west1-g.sync.services.allizom.org", description = "US West Stage"),
91-
(url = "https://sync-1-us-west1-g.sync.services.mozilla.com", description = "US West Production"),
90+
(url = "https://stage-tokenserver.sync.nonprod.webservices.mozgcp.net", description = "Tokenserver Stage"),
91+
(url = "https://prod-tokenserver.sync.prod.webservices.mozgcp.net", description = "Tokenserver Production"),
92+
(url = "https://sync-us-west1-g.sync.services.allizom.org", description = "Syncstorage - US West Stage"),
93+
(url = "https://sync-1-us-west1-g.sync.services.mozilla.com", description = "Syncstorage - US West Prod"),
9294
),
9395
paths(
9496
// Syncstorage general info endpoints.

0 commit comments

Comments
 (0)