oscar.krause/fastapi-dls
2
3
Fork 1
Code Issues 5 Pull Requests Releases Activity

README.md - removed links from endpoints

Browse Source
This commit is contained in:
Oscar Krause 2023-01-02 11:39:37 +01:00
parent de5f07273b
commit 8c515b7f2e
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -15,27 +15,27 @@ Only the clients need a connection to this service on configured port.
## Endpoints ## Endpoints
### [`GET /`](/) ### `GET /`
Redirect to `/-/readme`. Redirect to `/-/readme`.
### [`GET /status`](/status) (deprecated: use `/-/health`) ### `GET /status` (deprecated: use `/-/health`)
Status endpoint, used for *healthcheck*. Shows also current version and commit hash. Status endpoint, used for *healthcheck*. Shows also current version and commit hash.
### [`GET /-/health`](/-/health) ### `GET /-/health`
Status endpoint, used for *healthcheck*. Shows also current version and commit hash. Status endpoint, used for *healthcheck*. Shows also current version and commit hash.
### [`GET /-/readme`](/-/readme) ### `GET /-/readme`
HTML rendered README.md. HTML rendered README.md.
### [`GET /-/docs`](/-/docs), [`GET /-/redoc`](/-/redoc) ### `GET /-/docs`, `GET /-/redoc`
OpenAPI specifications rendered from `GET /-/openapi.json`. OpenAPI specifications rendered from `GET /-/openapi.json`.
### [`GET /-/manage`](/-/manage) ### `GET /-/manage`
Shows a very basic UI to delete origins or leases. Shows a very basic UI to delete origins or leases.
@ -63,7 +63,7 @@ List current leases.
Deletes an lease. Deletes an lease.
### `GET /client-token` ### `GET /client-token` (deprecated: use `/-/client-token`)
Generate client token, (see [installation](#installation)). Generate client token, (see [installation](#installation)).