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

Implement deep-recursion of API arrays

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2023-10-30 07:42:51 +01:00
parent 4fea41c4d9
commit f4e6dfc061
5 changed files with 160 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/api/docs/content/specs/clients.yaml
+4 -2
View File
@@ -246,8 +246,9 @@ components:
example: "127.0.0.1,::1"
names:
type: string
description: Comma-separated list of hostnames
example: "localhost"
nullable: true
description: Comma-separated list of hostnames (if available)
example: "localhost,ip6-localhost"
client:
type: object
properties:
@@ -284,6 +285,7 @@ components:
description: hostname (only available when {client} is an IP address)
type: string
readOnly: true
nullable: true
example: localhost
groups:
type: object
src/api/docs/content/specs/endpoints.yaml
+103 -10
View File
@@ -37,25 +37,118 @@ components:
get:
type: array
items:
type: string
example: ["/api/dns/blocking", "/api/dns/cache", "/api/dns/port", "/api/domains", "/api/groups", "/api/lists"]
type: object
properties:
uri:
type: string
description: URI
parameters:
type: string
description: Parameters
example:
- uri: "/api/dns/blocking"
parameters: ''
- uri: "/api/dns/cache"
parameters: ''
- uri: "/api/dns/port"
parameters: ''
- uri: "/api/domains"
parameters: ''
- uri: "/api/groups"
parameters: ''
- uri: "/api/lists"
parameters: ''
post:
type: array
items:
type: string
example: ["/api/dns/blocking", "/api/dns/cache", "/api/dns/port", "/api/domains", "/api/groups", "/api/lists"]
type: object
properties:
uri:
type: string
description: URI
parameters:
type: string
description: Parameters
example:
- uri: "/api/dns/blocking"
parameters: ''
- uri: "/api/dns/cache"
parameters: ''
- uri: "/api/dns/port"
parameters: ''
- uri: "/api/domains"
parameters: ''
- uri: "/api/groups"
parameters: ''
- uri: "/api/lists"
parameters: ''
put:
type: array
items:
type: string
example: ["/api/dns/blocking", "/api/dns/cache", "/api/dns/port", "/api/domains", "/api/groups", "/api/lists"]
type: object
properties:
uri:
type: string
description: URI
parameters:
type: string
description: Parameters
example:
- uri: "/api/dns/blocking"
parameters: ''
- uri: "/api/dns/cache"
parameters: ''
- uri: "/api/dns/port"
parameters: ''
- uri: "/api/domains"
parameters: ''
- uri: "/api/groups"
parameters: ''
- uri: "/api/lists"
parameters: ''
patch:
type: array
items:
type: string
example: ["/api/dns/blocking", "/api/dns/cache", "/api/dns/port", "/api/domains", "/api/groups", "/api/lists"]
properties:
uri:
type: string
description: URI
parameters:
type: string
description: Parameters
example:
- uri: "/api/dns/blocking"
parameters: ''
- uri: "/api/dns/cache"
parameters: ''
- uri: "/api/dns/port"
parameters: ''
- uri: "/api/domains"
parameters: ''
- uri: "/api/groups"
parameters: ''
- uri: "/api/lists"
parameters: ''
delete:
type: array
items:
type: string
example: ["/api/dns/blocking", "/api/dns/cache", "/api/dns/port", "/api/domains", "/api/groups", "/api/lists"]
properties:
uri:
type: string
description: URI
parameters:
type: string
description: Parameters
example:
- uri: "/api/dns/blocking"
parameters: ''
- uri: "/api/dns/cache"
parameters: ''
- uri: "/api/dns/port"
parameters: ''
- uri: "/api/domains"
parameters: ''
- uri: "/api/groups"
parameters: ''
- uri: "/api/lists"
parameters: ''
src/api/docs/content/specs/info.yaml
+1 -1
View File
@@ -505,7 +505,7 @@ components:
type: number
nullable: true
description: Critical sensor value (if available, `null` otherwise)
path:
sensor:
type: string
description: Short path of temperature sensor
example:
src/api/docs/content/specs/network.yaml
+4
View File
@@ -126,6 +126,9 @@ components:
type: string
nullable: true
description: Interface name
default:
type: boolean
description: If the interface is the default gateway
carrier:
type: boolean
description: If the interface is connected
@@ -248,6 +251,7 @@ components:
name:
type: string
description: Associated hostname (can be null)
nullable: true
example: ubuntu-server
lastSeen:
type: integer