mirror of
https://github.com/pi-hole/FTL.git
synced 2024-10-26 16:52:18 +02:00
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:
@@ -103,8 +103,7 @@ components:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/dns_port'
|
||||
$ref: '#/components/schemas/dns_port'
|
||||
schemas:
|
||||
blocking:
|
||||
type: object
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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'
|
||||
|
||||
|
||||
Reference in New Issue
Block a user