mirror of
https://github.com/NodeBB/NodeBB.git
synced 2026-05-07 02:27:22 +02:00
feat(public/openapi): add OpenAPI v3 specifications for admin/federation/analytics and errors routes
Co-authored-by: aider (ollama/qwen2.5-coder:7b) <aider@aider.chat>
This commit is contained in:
45
public/openapi/read/admin/federation/analytics.yaml
Normal file
45
public/openapi/read/admin/federation/analytics.yaml
Normal file
@@ -0,0 +1,45 @@
|
||||
get:
|
||||
tags:
|
||||
- admin
|
||||
summary: Get federation analytics data
|
||||
parameters:
|
||||
- name: host
|
||||
in: query
|
||||
description: The hostname to filter analytics for
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
- name: term
|
||||
in: query
|
||||
description: The time period to retrieve analytics for (daily or hourly)
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: Analytics data
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
instances:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
received:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../../components/schemas/admin/stats.yaml#/StatsArray
|
||||
receivedErr:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../../components/schemas/admin/stats.yaml#/StatsArray
|
||||
sent:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../../components/schemas/admin/stats.yaml#/StatsArray
|
||||
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
||||
23
public/openapi/read/admin/federation/errors.yaml
Normal file
23
public/openapi/read/admin/federation/errors.yaml
Normal file
@@ -0,0 +1,23 @@
|
||||
get:
|
||||
tags:
|
||||
- admin
|
||||
summary: Get federation error data
|
||||
responses:
|
||||
"200":
|
||||
description: Error data
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
hideSave:
|
||||
type: boolean
|
||||
description: A flag to instruct the template engine to hide the save button
|
||||
errors:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../../components/schemas/admin/error.yaml#/ErrorObject
|
||||
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps
|
||||
Reference in New Issue
Block a user