Files
NodeBB/public/openapi/read/admin/manage/categories.yaml

71 lines
2.9 KiB
YAML

get:
tags:
- admin
summary: Get category management settings
responses:
"200":
description: ""
content:
application/json:
schema:
allOf:
- type : object
properties:
categoriesPerPage:
type: number
selectCategoryLabel:
type: string
categoriesTree:
type: array
items:
type: object
properties:
cid:
type: number
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:
type: string
link:
type: string
parentCid:
type: number
description: The category identifier for the category that is the immediate
ancestor of the current category
color:
type: string
bgColor:
type: string
backgroundImage:
type: string
nullable: true
imageClass:
type: string
order:
type: number
isLocal:
type: boolean
subCategoriesPerPage:
type: number
children:
type: array
description: Array of children categories
subCategoriesLeft:
type: number
hasMoreSubCategories:
type: boolean
showMorePage:
type: number
- $ref: ../../../components/schemas/Pagination.yaml#/Pagination
- $ref: ../../../components/schemas/CommonProps.yaml#/CommonProps