Skip to content

Commit 537faea

Browse files
committed
doc updates
1 parent ab35ef4 commit 537faea

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

docs/src/api/index.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/open-api-docs.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,13 @@ Service health and monitoring endpoints:
5353
- `GET /__lbheartbeat__` - Load balancer health check
5454
- `GET /__version__` - Service version information
5555

56+
### Exploring the Sync API
57+
To aid in exploring your own Sync API with Swagger, you may want to acquire your UID and other details about your Sync account. The easiest way to do so is to use the About Sync Extension. Note that this extension only works on Desktop.
58+
59+
[Firefox Extensions Page for About Sync](https://addons.mozilla.org/en-US/firefox/addon/about-sync/)
60+
[GitHub Repository for About Sync](https://github.com/mozilla-extensions/aboutsync)
61+
62+
5663
### Maintenance
5764

5865
When adding new endpoints:
@@ -63,6 +70,9 @@ When adding new endpoints:
6370

6471
### Generating the OpenAPI Spec Locally
6572

73+
#### Use `make api-prev`
74+
We created a handy Makefile command called `make api-prev` that automatically generates the specification file, runs Swagger in Docker and opens your browser to `localhost:8080`. See the steps below to understand this process. Note this attempts to be platform agnostic, but might require some adaptation depending on your operating system.
75+
6676
You can generate the OpenAPI specification without running the server:
6777

6878
```bash

0 commit comments

Comments
 (0)