docs: added new ACP routes

This commit is contained in:
Julian Lam
2026-02-27 11:54:30 -05:00
parent 0b3dd38bc2
commit 82b7f429e3
7 changed files with 103 additions and 8 deletions

View File

@@ -98,8 +98,6 @@ paths:
$ref: 'read/admin/settings/tags.yaml'
/api/admin/settings/post:
$ref: 'read/admin/settings/post.yaml'
/api/admin/settings/activitypub:
$ref: 'read/admin/settings/activitypub.yaml'
/api/admin/settings/uploads:
$ref: 'read/admin/settings/uploads.yaml'
/api/admin/settings/email:
@@ -148,6 +146,18 @@ paths:
$ref: 'read/admin/manage/uploads.yaml'
/api/admin/manage/digest:
$ref: 'read/admin/manage/digest.yaml'
/api/admin/federation/general:
$ref: 'read/admin/federation/general.yaml'
/api/admin/federation/content:
$ref: 'read/admin/federation/content.yaml'
/api/admin/federation/rules:
$ref: 'read/admin/federation/rules.yaml'
/api/admin/federation/relays:
$ref: 'read/admin/federation/relays.yaml'
/api/admin/federation/pruning:
$ref: 'read/admin/federation/pruning.yaml'
/api/admin/federation/safety:
$ref: 'read/admin/federation/safety.yaml'
"/api/admin/appearance/themes":
$ref: 'read/admin/appearance/themes.yaml'
"/api/admin/appearance/skins":

View File

@@ -0,0 +1,16 @@
get:
tags:
- admin
summary: Get federation settings pertaining to content
responses:
"200":
description: ""
content:
application/json:
schema:
allOf:
- type: object
properties:
title:
type: string
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps

View File

@@ -0,0 +1,16 @@
get:
tags:
- admin
summary: Get general federation settings
responses:
"200":
description: ""
content:
application/json:
schema:
allOf:
- type: object
properties:
title:
type: string
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps

View File

@@ -0,0 +1,16 @@
get:
tags:
- admin
summary: Get federation content pruning settings
responses:
"200":
description: ""
content:
application/json:
schema:
allOf:
- type: object
properties:
title:
type: string
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps

View File

@@ -1,7 +1,7 @@
get:
tags:
- admin
summary: Get federation (ActivityPub) settings
summary: Get federation settings pertaining to relays
responses:
"200":
description: ""
@@ -13,11 +13,9 @@ get:
properties:
title:
type: string
instanceCount:
type: number
description: The number of ActivityPub-enabled instances that this forum knows about.
rules:
$ref: ../../../components/schemas/admin/rules.yaml#/RulesArray
relays:
$ref: ../../../components/schemas/admin/relays.yaml#/RelaysArray
hideSave:
type: boolean
description: A flag to instruct the template engine to hide the save button
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps

View File

@@ -0,0 +1,21 @@
get:
tags:
- admin
summary: Get federation settings pertaining to auto-categorization rules
responses:
"200":
description: ""
content:
application/json:
schema:
allOf:
- type: object
properties:
title:
type: string
rules:
$ref: ../../../components/schemas/admin/rules.yaml#/RulesArray
hideSave:
type: boolean
description: A flag to instruct the template engine to hide the save button
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps

View File

@@ -0,0 +1,18 @@
get:
tags:
- admin
summary: Get federation settings pertaining to trust and safety
responses:
"200":
description: ""
content:
application/json:
schema:
allOf:
- type: object
properties:
title:
type: string
instanceCount:
type: number
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps