flightsimulatorplatfrom/openfsd
1
0
Fork 0
mirror of https://github.com/renorris/openfsd synced 2026-04-27 03:05:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

tweak REST API docs

Browse Source
This commit is contained in:
Reese Norris
2025-05-23 12:07:55 -07:00
parent 97a6292974
commit 3929e1115f
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
web/README.md
View File

@@ -31,7 +31,7 @@ All API responses follow a standard `APIV1Response` structure:
} }
``` ```
- **err**: Contains an error message if the request fails; otherwise, null. - **err**: Contains an error message if the request fails; otherwise, null.
- **data**: Contains the response data if the request succeeds; otherwise, null. - **data**: Contains the response data if relevant.
Common HTTP status codes: Common HTTP status codes:
- **200 OK**: Request succeeded. - **200 OK**: Request succeeded.
@@ -50,6 +50,8 @@ Common HTTP status codes:
#### POST /api/v1/auth/login #### POST /api/v1/auth/login
Obtain access and refresh tokens using FSD login credentials. Obtain access and refresh tokens using FSD login credentials.
NOTE: Do not use this endpoint for programmatic access from an external application.
Instead, generate an API token using the Configure Server menu via the frontend.
**Request Body**: **Request Body**:
```json ```json
@@ -83,6 +85,8 @@ Obtain access and refresh tokens using FSD login credentials.
#### POST /api/v1/auth/refresh #### POST /api/v1/auth/refresh
Refresh an access token using a refresh token. Refresh an access token using a refresh token.
NOTE: Do not use this endpoint for programmatic access from an external application.
Instead, generate an API token using the Configure Server menu via the frontend.
**Request Body**: **Request Body**:
```json ```json
@@ -179,6 +183,7 @@ Retrieve user information by CID.
#### PATCH /api/v1/user/update #### PATCH /api/v1/user/update
Update user information by CID. Update user information by CID.
The CID itself is immutable and is only provided as reference of the user to update.
**Request Body**: **Request Body**:
```json ```json
@@ -328,6 +333,7 @@ Update server configuration key-value pairs.
#### POST /api/v1/config/resetsecretkey #### POST /api/v1/config/resetsecretkey
Reset the JWT secret key used for signing tokens. Reset the JWT secret key used for signing tokens.
Upon successfully calling this endpoint, this effectively invalidates *all* previously-administered authentication tokens. All users using the frontend will be logged out. All previously-generated API tokens will be invalidated.
**Request**: No body required. **Request**: No body required.