Skip to content

Commit e766365

Browse files
committed
Issues-474: synced the categories schema with the categories controller
1 parent dddbf16 commit e766365

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

vanilla/applications/vanilla/openapi/categories.yml

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -790,6 +790,105 @@ paths:
790790
- followed
791791
type: object
792792
required: true
793+
'/categories/urlcode/{urlcode}':
794+
get:
795+
parameters:
796+
- description: |
797+
The category urlcode.
798+
in: path
799+
name: urlcode
800+
required: true
801+
schema:
802+
type: string
803+
responses:
804+
'200':
805+
content:
806+
'application/json':
807+
schema:
808+
properties:
809+
categoryID:
810+
description: The ID of the category.
811+
type: integer
812+
countAllComments:
813+
description: Total of all comments in a category and its children.
814+
type: integer
815+
countAllDiscussions:
816+
description: Total of all discussions in a category and its children.
817+
type: integer
818+
countCategories:
819+
description: Total number of child categories.
820+
type: integer
821+
countComments:
822+
description: Total comments in the category.
823+
type: integer
824+
countDiscussions:
825+
description: Total discussions in the category.
826+
type: integer
827+
customPermissions:
828+
description: Are custom permissions set for this category?
829+
type: boolean
830+
description:
831+
description: The description of the category.
832+
minLength: 0
833+
nullable: true
834+
type: string
835+
displayAs:
836+
type: string
837+
default: discussions
838+
description: The display style of the category.
839+
enum:
840+
- categories
841+
- discussions
842+
- flat
843+
- heading
844+
minLength: 1
845+
followed:
846+
description: Is the category being followed by the current user?
847+
type: boolean
848+
archived:
849+
description: The archived state of this category.
850+
type: boolean
851+
name:
852+
description: The name of the category.
853+
minLength: 1
854+
type: string
855+
parentCategoryID:
856+
description: Parent category ID.
857+
nullable: true
858+
type: integer
859+
url:
860+
description: The URL to the category.
861+
minLength: 1
862+
type: string
863+
urlcode:
864+
description: The URL code of the category.
865+
minLength: 1
866+
type: string
867+
groupID:
868+
description: Group ID.
869+
nullable: true
870+
type: integer
871+
required:
872+
- categoryID
873+
- name
874+
- description
875+
- parentCategoryID
876+
- customPermissions
877+
- archived
878+
- urlcode
879+
- url
880+
- displayAs
881+
- countCategories
882+
- countDiscussions
883+
- countComments
884+
- countAllDiscussions
885+
- countAllComments
886+
- groupID
887+
type: object
888+
description: Success
889+
tags:
890+
- Categories
891+
summary: Get a category.
793892
components:
794893
requestBodies:
795894
CategoryPost:

0 commit comments

Comments
 (0)