NotAShelf/pinakes
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity Actions
pinakes/docs/api/config.md
NotAShelf 7a0a009ced
 docs: auto-generate API route documentation 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Id0d1f9769b7ccdbf83d5fa78adef62e46a6a6964
2026-03-22 17:58:40 +03:00

1.9 KiB
Raw Blame History

Config

Server configuration

Endpoints

GET /api/v1/config

Authentication: Required (Bearer JWT)

Responses

Status Description
200 Current server configuration
401 Unauthorized
403 Forbidden
500 Internal server error

POST /api/v1/config/roots

Authentication: Required (Bearer JWT)

Request Body

Content-Type: application/json

See docs/api/openapi.json for the full schema.

Responses

Status Description
200 Updated configuration
400 Bad request
401 Unauthorized
403 Forbidden
500 Internal server error

DELETE /api/v1/config/roots

Authentication: Required (Bearer JWT)

Request Body

Content-Type: application/json

See docs/api/openapi.json for the full schema.

Responses

Status Description
200 Updated configuration
401 Unauthorized
403 Forbidden
500 Internal server error

PATCH /api/v1/config/scanning

Authentication: Required (Bearer JWT)

Request Body

Content-Type: application/json

See docs/api/openapi.json for the full schema.

Responses

Status Description
200 Updated configuration
401 Unauthorized
403 Forbidden
500 Internal server error

GET /api/v1/config/ui

Authentication: Required (Bearer JWT)

Responses

Status Description
200 UI configuration
401 Unauthorized
500 Internal server error

PATCH /api/v1/config/ui

Authentication: Required (Bearer JWT)

Request Body

Content-Type: application/json

See docs/api/openapi.json for the full schema.

Responses

Status Description
200 Updated UI configuration
401 Unauthorized
403 Forbidden
500 Internal server error