Skip to content

Node.js based forum software built for the modern web

docs: OpenAPI schema for rules re-ordering route

Julian Lam072dd1aeb3b3
diff --git a/public/openapi/write.yaml b/public/openapi/write.yaml
index dfef0aa0cf..0741c799ed 100644
--- a/public/openapi/write.yaml
+++ b/public/openapi/write.yaml
@@ -280,6 +280,8 @@ paths:
$ref: 'write/admin/activitypub/rules.yaml'
/admin/activitypub/rules/{rid}:
$ref: 'write/admin/activitypub/rules/rid.yaml'
+ /admin/activitypub/rules/order:
+ $ref: 'write/admin/activitypub/rules/order.yaml'
/admin/activitypub/relays:
$ref: 'write/admin/activitypub/relays.yaml'
/admin/activitypub/relays/{url}:
diff --git a/public/openapi/write/admin/activitypub/rules/order.yaml b/public/openapi/write/admin/activitypub/rules/order.yaml
new file mode 100644
index 0000000000..3cf931875d
--- /dev/null
+++ b/public/openapi/write/admin/activitypub/rules/order.yaml
@@ -0,0 +1,29 @@
+put:
+ tags:
+ - admin
+ summary: re-order auto-categorization rules
+ description: This operation updates the order of some or all auto-categorization rules.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ rids:
+ type: array
+ description: A list of rule IDs in the preferred order. Any omitted IDs will remain in the last-known order, which may conflict with the new ordering.
+ items:
+ type: string
+ responses:
+ '200':
+ description: rules successfully re-ordered
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ status:
+ $ref: ../../../components/schemas/Status.yaml#/Status
+ response:
+ $ref: ../../../components/schemas/admin/rules.yaml#/RulesArray