Files
NodeBB/public/openapi/components/schemas/GroupObject.yaml
Barış Soner Uşaklı 47299ea587 Categories refactor (#9257)
* feat: wip categories pagination

* feat: add subCategoriesPerPage setting

* feat: add load more sub categories button to category page

* fix: openapi spec

* feat: show sub categories left on category page

hide button when no more categories left

* breaking: rename categories to allCategories on /search

categories contains the search results

* fix: spec

* refactor: remove cidsPerPage

* fix: tests

* feat: use component for subcategories

* fix: prevent negative subCategoriesLeft

* feat: new category filter/search WIP

* feat: remove categories from /tag

* fix: dont load all categories when showing move modal

* feat: allow adding custom categories to list

* breaking: dont load entire category tree on post queue

removed unused code
add hooks to filter/selector
add options to filter/selector

* feat: make selector modal work again

* feat: replace old search module

* fix: topic move selector

* feat: dont load all categories on create category modal

* fix: fix more categorySelectors

* feat: dont load entire category tree on group details page

* feat: dont load all categories on home page and user settings page

* feat: add pagination to /user/:userslug/categories

* fix: update schemas

* fix: more tests

* fix: test

* feat: flags page, dont return entire category tree

* fix: flag test

* feat: categories manage page

dont load all categories
allow changing root category
clear caches properly

* fix: spec

* feat: admins&mods page

dont load all categories

* fix: spec

* fix: dont load all children when opening dropdown

* fix: on search results dont return all children

* refactor: pass all options, rename options.cids to options.selectedCids

* fix: #9266

* fix: index 0

* fix: spec

* feat: #9265, add setObjectBulk

* refactor: shoter updateOrder

* feat: selectors on categories/category

* fix: tests and search filter

* fix: category update test

* feat: pagination on acp categories page

show order in set order modal

* fix: allow drag&drop on pages > 1 in /admin/manage/categories

* fix: teasers for deep nested categories

fix sub category display on /category page

* fix: spec

* refactor: use eslint-disable-next-line

* refactor: shorter
2021-02-07 15:09:52 -05:00

153 lines
3.8 KiB
YAML

GroupFullObject:
type: object
description: The response from an internal call to `Groups.get(<groupname>)`
properties:
name:
type: string
description: The group name
slug:
type: string
description: URL-safe slug of the group name
createtime:
type: number
description: UNIX timestamp of the group's creation
userTitle:
type: number
description: Label text for the user badge
userTitleEscaped:
type: number
description: Same as userTitle but with translation tokens escaped, used to display raw userTitle in group management
userTitleEnabled:
type: number
description:
type: string
description: The group description
memberCount:
type: number
hidden:
type: number
system:
type: number
private:
type: number
disableJoinRequests:
type: number
disableLeave:
type: number
nameEncoded:
type: string
displayName:
type: string
description: A custom override of the group's name, a friendly name
labelColor:
type: string
description: A six-character hexadecimal colour code
textColor:
type: string
description: A six-character hexadecimal colour code
memberPostCids:
type: string
memberPostCidsArray:
type: array
items:
type: number
example: [1, 2, 3]
icon:
type: string
description: A FontAwesome icon string
createtimeISO:
type: string
description: "`createtime` rendered as an ISO 8601 format"
cover:thumb:url:
type: string
cover:url:
type: string
cover:position:
type: string
descriptionParsed:
type: string
members:
type: array
items:
$ref: UserObject.yaml#/UserObjectSlim
membersNextStart:
type: number
pending:
type: array
invited:
type: array
isMember:
type: boolean
isPending:
type: boolean
isInvited:
type: boolean
isOwner:
type: boolean
nullable: true
GroupDataObject:
type: object
description: The response from an internal call to `Groups.getGroupsFields(<groupname>, [])` with **explicitly** no fields passed in
properties:
name:
type: string
description: The group name
slug:
type: string
description: URL-safe slug of the group name
createtime:
type: number
description: UNIX timestamp of the group's creation
userTitle:
type: number
description: Label text for the user badge
userTitleEscaped:
type: number
description: Same as userTitle but with translation tokens escaped, used to display raw userTitle in group management
userTitleEnabled:
type: number
description:
type: string
description: The group description
memberCount:
type: number
hidden:
type: number
system:
type: number
private:
type: number
disableJoinRequests:
type: number
disableLeave:
type: number
cover:url:
type: string
cover:thumb:url:
type: string
nameEncoded:
type: string
displayName:
type: string
description: A custom override of the group's name, a friendly name
labelColor:
type: string
description: A six-character hexadecimal colour code
textColor:
type: string
description: A six-character hexadecimal colour code
icon:
type: string
description: A FontAwesome icon string
createtimeISO:
type: string
description: "`createtime` rendered as an ISO 8601 format"
cover:position:
type: string
memberPostCids:
type: string
memberPostCidsArray:
type: array
items:
type: number
example: [1, 2, 3]