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

Add /api/stats/summary documentation

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2021-01-30 14:00:54 +01:00
parent 0758dc9cc7
commit ae5d6e2c19
6 changed files with 255 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/api/docs/content/index.html
+3 -2
View File
@@ -22,11 +22,12 @@
theme = "dark"
allow-try = "true"
sort-endpoints-by = "path"
default-schema-tab = 'example'
default-schema-tab = "model"
schema-style = "tree"
render-style = "view"
primary-color = "#2d87e2"
header-color = "#2d87e2">
header-color = "#2d87e2"
schema-expand-level= "2">
<img slot="logo" style="padding-left: 10px;" src="images/logo.svg" width="20px" />
<div slot="header" style="font-weight:700; font-size:32px">Pi-hole API Documentation</div>
src/api/docs/content/specs/ftl.yaml
+40 -22
View File
@@ -277,33 +277,51 @@ components:
ftl:
type: object
properties:
gravity:
type: integer
description: Number of collected exact domains on lists
example: 67906
groups:
type: integer
description: Number of groups
example: 6
lists:
type: integer
description: Number of lists
example: 1
clients:
type: integer
description: Number of configured clients
example: 5
domains:
database:
type: object
properties:
allowed:
gravity:
type: integer
description: Number of allowed domains
description: Number of collected exact domains on lists
example: 67906
groups:
type: integer
description: Number of groups
example: 6
lists:
type: integer
description: Number of lists
example: 1
clients:
type: integer
description: Number of configured clients
example: 5
domains:
type: object
properties:
allowed:
type: integer
description: Number of allowed domains
example: 10
denied:
type: integer
description: Number of denied domains
example: 3
privacy_level:
type: integer
description: Currently used privacy level
example: 0
clients:
type: object
properties:
total:
type: integer
description: Number of clients FTL has seen in its lfetime
example: 10
denied:
active:
type: integer
description: Number of denied domains
example: 3
description: Number of clients actively using FTL
example: 8
database:
type: object
properties:
src/api/docs/content/specs/main.yaml
+15 -12
View File
@@ -20,24 +20,15 @@ paths:
/auth:
$ref: 'auth.yaml#/components/paths/auth'
/stats/summary:
$ref: 'stats.yaml#/components/paths/summary'
/dns/blocking:
$ref: 'dns.yaml#/components/paths/blocking'
/dns/cache:
$ref: 'dns.yaml#/components/paths/cache'
/ftl/client:
$ref: 'ftl.yaml#/components/paths/client'
/ftl/logs/dns:
$ref: 'ftl.yaml#/components/paths/logs/dns'
/ftl/sysinfo:
$ref: 'ftl.yaml#/components/paths/sysinfo'
/ftl/dbinfo:
$ref: 'ftl.yaml#/components/paths/dbinfo'
/database/info:
$ref: 'database.yaml#/components/paths/info'
@@ -65,5 +56,17 @@ paths:
/lists:
$ref: 'lists.yaml#/components/paths/direct'
/ftl/client:
$ref: 'ftl.yaml#/components/paths/client'
/ftl/logs/dns:
$ref: 'ftl.yaml#/components/paths/logs/dns'
/ftl/sysinfo:
$ref: 'ftl.yaml#/components/paths/sysinfo'
/ftl/dbinfo:
$ref: 'ftl.yaml#/components/paths/dbinfo'
/version:
$ref: 'version.yaml#/components/paths/version'
src/api/docs/content/specs/stats.yaml
+142
View File
@@ -0,0 +1,142 @@
openapi: 3.0.2
components:
paths:
summary:
get:
summary: Get overview of Pi-hole activity
description: |
Request various query, system ,and FTL properties
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/queries'
- $ref: 'ftl.yaml#/components/schemas/system'
- $ref: 'ftl.yaml#/components/schemas/ftl'
schemas:
queries:
type: object
properties:
queries:
type: object
properties:
blocked:
type: integer
description: Number of blocked queries
example: 3465
percent_blocked:
type: float
description: Percent of blocked queries
example: 34.5
unique_domains:
type: integer
description: Number of unique domains FTL knows
example: 445
forwarded:
type: integer
description: Number of queries that have been forwarded upstream
example: 4574
cached:
type: integer
description: Number of queries replied to from cache or local configuration
example: 9765
types:
type: object
description: Number of individual queries
properties:
A:
type: integer
description: Type A queries
example: 3643
AAAA:
type: integer
description: Type AAAA queries
example: 123
ANY:
type: integer
description: Type ANY queries
example: 3423
SRV:
type: integer
description: Type SRV queries
example: 345
SOA:
type: integer
description: Type SOA queries
example: 7567
PTR:
type: integer
description: Type PTR queries
example: 456
TXT:
type: integer
description: Type TXT queries
example: 85
NAPTR:
type: integer
description: Type NAPTR queries
example: 346
MX:
type: integer
description: Type MX queries
example: 457
DS:
type: integer
description: Type DS queries
example: 456
RRSIG:
type: integer
description: Type RRSIG queries
example: 345
DNSKEY:
type: integer
description: Type DNSKEY queries
example: 55
NS:
type: integer
description: Type NS queries
example: 868
SVCB:
type: integer
description: Type SVCB queries
example: 645
HTTPS:
type: integer
description: Type HTTPS queries
example: 4
OTHER:
type: integer
description: Queries of remaining types
example: 845
sum:
type: integer
description: Total number of queries
example: 7497
replies:
type: object
description: Number of individual replies
properties:
NODATA:
type: integer
description: NODATA responses
example: 14
NXDOMAIN:
type: integer
description: NXDOMAIN responses
example: 45
CNAME:
type: integer
description: CNAME responses
example: 76
IP:
type: integer
description: IP responses
example: 85
text:
type: integer
description: text responses
example: 16