mirror of
https://github.com/NodeBB/NodeBB.git
synced 2025-10-27 09:06:15 +01:00
fix(openapi): added CategoryObject component
This commit is contained in:
Julian Lam
65
public/openapi/components/schemas/CategoryObject.yaml
Normal file
65
public/openapi/components/schemas/CategoryObject.yaml
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
CategoryObject:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
cid:
|
||||||
|
type: number
|
||||||
|
description: A category identifier assigned upon category creation (this value cannot be changed)
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: The category's name/title
|
||||||
|
description:
|
||||||
|
type: string
|
||||||
|
description: A variable-length description of the category (usually displayed underneath the category name)
|
||||||
|
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)
|
||||||
|
icon:
|
||||||
|
type: string
|
||||||
|
description: A FontAwesome icon string
|
||||||
|
example: fa-comments-o
|
||||||
|
bgColor:
|
||||||
|
type: string
|
||||||
|
description: Theme-related, a six-character hexadecimal string representing the background colour of the category
|
||||||
|
color:
|
||||||
|
type: string
|
||||||
|
description: Theme-related, a six-character hexadecimal string representing the foreground/text colour of the category
|
||||||
|
slug:
|
||||||
|
type: string
|
||||||
|
description: An URL-safe variant of the category title. This value is automatically generated.
|
||||||
|
readOnly: true
|
||||||
|
parentCid:
|
||||||
|
type: number
|
||||||
|
description: The category identifier for the category that is the immediate ancestor of the current category
|
||||||
|
topic_count:
|
||||||
|
type: number
|
||||||
|
description: The number of topics in the category
|
||||||
|
post_count:
|
||||||
|
type: number
|
||||||
|
description: The number of posts in the category
|
||||||
|
disabled:
|
||||||
|
type: number
|
||||||
|
description: Whether or not this category is disabled.
|
||||||
|
order:
|
||||||
|
type: number
|
||||||
|
description: A number representing the category's place in the hierarchy
|
||||||
|
link:
|
||||||
|
type: string
|
||||||
|
description: If set, attempting to access the forum will go to this external link instead (theme-specific)
|
||||||
|
numRecentReplies:
|
||||||
|
type: number
|
||||||
|
description: The number of posts to render in the API response (this is mostly used at the theme level)
|
||||||
|
class:
|
||||||
|
type: string
|
||||||
|
description: Values that are appended to the `class` attribute of the category's parent/root element
|
||||||
|
imageClass:
|
||||||
|
type: string
|
||||||
|
enum: [auto, cover, contain]
|
||||||
|
description: The `background-position` of the category background image, if one is set
|
||||||
|
isSection:
|
||||||
|
type: number
|
||||||
|
totalPostCount:
|
||||||
|
type: number
|
||||||
|
description: The number of posts in the category
|
||||||
|
totalTopicCount:
|
||||||
|
type: number
|
||||||
|
description: The number of topics in the category
|
||||||
@@ -61,108 +61,17 @@ paths:
|
|||||||
categories:
|
categories:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: object
|
allOf:
|
||||||
|
- $ref: components/schemas/CategoryObject.yaml#/CategoryObject
|
||||||
|
- type: object
|
||||||
properties:
|
properties:
|
||||||
cid:
|
|
||||||
type: number
|
|
||||||
description: A category identifier
|
|
||||||
name:
|
|
||||||
type: string
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
icon:
|
|
||||||
type: string
|
|
||||||
slug:
|
|
||||||
type: string
|
|
||||||
topic_count:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
order:
|
|
||||||
type: number
|
|
||||||
bgColor:
|
|
||||||
type: string
|
|
||||||
link:
|
|
||||||
type: string
|
|
||||||
class:
|
|
||||||
type: string
|
|
||||||
numRecentReplies:
|
|
||||||
type: number
|
|
||||||
color:
|
|
||||||
type: string
|
|
||||||
post_count:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
descriptionParsed:
|
|
||||||
type: string
|
|
||||||
parentCid:
|
|
||||||
type: number
|
|
||||||
description: The category identifier for the category that is the immediate
|
|
||||||
ancestor of the current category
|
|
||||||
disabled:
|
|
||||||
type: number
|
|
||||||
isSection:
|
|
||||||
type: number
|
|
||||||
totalPostCount:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
totalTopicCount:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
tagWhitelist:
|
|
||||||
type: array
|
|
||||||
items: {}
|
|
||||||
unread-class:
|
|
||||||
type: string
|
|
||||||
children:
|
children:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: object
|
allOf:
|
||||||
|
- $ref: components/schemas/CategoryObject.yaml#/CategoryObject
|
||||||
|
- type: object
|
||||||
properties:
|
properties:
|
||||||
cid:
|
|
||||||
type: number
|
|
||||||
description: A category identifier
|
|
||||||
name:
|
|
||||||
type: string
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
icon:
|
|
||||||
type: string
|
|
||||||
slug:
|
|
||||||
type: string
|
|
||||||
topic_count:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
order:
|
|
||||||
type: number
|
|
||||||
bgColor:
|
|
||||||
type: string
|
|
||||||
link:
|
|
||||||
type: string
|
|
||||||
class:
|
|
||||||
type: string
|
|
||||||
numRecentReplies:
|
|
||||||
type: number
|
|
||||||
color:
|
|
||||||
type: string
|
|
||||||
post_count:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
parentCid:
|
|
||||||
type: number
|
|
||||||
description: The category identifier for the category that is the immediate
|
|
||||||
ancestor of the current category
|
|
||||||
disabled:
|
|
||||||
type: number
|
|
||||||
isSection:
|
|
||||||
type: number
|
|
||||||
totalPostCount:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
totalTopicCount:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
descriptionParsed:
|
|
||||||
type: string
|
|
||||||
tagWhitelist:
|
tagWhitelist:
|
||||||
type: array
|
type: array
|
||||||
items: {}
|
items: {}
|
||||||
@@ -172,60 +81,7 @@ paths:
|
|||||||
type: array
|
type: array
|
||||||
items: {}
|
items: {}
|
||||||
parent:
|
parent:
|
||||||
type: object
|
$ref: components/schemas/CategoryObject.yaml#/CategoryObject
|
||||||
properties:
|
|
||||||
link:
|
|
||||||
type: string
|
|
||||||
class:
|
|
||||||
type: string
|
|
||||||
icon:
|
|
||||||
type: string
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
order:
|
|
||||||
type: number
|
|
||||||
topic_count:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
name:
|
|
||||||
type: string
|
|
||||||
cid:
|
|
||||||
type: number
|
|
||||||
description: A category identifier
|
|
||||||
post_count:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
numRecentReplies:
|
|
||||||
type: number
|
|
||||||
bgColor:
|
|
||||||
type: string
|
|
||||||
slug:
|
|
||||||
type: string
|
|
||||||
color:
|
|
||||||
type: string
|
|
||||||
disabled:
|
|
||||||
type: number
|
|
||||||
descriptionParsed:
|
|
||||||
type: string
|
|
||||||
isSection:
|
|
||||||
type: number
|
|
||||||
parentCid:
|
|
||||||
type: number
|
|
||||||
description: The category identifier for the category that is the immediate
|
|
||||||
ancestor of the current category
|
|
||||||
totalPostCount:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
totalTopicCount:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
tagWhitelist:
|
|
||||||
type: array
|
|
||||||
items: {}
|
|
||||||
unread-class:
|
|
||||||
type: string
|
|
||||||
imageClass:
|
|
||||||
type: string
|
|
||||||
posts:
|
posts:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
@@ -363,8 +219,6 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
imageClass:
|
|
||||||
type: string
|
|
||||||
topics:
|
topics:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
@@ -3832,6 +3686,7 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
|
- $ref: components/schemas/CategoryObject.yaml#/CategoryObject
|
||||||
- type: object
|
- type: object
|
||||||
properties:
|
properties:
|
||||||
tid:
|
tid:
|
||||||
@@ -4041,54 +3896,6 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
display_post_menu:
|
display_post_menu:
|
||||||
type: boolean
|
type: boolean
|
||||||
category:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
link:
|
|
||||||
type: string
|
|
||||||
class:
|
|
||||||
type: string
|
|
||||||
icon:
|
|
||||||
type: string
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
order:
|
|
||||||
type: number
|
|
||||||
topic_count:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
name:
|
|
||||||
type: string
|
|
||||||
cid:
|
|
||||||
type: number
|
|
||||||
description: A category identifier
|
|
||||||
post_count:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
numRecentReplies:
|
|
||||||
type: number
|
|
||||||
bgColor:
|
|
||||||
type: string
|
|
||||||
slug:
|
|
||||||
type: string
|
|
||||||
color:
|
|
||||||
type: string
|
|
||||||
disabled:
|
|
||||||
type: number
|
|
||||||
descriptionParsed:
|
|
||||||
type: string
|
|
||||||
isSection:
|
|
||||||
type: number
|
|
||||||
parentCid:
|
|
||||||
type: number
|
|
||||||
description: The category identifier for the category that is the immediate
|
|
||||||
ancestor of the current category
|
|
||||||
totalPostCount:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
totalTopicCount:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
tagWhitelist:
|
tagWhitelist:
|
||||||
type: array
|
type: array
|
||||||
items: {}
|
items: {}
|
||||||
@@ -4226,6 +4033,7 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
allOf:
|
allOf:
|
||||||
|
- $ref: components/schemas/CategoryObject.yaml#/CategoryObject
|
||||||
- type: object
|
- type: object
|
||||||
properties:
|
properties:
|
||||||
tid:
|
tid:
|
||||||
@@ -4491,54 +4299,6 @@ paths:
|
|||||||
username:
|
username:
|
||||||
type: string
|
type: string
|
||||||
description: A friendly name for a given user account
|
description: A friendly name for a given user account
|
||||||
category:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
link:
|
|
||||||
type: string
|
|
||||||
class:
|
|
||||||
type: string
|
|
||||||
icon:
|
|
||||||
type: string
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
order:
|
|
||||||
type: number
|
|
||||||
topic_count:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
name:
|
|
||||||
type: string
|
|
||||||
cid:
|
|
||||||
type: number
|
|
||||||
description: A category identifier
|
|
||||||
post_count:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
numRecentReplies:
|
|
||||||
type: number
|
|
||||||
bgColor:
|
|
||||||
type: string
|
|
||||||
slug:
|
|
||||||
type: string
|
|
||||||
color:
|
|
||||||
type: string
|
|
||||||
disabled:
|
|
||||||
type: number
|
|
||||||
descriptionParsed:
|
|
||||||
type: string
|
|
||||||
isSection:
|
|
||||||
type: number
|
|
||||||
parentCid:
|
|
||||||
type: number
|
|
||||||
description: The category identifier for the category that is the immediate
|
|
||||||
ancestor of the current category
|
|
||||||
totalPostCount:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
totalTopicCount:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
tagWhitelist:
|
tagWhitelist:
|
||||||
type: array
|
type: array
|
||||||
items: {}
|
items: {}
|
||||||
@@ -4988,7 +4748,8 @@ paths:
|
|||||||
posts:
|
posts:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: object
|
allOf:
|
||||||
|
- type: object
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: string
|
type: string
|
||||||
@@ -5118,56 +4879,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
titleRaw:
|
titleRaw:
|
||||||
type: string
|
type: string
|
||||||
category:
|
- $ref: components/schemas/CategoryObject.yaml#/CategoryObject
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
cid:
|
|
||||||
type: number
|
|
||||||
description: A category identifier
|
|
||||||
name:
|
|
||||||
type: string
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
icon:
|
|
||||||
type: string
|
|
||||||
bgColor:
|
|
||||||
type: string
|
|
||||||
color:
|
|
||||||
type: string
|
|
||||||
slug:
|
|
||||||
type: string
|
|
||||||
parentCid:
|
|
||||||
type: number
|
|
||||||
description: The category identifier for the category that is the immediate
|
|
||||||
ancestor of the current category
|
|
||||||
topic_count:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
post_count:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
disabled:
|
|
||||||
type: number
|
|
||||||
order:
|
|
||||||
type: number
|
|
||||||
link:
|
|
||||||
type: string
|
|
||||||
numRecentReplies:
|
|
||||||
type: number
|
|
||||||
class:
|
|
||||||
type: string
|
|
||||||
imageClass:
|
|
||||||
type: string
|
|
||||||
descriptionParsed:
|
|
||||||
type: string
|
|
||||||
isSection:
|
|
||||||
type: number
|
|
||||||
totalPostCount:
|
|
||||||
type: number
|
|
||||||
description: The number of posts in the category
|
|
||||||
totalTopicCount:
|
|
||||||
type: number
|
|
||||||
description: The number of topics in the category
|
|
||||||
- $ref: components/schemas/Pagination.yaml#/Pagination
|
- $ref: components/schemas/Pagination.yaml#/Pagination
|
||||||
- $ref: components/schemas/CommonProps.yaml#/CommonProps
|
- $ref: components/schemas/CommonProps.yaml#/CommonProps
|
||||||
/api/ip-blacklist:
|
/api/ip-blacklist:
|
||||||
|
|||||||
Reference in New Issue
Block a user