Move /api/endpoints to /api/ftl/endpoints and add /api/ftl/endpoints documentation

Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2022-12-31 13:11:52 +01:00
parent e9f5f667fa
commit ffbe2bd370
4 changed files with 42 additions and 5 deletions
+1 -2
View File
@@ -103,8 +103,7 @@ components:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns_port'
$ref: '#/components/schemas/dns_port'
schemas:
blocking:
type: object
+30
View File
@@ -92,6 +92,27 @@ components:
schema:
allOf:
- $ref: '#/components/schemas/database'
endpoints:
get:
summary: Get list of available API endpoints
tags:
- "FTL information"
operationId: "get_endpoints"
description: |
This API hook returns the list of all available API endpoints.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/endpoints'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: 'common.yaml#/components/errors/unauthorized'
schemas:
client:
remote_addr:
@@ -389,6 +410,15 @@ components:
type: string
description: Version of embedded SQLite3 engine
example: "3.34.0"
endpoints:
type: object
properties:
endpoints:
type: array
description: Endpoints
items:
type: string
example: ["/api/dns/blocking", "/api/dns/cache", "/api/dns/port", "/api/domains", "/api/groups", "/api/lists"]
parameters:
logs:
+3
View File
@@ -107,6 +107,9 @@ paths:
/ftl/dbinfo:
$ref: 'ftl.yaml#/components/paths/dbinfo'
/ftl/endpoints:
$ref: 'ftl.yaml#/components/paths/endpoints'
/version:
$ref: 'version.yaml#/components/paths/version'