-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
34 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,32 @@ | ||
--- | ||
tags: | ||
- developer | ||
- api | ||
- backend | ||
--- | ||
|
||
# Developer & API Docs | ||
|
||
You can find the OpenAPI Documentation here: [api.OpenShock.app/swagger](https://api.openshock.app/swagger) | ||
|
||
## Backend Architecture | ||
|
||
![Backend Architecture Diagram](../../static/developer/backend-architecture-overview.svg) | ||
|
||
|
||
## OpenAPI Documentation | ||
|
||
You can find the OpenAPI Documentation here: [api.OpenShock.app/swagger](https://api.openshock.app/swagger) | ||
|
||
Note that there is both a [Definition Version 1](https://api.openshock.app/swagger/1/swagger.json) and [Definition Version 2](https://api.openshock.app/swagger/1/swagger.json) file. | ||
|
||
!!! hint "Version Definition Files" | ||
You might notice that Version 2 does not contain all the endpoints that are in Version 1. That is because version 2 only contains endpoints that actually make a version 1 equivalent obsolete and there for deprecated. | ||
TL;DR; Prefer endpoints in Definition Version 2 over 1 | ||
|
||
The OpenAPI documentation contains all HTTP endpoints, but does not document the WebSockets and SignalR hubs. | ||
|
||
## WebSockets | ||
|
||
There is a few different WebSocket endpoints. Most of them use json. The Hub (previously named Device) websocket uses flatbuffers binary serialization. | ||
|
||
- /1/ |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.