Skip to content

Node.js based forum software built for the modern web

doc: 'nickname' and 'descriptionParsed' use in categories controller

Julian Lam051043b6820f
diff --git a/public/openapi/read/admin/manage/categories.yaml b/public/openapi/read/admin/manage/categories.yaml
index bbf8efb8fe..c4c48b7a06 100644
--- a/public/openapi/read/admin/manage/categories.yaml
+++ b/public/openapi/read/admin/manage/categories.yaml
@@ -25,8 +25,14 @@ get:
description: A category identifier
name:
type: string
+ nickname:
+ type: string
+ description: A custom name given to a remote category for de-duplication purposes (not available to local categories.)
description:
type: string
+ descriptionParsed:
+ type: string
+ description: A variable-length description of the category (usually displayed underneath the category name). Unlike `description`, this value here will have been run through any parsers installed on the forum (e.g. Markdown)
disabled:
type: number
icon: