Skip to content

Node.js based forum software built for the modern web

docs: added new ACP routes

Julian Lam82b7f429e37f
diff --git a/public/openapi/read.yaml b/public/openapi/read.yaml
index d37280d72c..eec723b5c9 100644
--- a/public/openapi/read.yaml
+++ b/public/openapi/read.yaml
@@ -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":
diff --git a/public/openapi/read/admin/federation/content.yaml b/public/openapi/read/admin/federation/content.yaml
new file mode 100644
index 0000000000..5cfb47ce16
--- /dev/null
+++ b/public/openapi/read/admin/federation/content.yaml
@@ -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
\ No newline at end of file
diff --git a/public/openapi/read/admin/federation/general.yaml b/public/openapi/read/admin/federation/general.yaml
new file mode 100644
index 0000000000..8c9a560cb5
--- /dev/null
+++ b/public/openapi/read/admin/federation/general.yaml
@@ -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
\ No newline at end of file
diff --git a/public/openapi/read/admin/federation/pruning.yaml b/public/openapi/read/admin/federation/pruning.yaml
new file mode 100644
index 0000000000..2f4329bc82
--- /dev/null
+++ b/public/openapi/read/admin/federation/pruning.yaml
@@ -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
\ No newline at end of file
diff --git a/public/openapi/read/admin/settings/activitypub.yaml b/public/openapi/read/admin/federation/relays.yaml
similarity index 56%
rename from public/openapi/read/admin/settings/activitypub.yaml
rename to public/openapi/read/admin/federation/relays.yaml
index 48a0415fef..8dc22387d3 100644
--- a/public/openapi/read/admin/settings/activitypub.yaml
+++ b/public/openapi/read/admin/federation/relays.yaml
@@ -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
\ No newline at end of file
diff --git a/public/openapi/read/admin/federation/rules.yaml b/public/openapi/read/admin/federation/rules.yaml
new file mode 100644
index 0000000000..5ca2d6e73f
--- /dev/null
+++ b/public/openapi/read/admin/federation/rules.yaml
@@ -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
\ No newline at end of file
diff --git a/public/openapi/read/admin/federation/safety.yaml b/public/openapi/read/admin/federation/safety.yaml
new file mode 100644
index 0000000000..73015d3f8c
--- /dev/null
+++ b/public/openapi/read/admin/federation/safety.yaml
@@ -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
\ No newline at end of file