pi-hole/FTL
1
0
Fork 0
mirror of https://github.com/pi-hole/FTL.git synced 2024-10-26 16:52:18 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Move /api/{ftl -> info}/client, /api/ftl/dbinfo -> /api/info/database, /api/ftl/sysinfo -> /api/info/system, and /api/version -> /api/info/version

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2023-01-18 20:16:31 +01:00
parent aeb61a3026
commit 37bafc1365
8 changed files with 303 additions and 325 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/api/docs/content/specs/ftl.yaml → src/api/docs/content/specs/info.yaml
+154 -12
View File
@@ -17,10 +17,10 @@ components:
application/json:
schema:
allOf:
- $ref: 'ftl.yaml#/components/schemas/client/remote_addr'
- $ref: 'ftl.yaml#/components/schemas/client/http_version'
- $ref: 'ftl.yaml#/components/schemas/client/method'
- $ref: 'ftl.yaml#/components/schemas/client/headers'
- $ref: 'info.yaml#/components/schemas/client/remote_addr'
- $ref: 'info.yaml#/components/schemas/client/http_version'
- $ref: 'info.yaml#/components/schemas/client/method'
- $ref: 'info.yaml#/components/schemas/client/headers'
logs:
dns:
get:
@@ -37,7 +37,7 @@ components:
The expected behavior for an immediate re-request of a log line with the same ID is an empty response.
As soon as the next message arrived, this will be included in your request and `nextID` is incremented by one.
parameters:
- $ref: 'ftl.yaml#/components/parameters/logs/dns/nextID'
- $ref: 'info.yaml#/components/parameters/logs/dns/nextID'
responses:
'200':
description: OK
@@ -45,15 +45,15 @@ components:
application/json:
schema:
allOf:
- $ref: 'ftl.yaml#/components/schemas/logs/dns/log'
- $ref: 'ftl.yaml#/components/schemas/logs/dns/nextID'
- $ref: 'info.yaml#/components/schemas/logs/dns/log'
- $ref: 'info.yaml#/components/schemas/logs/dns/nextID'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: 'common.yaml#/components/errors/unauthorized'
sysinfo:
system:
get:
summary: Get info about various system parameters
tags:
@@ -68,15 +68,15 @@ components:
application/json:
schema:
allOf:
- $ref: 'ftl.yaml#/components/schemas/system'
- $ref: 'ftl.yaml#/components/schemas/ftl'
- $ref: 'info.yaml#/components/schemas/system'
- $ref: 'info.yaml#/components/schemas/ftl'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: 'common.yaml#/components/errors/unauthorized'
dbinfo:
database:
get:
summary: Get info about long-term database
tags:
@@ -91,7 +91,22 @@ components:
application/json:
schema:
allOf:
- $ref: 'ftl.yaml#/components/schemas/database'
- $ref: 'info.yaml#/components/schemas/database'
version:
get:
summary: Get Pi-hole version
tags:
- "FTL information"
operationId: "get_version"
description: |
Request versions of the individual Pi-hole components
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: 'info.yaml#/components/schemas/version'
schemas:
client:
remote_addr:
@@ -439,6 +454,133 @@ components:
type: string
description: Version of embedded SQLite3 engine
example: "3.34.0"
version:
type: object
properties:
version:
type: object
properties:
core:
type: object
properties:
local:
type: object
properties:
branch:
type: string
nullable: true
description: Local Pi-hole Core branch
example: "development"
version:
type: string
nullable: true
description: Local Pi-hole Core version
example: "v6.1"
hash:
type: string
nullable: true
description: Local Pi-hole Core hash
example: "955e36a9"
remote:
type: object
properties:
version:
type: string
nullable: true
description: Remote (Github) Pi-hole Core version
example: "v6.1"
hash:
type: string
nullable: true
description: Remote (Github) Pi-hole Core hash
example: "955e36a9"
web:
type: object
properties:
local:
type: object
properties:
branch:
type: string
nullable: true
description: Local Pi-hole Web branch
example: "devel"
version:
type: string
nullable: true
description: Local Pi-hole Web version
example: "v6.1"
hash:
type: string
nullable: true
description: Local Pi-hole Web hash
example: "f69f7e88"
remote:
type: object
properties:
version:
type: string
nullable: true
description: Remote (Github) Pi-hole Web version
example: "v6.1"
hash:
type: string
nullable: true
description: Remote (Github) Pi-hole Web hash
example: "f69f7e88"
ftl:
type: object
properties:
local:
type: object
properties:
branch:
type: string
nullable: true
description: Local Pi-hole FTL branch
example: "development"
version:
type: string
nullable: true
description: Local Pi-hole FTL version
example: "v6.1"
hash:
type: string
nullable: true
description: Local Pi-hole FTL hash
example: "64441ed6-dirty"
date:
type: string
nullable: true
description: Build time of your local Pi-hole FTL
example: "2023-01-09 20:25:24 +0100"
remote:
type: object
properties:
version:
type: string
nullable: true
description: Remote (Github) Pi-hole FTL version
example: "v6.1"
hash:
type: string
nullable: true
description: Remote (Github) Pi-hole FTL hash
example: "64441ed6"
docker:
type: object
properties:
local:
type: string
nullable: true
description: Local Pi-hole Docker image version (`null` if not running in Docker)
example: "v6.1"
remote:
type: string
nullable: true
description: Remote (Docker Hub) Pi-hole Docker image version (`null` if not running in Docker)
example: "v6.1"
parameters:
logs:
src/api/docs/content/specs/main.yaml
+9 -9
View File
@@ -134,14 +134,17 @@ paths:
/lists:
$ref: 'lists.yaml#/components/paths/direct'
/ftl/client:
$ref: 'ftl.yaml#/components/paths/client'
/info/client:
$ref: 'info.yaml#/components/paths/client'
/ftl/sysinfo:
$ref: 'ftl.yaml#/components/paths/sysinfo'
/info/system:
$ref: 'info.yaml#/components/paths/system'
/ftl/dbinfo:
$ref: 'ftl.yaml#/components/paths/dbinfo'
/info/database:
$ref: 'info.yaml#/components/paths/database'
/info/version:
$ref: 'info.yaml#/components/paths/version'
/logs/dnsmasq:
$ref: 'logs.yaml#/components/paths/logs/dnsmasq'
@@ -179,9 +182,6 @@ paths:
/network/interfaces:
$ref: 'network.yaml#/components/paths/interfaces'
/version:
$ref: 'version.yaml#/components/paths/version'
components:
securitySchemes:
sidHeader:
src/api/docs/content/specs/version.yaml
-146
View File
@@ -1,146 +0,0 @@
openapi: 3.0.2
components:
paths:
version:
get:
summary: Get Pi-hole version
tags:
- "FTL information"
operationId: "get_version"
description: |
Request versions of the individual Pi-hole components
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: 'version.yaml#/components/schemas/version'
schemas:
version:
type: object
properties:
version:
type: object
properties:
core:
type: object
properties:
local:
type: object
properties:
branch:
type: string
nullable: true
description: Local Pi-hole Core branch
example: "development"
version:
type: string
nullable: true
description: Local Pi-hole Core version
example: "v6.1"
hash:
type: string
nullable: true
description: Local Pi-hole Core hash
example: "955e36a9"
remote:
type: object
properties:
version:
type: string
nullable: true
description: Remote (Github) Pi-hole Core version
example: "v6.1"
hash:
type: string
nullable: true
description: Remote (Github) Pi-hole Core hash
example: "955e36a9"
web:
type: object
properties:
local:
type: object
properties:
branch:
type: string
nullable: true
description: Local Pi-hole Web branch
example: "devel"
version:
type: string
nullable: true
description: Local Pi-hole Web version
example: "v6.1"
hash:
type: string
nullable: true
description: Local Pi-hole Web hash
example: "f69f7e88"
remote:
type: object
properties:
version:
type: string
nullable: true
description: Remote (Github) Pi-hole Web version
example: "v6.1"
hash:
type: string
nullable: true
description: Remote (Github) Pi-hole Web hash
example: "f69f7e88"
ftl:
type: object
properties:
local:
type: object
properties:
branch:
type: string
nullable: true
description: Local Pi-hole FTL branch
example: "development"
version:
type: string
nullable: true
description: Local Pi-hole FTL version
example: "v6.1"
hash:
type: string
nullable: true
description: Local Pi-hole FTL hash
example: "64441ed6-dirty"
date:
type: string
nullable: true
description: Build time of your local Pi-hole FTL
example: "2023-01-09 20:25:24 +0100"
remote:
type: object
properties:
version:
type: string
nullable: true
description: Remote (Github) Pi-hole FTL version
example: "v6.1"
hash:
type: string
nullable: true
description: Remote (Github) Pi-hole FTL hash
example: "64441ed6"
docker:
type: object
properties:
local:
type: string
nullable: true
description: Local Pi-hole Docker image version (`null` if not running in Docker)
example: "v6.1"
remote:
type: string
nullable: true
description: Remote (Docker Hub) Pi-hole Docker image version (`null` if not running in Docker)
example: "v6.1"