-
Notifications
You must be signed in to change notification settings - Fork 529
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Adds help menu
- Loading branch information
Showing
3 changed files
with
36 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
description: Overview of the Dispatch API. | ||
--- | ||
|
||
# API | ||
|
||
Dispatch's API documentation is generated automatically. To see your installations available API visit `https://<your-dispatch-domain>/api/v1/docs` | ||
|
||
While we don't currently maintain or distribute API clients, because we generate our API documentation via the OpenAPI spec it is available to any client generation libraries that can read the spec. You can find the raw spec for your installation at: | ||
|
||
`https://<your-dispatch-domain>/api/v1/docs/openapi.json` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters