hexware/fastapi-dls
1
0
Fork 0
mirror of https://git.collinwebdesigns.de/oscar.krause/fastapi-dls.git synced 2024-11-23 23:41:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

README updated

Browse Source
This commit is contained in:
Oscar Krause 2024-06-27 08:47:04 +02:00
parent 3c321a202c
commit 8af3c8e2b3
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -515,32 +515,32 @@ Done. For more information check [troubleshoot section](#troubleshoot).
8. Set schedule to `At First Array Start Only` 8. Set schedule to `At First Array Start Only`
9. Click on Apply 9. Click on Apply
# Endpoints # API Endpoints
<details> <details>
<summary>show</summary> <summary>show</summary>
### `GET /` **`GET /`**
Redirect to `/-/readme`. Redirect to `/-/readme`.
### `GET /-/health` **`GET /-/health`**
Status endpoint, used for *healthcheck*. Status endpoint, used for *healthcheck*.
### `GET /-/config` **`GET /-/config`**
Shows current runtime environment variables and their values. Shows current runtime environment variables and their values.
### `GET /-/readme` **`GET /-/readme`**
HTML rendered README.md. HTML rendered README.md.
### `GET /-/manage` **`GET /-/manage`**
Shows a very basic UI to delete origins or leases. Shows a very basic UI to delete origins or leases.
### `GET /-/origins?leases=false` **`GET /-/origins?leases=false`**
List registered origins. List registered origins.
@ -548,11 +548,11 @@ List registered origins.
|-----------------|---------|--------------------------------------| |-----------------|---------|--------------------------------------|
| `leases` | `false` | Include referenced leases per origin | | `leases` | `false` | Include referenced leases per origin |
### `DELETE /-/origins` **`DELETE /-/origins`**
Deletes all origins and their leases. Deletes all origins and their leases.
### `GET /-/leases?origin=false` **`GET /-/leases?origin=false`**
List current leases. List current leases.
@ -560,11 +560,11 @@ List current leases.
|-----------------|---------|-------------------------------------| |-----------------|---------|-------------------------------------|
| `origin` | `false` | Include referenced origin per lease | | `origin` | `false` | Include referenced origin per lease |
### `DELETE /-/lease/{lease_ref}` **`DELETE /-/lease/{lease_ref}`**
Deletes an lease. Deletes an lease.
### `GET /-/client-token` **`GET /-/client-token`**
Generate client token, (see [installation](#installation)). Generate client token, (see [installation](#installation)).