diff --git a/public/openapi/read.yaml b/public/openapi/read.yaml index 8c37ab554f..eb798b08d7 100644 --- a/public/openapi/read.yaml +++ b/public/openapi/read.yaml @@ -8,6 +8,10 @@ info: # Introduction The following document outlines every Read API route available via NodeBB. Unlike the write API, the v1.x API was coded organically, and is **not** strictly RESTful. These shortcomings will be addressed in the v2.x version of the API. + + ## Authentication + + Authentication with this API is done via cookies. A valid login session is required for API calls that pertain to operations involving a logged-in user. For example, `/api/unread` is a route showing unread topics, and is not accessible by guest users. tags: - name: home description: Routes used at the forum index only @@ -38,6 +42,8 @@ paths: get: tags: - home + description: | + This route is used to populate the homepage of NodeBB. It is the main access point of the forum, and shows a list of categories for navigation purposes. summary: /api/ responses: "200": @@ -56,6 +62,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string description: @@ -66,6 +73,7 @@ paths: type: string topic_count: type: number + description: The number of topics in the category order: type: number bgColor: @@ -80,18 +88,22 @@ paths: 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: {} @@ -104,6 +116,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string description: @@ -114,6 +127,7 @@ paths: type: string topic_count: type: number + description: The number of topics in the category order: type: number bgColor: @@ -128,16 +142,20 @@ paths: 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: @@ -163,12 +181,15 @@ paths: 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: @@ -185,10 +206,13 @@ paths: 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: {} @@ -209,28 +233,37 @@ paths: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number cid: type: number + description: A category identifier parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category topic: type: object properties: @@ -238,47 +271,10 @@ paths: type: string title: type: string - required: - - pid - - timestamp - - content - - timestampISO - - user - - index - - cid - - parentCid - - topic imageClass: type: string timesClicked: type: number - required: - - cid - - name - - description - - icon - - bgColor - - color - - slug - - topic_count - - disabled - - order - - link - - numRecentReplies - - class - - post_count - - parentCid - - isSection - - totalPostCount - - totalTopicCount - - descriptionParsed - - tagWhitelist - - unread-class - - children - - parent - - posts - - imageClass - - timesClicked posts: type: array items: @@ -292,28 +288,37 @@ paths: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number cid: type: number + description: A category identifier parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category topic: type: object properties: @@ -321,16 +326,6 @@ paths: type: string title: type: string - required: - - pid - - timestamp - - content - - timestampISO - - user - - index - - cid - - parentCid - - topic teaser: type: object properties: @@ -338,6 +333,7 @@ paths: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) pid: type: number topic: @@ -349,32 +345,6 @@ paths: type: string imageClass: type: string - required: - - cid - - name - - description - - icon - - slug - - topic_count - - disabled - - order - - bgColor - - link - - class - - numRecentReplies - - color - - post_count - - parentCid - - descriptionParsed - - isSection - - totalPostCount - - totalTopicCount - - tagWhitelist - - unread-class - - children - - posts - - teaser - - imageClass loggedIn: type: boolean relative_path: @@ -397,12 +367,16 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -421,6 +395,7 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category upvotes: type: number downvotes: @@ -429,6 +404,7 @@ paths: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -438,6 +414,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -460,10 +437,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -480,8 +460,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string oldUid: @@ -500,30 +483,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -541,12 +533,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score isOwner: type: boolean ignored: @@ -566,52 +552,6 @@ paths: type: string teaserPid: type: number - required: - - tid - - uid - - cid - - mainPid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - deleted - - locked - - pinned - - upvotes - - downvotes - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index - - teaserPid - - thumb - recentCards: - type: object - properties: - title: - type: string - opacity: - type: string - textShadow: - type: string - enableCarousel: - type: number - enableCarouselPagination: - type: number _header: type: object properties: @@ -631,11 +571,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -651,11 +586,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -666,8 +596,6 @@ paths: properties: html: type: string - required: - - html header: type: array items: @@ -701,8 +629,19 @@ paths: in: path required: true schema: - type: string - responses: {} + type: number + responses: + "200": + description: "" + content: + application/json: + schema: + type: object + properties: + pid: + type: number + content: + type: string /api/admin: get: tags: @@ -747,10 +686,6 @@ paths: type: string link: type: string - required: - - done - - doneText - - notDoneText stats: type: array items: @@ -784,21 +719,6 @@ paths: type: string name: type: string - required: - - yesterday - - today - - lastweek - - thisweek - - lastmonth - - thismonth - - alltime - - dayIncrease - - dayTextClass - - weekIncrease - - weekTextClass - - monthIncrease - - monthTextClass - - name canRestart: type: boolean lastrestart: @@ -806,6 +726,7 @@ paths: properties: uid: type: number + description: A user identifier ip: type: string timestamp: @@ -815,16 +736,22 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: number + description: Whether the user has confirmed their email address or not joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -885,8 +812,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -897,6 +827,7 @@ paths: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) loggedIn: type: boolean relative_path: @@ -931,11 +862,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -951,11 +877,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -1006,9 +927,6 @@ paths: type: string name: type: string - required: - - route - - name loggedIn: type: boolean relative_path: @@ -1043,11 +961,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -1063,11 +976,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -1131,11 +1039,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -1151,11 +1054,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -1190,6 +1088,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string description: @@ -1204,10 +1103,13 @@ paths: 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: @@ -1226,8 +1128,10 @@ paths: 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: @@ -1240,6 +1144,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string description: @@ -1254,10 +1159,13 @@ paths: 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: @@ -1276,8 +1184,10 @@ paths: type: number totalPostCount: type: number + description: The number of posts in the category totalTopicCount: type: number + description: The number of topics in the category allCategories: type: array items: @@ -1289,10 +1199,6 @@ paths: type: number selected: type: boolean - required: - - text - - value - - selected customClasses: type: array items: {} @@ -1330,11 +1236,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -1350,11 +1251,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -1439,11 +1335,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -1459,11 +1350,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -1506,8 +1392,6 @@ paths: properties: name: type: string - required: - - name groups: type: array items: @@ -1515,8 +1399,6 @@ paths: properties: name: type: string - required: - - name users: type: array items: {} @@ -1564,11 +1446,6 @@ paths: type: boolean isPrivate: type: boolean - required: - - name - - nameEscaped - - privileges - - isPrivate columnCountUser: type: number columnCountUserOther: @@ -1584,6 +1461,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -1594,27 +1472,19 @@ paths: 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 imageClass: type: string - required: - - cid - - name - - icon - - selected - - level - - parentCid - - color - - bgColor - - imageClass selectedCategory: type: object properties: cid: type: number + description: A category identifier name: type: string level: @@ -1623,6 +1493,7 @@ paths: 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: @@ -1631,6 +1502,7 @@ paths: type: boolean cid: type: number + description: A category identifier loggedIn: type: boolean relative_path: @@ -1665,11 +1537,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -1685,11 +1552,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -1738,16 +1600,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account postcount: type: number joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created banned: type: number reputation: @@ -1761,10 +1628,14 @@ paths: type: number email:confirmed: type: number + description: Whether the user has confirmed their email address or not icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -1773,25 +1644,6 @@ paths: type: string administrator: type: boolean - required: - - uid - - username - - userslug - - email - - postcount - - joindate - - banned - - reputation - - picture - - flags - - lastonline - - email:confirmed - - icon:text - - icon:bgColor - - joindateISO - - lastonlineISO - - banned_until_readable - - administrator page: type: number pageCount: @@ -1827,10 +1679,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -1911,11 +1759,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -1931,11 +1774,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -1998,11 +1836,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -2018,11 +1851,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -2053,16 +1881,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account postcount: type: number joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created banned: type: number reputation: @@ -2076,10 +1909,14 @@ paths: type: number email:confirmed: type: number + description: Whether the user has confirmed their email address or not icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -2088,25 +1925,6 @@ paths: type: string administrator: type: boolean - required: - - uid - - username - - userslug - - email - - postcount - - joindate - - banned - - reputation - - picture - - flags - - lastonline - - email:confirmed - - icon:text - - icon:bgColor - - joindateISO - - lastonlineISO - - banned_until_readable - - administrator page: type: number pageCount: @@ -2142,10 +1960,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -2226,11 +2040,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -2246,11 +2055,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -2281,16 +2085,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account postcount: type: number joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created banned: type: number reputation: @@ -2304,10 +2113,14 @@ paths: type: number email:confirmed: type: number + description: Whether the user has confirmed their email address or not icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -2316,25 +2129,6 @@ paths: type: string administrator: type: boolean - required: - - uid - - username - - userslug - - email - - postcount - - joindate - - banned - - reputation - - picture - - flags - - lastonline - - email:confirmed - - icon:text - - icon:bgColor - - joindateISO - - lastonlineISO - - banned_until_readable - - administrator page: type: number pageCount: @@ -2370,10 +2164,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -2454,11 +2244,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -2474,11 +2259,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -2603,30 +2383,6 @@ paths: type: string ownerUid: type: number - required: - - name - - description - - deleted - - hidden - - system - - userTitle - - icon - - labelColor - - createtime - - slug - - memberCount - - userTitleEnabled - - private - - disableJoinRequests - - disableLeave - - nameEncoded - - displayName - - textColor - - createtimeISO - - cover:thumb:url - - cover:url - - cover:position - - ownerUid pagination: type: object properties: @@ -2704,11 +2460,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -2724,11 +2475,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -2812,10 +2558,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: @@ -2826,6 +2575,7 @@ paths: type: number email:confirmed: type: number + description: Whether the user has confirmed their email address or not lastonline: type: number flags: @@ -2836,10 +2586,14 @@ paths: type: number joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -2879,10 +2633,6 @@ paths: type: string selected: type: boolean - required: - - encodedName - - displayName - - selected allowPrivateGroups: type: number maximumGroupNameLength: @@ -2923,11 +2673,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -2943,11 +2688,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -2986,27 +2726,24 @@ paths: properties: username: type: string + description: A friendly name for a given user account picture: nullable: true type: string uid: type: number + description: A user identifier icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastDelivery: type: string setting: type: boolean - required: - - username - - picture - - uid - - icon:text - - icon:bgColor - - lastDelivery - - setting default: type: string pagination: @@ -3034,10 +2771,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -3112,11 +2845,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -3132,11 +2860,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -3175,9 +2898,6 @@ paths: type: string label: type: string - required: - - name - - label loggedIn: type: boolean relative_path: @@ -3212,11 +2932,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -3232,11 +2947,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -3300,11 +3010,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -3320,11 +3025,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -3390,22 +3090,6 @@ paths: type: boolean settingsRoute: type: string - required: - - latest - - description - - name - - updated - - url - - numInstalls - - isCompatible - - id - - installed - - active - - isTheme - - error - - version - - license - - outdated installedCount: type: number activeCount: @@ -3439,17 +3123,6 @@ paths: type: boolean active: type: boolean - required: - - name - - updated - - description - - latest - - numInstalls - - isCompatible - - id - - installed - - active - - url incompatible: type: array items: @@ -3475,17 +3148,6 @@ paths: type: boolean active: type: boolean - required: - - name - - updated - - description - - latest - - url - - numInstalls - - isCompatible - - id - - installed - - active submitPluginUsage: type: number version: @@ -3524,11 +3186,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -3544,11 +3201,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -3588,12 +3240,6 @@ paths: type: string location: type: string - required: - - name - - location - required: - - template - - areas areas: type: array items: @@ -3641,14 +3287,6 @@ paths: type: string numTopics: type: string - required: - - widget - - data - required: - - name - - template - - location - - data availableWidgets: type: array items: @@ -3662,11 +3300,6 @@ paths: type: string content: type: string - required: - - widget - - name - - description - - content loggedIn: type: boolean relative_path: @@ -3701,11 +3334,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -3721,11 +3349,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -3982,14 +3605,6 @@ paths: type: number content_text_uid_1_cid_1: type: number - required: - - name - - count - - size - - avgObjSize - - storageSize - - totalIndexSize - - indexSizes network: type: object properties: @@ -4047,11 +3662,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -4067,11 +3677,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -4231,11 +3836,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -4251,11 +3851,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -4313,11 +3908,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -4333,11 +3923,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -4501,6 +4086,7 @@ paths: type: boolean uid: type: number + description: A user identifier cache-buster: type: string requireEmailConfirmation: @@ -4626,16 +4212,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -4695,8 +4286,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -4790,13 +4384,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -4812,11 +4399,6 @@ paths: type: string deauthUrl: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -4853,14 +4435,19 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email:confirmed: type: number + description: Whether the user has confirmed their email address or not joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -4918,8 +4505,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -4961,14 +4551,19 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email:confirmed: type: number + description: Whether the user has confirmed their email address or not joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -5026,8 +4621,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -5042,14 +4640,19 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email:confirmed: type: number + description: Whether the user has confirmed their email address or not joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -5107,8 +4710,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -5230,18 +4836,640 @@ paths: schema: type: string responses: {} + /api/categories: + get: + tags: + - categories + summary: Get a list of categories + description: | + This route retrieve the list of categories currently available to the accessing user. It doesn't necessarily mean that the user can *enter* the category, as that is a separate privilege. Specifically, this route will return all categories that grant the calling user the "Find Category" privilege. + + Subcategories are also returned, nested under a category's `children` property. + responses: + "200": + # TODO: Likely, this can be allOf'd with a category data schema... especially since a child category is the same thing *headexplosion* + description: A list of category objectscurrently available to the accessing user + content: + application/json: + schema: + type: object + properties: + title: + description: The category title + type: string + categories: + description: A collection of category data objects + type: array + items: + type: object + 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: + type: array + items: + type: object + 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: + type: array + items: {} + unread-class: + type: string + children: + type: array + items: {} + parent: + 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: + type: array + items: {} + unread-class: + type: string + imageClass: + type: string + posts: + type: array + items: + type: object + properties: + pid: + type: number + timestamp: + type: number + content: + type: string + timestampISO: + type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) + user: + type: object + properties: + uid: + type: number + description: A user identifier + username: + type: string + description: A friendly name for a given user account + userslug: + type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) + picture: + nullable: true + type: string + icon:text: + type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar + icon:bgColor: + type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" + index: + type: number + cid: + type: number + description: A category identifier + parentCid: + type: number + description: The category identifier for the category that is the immediate ancestor of the current category + topic: + type: object + properties: + slug: + type: string + title: + type: string + imageClass: + type: string + timesClicked: + type: number + posts: + type: array + items: + type: object + properties: + pid: + type: number + timestamp: + type: number + content: + type: string + timestampISO: + type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) + user: + type: object + properties: + uid: + type: number + description: A user identifier + username: + type: string + description: A friendly name for a given user account + userslug: + type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) + picture: + nullable: true + type: string + icon:text: + type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar + icon:bgColor: + type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" + index: + type: number + cid: + type: number + description: A category identifier + parentCid: + type: number + description: The category identifier for the category that is the immediate ancestor of the current category + topic: + type: object + properties: + slug: + type: string + title: + type: string + teaser: + type: object + properties: + url: + type: string + timestampISO: + type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) + pid: + type: number + topic: + type: object + properties: + slug: + type: string + title: + type: string + imageClass: + type: string + breadcrumbs: + type: array + items: + type: object + properties: + text: + type: string + url: + type: string + loggedIn: + type: boolean + relative_path: + type: string + template: + type: object + properties: + name: + type: string + categories: + type: boolean + url: + type: string + bodyClass: + type: string + topics: + type: array + items: + type: object + properties: + tid: + type: number + description: A topic identifier + uid: + type: number + description: A user identifier + cid: + type: number + description: A category identifier + mainPid: + type: number + description: The post id of the first post in this topic (also called the "original post") + title: + type: string + slug: + type: string + timestamp: + type: number + lastposttime: + type: number + postcount: + type: number + viewcount: + type: number + teaserPid: + type: number + upvotes: + type: number + downvotes: + type: number + deleted: + type: number + locked: + type: number + pinned: + type: number + description: Whether or not this particular topic is pinned to the top of the category + titleRaw: + type: string + timestampISO: + type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) + lastposttimeISO: + type: string + votes: + type: number + category: + type: object + properties: + cid: + type: number + description: A category identifier + name: + type: string + slug: + type: string + icon: + type: string + image: + nullable: true + imageClass: + nullable: true + type: string + bgColor: + type: string + color: + type: string + disabled: + type: number + user: + type: object + properties: + uid: + type: number + description: A user identifier + username: + type: string + description: A friendly name for a given user account + fullname: + type: string + userslug: + type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) + reputation: + type: number + postcount: + type: number + picture: + nullable: true + type: string + signature: + nullable: true + type: string + banned: + type: number + status: + type: string + icon:text: + type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar + icon:bgColor: + type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" + banned_until_readable: + type: string + teaser: + type: object + properties: + pid: + type: number + uid: + type: number + description: A user identifier + timestamp: + type: number + tid: + type: number + description: A topic identifier + content: + type: string + timestampISO: + type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) + user: + type: object + properties: + uid: + type: number + description: A user identifier + username: + type: string + description: A friendly name for a given user account + userslug: + type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) + picture: + nullable: true + type: string + icon:text: + type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar + icon:bgColor: + type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" + index: + type: number + tags: + type: array + items: + type: object + properties: + value: + type: string + valueEscaped: + type: string + color: + type: string + bgColor: + type: string + score: + type: number + isOwner: + type: boolean + ignored: + type: boolean + unread: + type: boolean + bookmark: + nullable: true + unreplied: + type: boolean + icons: + type: array + items: {} + index: + type: number + thumb: + type: string + isQuestion: + nullable: true + recentCards: + type: object + properties: + title: + type: string + opacity: + type: string + textShadow: + type: string + enableCarousel: + type: number + enableCarouselPagination: + type: number + _header: + type: object + properties: + tags: + type: object + properties: + meta: + type: array + items: + type: object + properties: + name: + type: string + content: + type: string + noEscape: + type: boolean + property: + type: string + link: + type: array + items: + type: object + properties: + rel: + type: string + type: + type: string + href: + type: string + title: + type: string + sizes: + type: string + widgets: + type: object + properties: + sidebar: + type: array + items: + type: object + properties: + html: + type: string + header: + type: array + items: + type: object + properties: + html: + type: string + footer: + type: array + items: + type: object + properties: + html: + type: string + motd: + type: array + items: + type: object + properties: + html: + type: string + example: + "/api/categories/{cid}/moderators": get: tags: - categories - summary: /api/categories/{cid}/moderators + summary: Get mods for a category + description: | + This route returns an array of uids that correspond to the moderators for the category in question. + + **Warning**: This route doesn't seem to be used in NodeBB core, so it may be at risk of removal. parameters: - name: cid + description: The category identifier for the category you wish to look up in: path required: true schema: - type: string - responses: {} + type: number + responses: + "200": + description: "An array of moderators for the requested category" + content: + application/json: + schema: + type: object + properties: + moderators: + type: array + example: + moderators: + - 1 + - 2 + - 3 "/api/recent/posts/{term?}": get: tags: @@ -5267,10 +5495,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -5283,15 +5513,19 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -5299,19 +5533,25 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -5320,6 +5560,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -5327,6 +5568,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -5335,6 +5577,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -5346,21 +5589,6 @@ paths: type: string isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost /api/unread/total: get: tags: @@ -5418,10 +5646,6 @@ paths: type: boolean qs: type: string - required: - - page - - active - - qs currentPage: type: number @@ -5606,12 +5830,6 @@ paths: type: string prompt: type: string - required: - - name - - url - - callbackURL - - icon - - scope allowRegistration: type: boolean allowLoginWith: @@ -5625,8 +5843,6 @@ paths: type: string url: type: string - required: - - text title: type: string allowPasswordReset: @@ -5676,11 +5892,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -5696,11 +5907,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -5745,12 +5951,6 @@ paths: type: string prompt: type: string - required: - - name - - url - - callbackURL - - icon - - scope minimumUsernameLength: type: number maximumUsernameLength: @@ -5768,8 +5968,6 @@ paths: type: string url: type: string - required: - - text regFormEntry: type: array items: @@ -5781,9 +5979,6 @@ paths: type: string styleName: type: string - required: - - label - - html title: type: string loggedIn: @@ -5820,11 +6015,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -5840,11 +6030,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -5913,11 +6098,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -5933,11 +6113,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -5995,11 +6170,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -6015,11 +6185,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -6063,10 +6228,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -6079,34 +6246,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -6115,6 +6292,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -6122,6 +6300,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -6130,6 +6309,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -6141,21 +6321,6 @@ paths: type: string isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost matchCount: type: number pageCount: @@ -6220,9 +6385,6 @@ paths: - type: number text: type: string - required: - - value - - text categoriesCount: type: number breadcrumbs: @@ -6234,8 +6396,6 @@ paths: type: string url: type: string - required: - - text expandSearch: type: boolean showAsPosts: @@ -6280,11 +6440,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -6300,11 +6455,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -6392,12 +6542,16 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -6422,10 +6576,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -6445,12 +6601,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score posts: type: array items: @@ -6460,8 +6610,10 @@ paths: type: number uid: type: number + description: A user identifier tid: type: number + description: A topic identifier content: type: string timestamp: @@ -6480,6 +6632,7 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) editedISO: type: string index: @@ -6489,10 +6642,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -6520,8 +6676,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string banned_until: @@ -6580,33 +6739,6 @@ paths: type: boolean display_post_menu: type: boolean - required: - - pid - - uid - - tid - - content - - timestamp - - votes - - upvotes - - deleted - - downvotes - - deleterUid - - edited - - timestampISO - - editedISO - - index - - user - - editor - - bookmarked - - upvoted - - downvoted - - replies - - selfPost - - display_edit_tools - - display_delete_tools - - display_moderator_tools - - display_move_tools - - display_post_menu category: type: object properties: @@ -6622,12 +6754,15 @@ paths: 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: @@ -6644,10 +6779,13 @@ paths: 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: {} @@ -6683,11 +6821,6 @@ paths: type: string activated: type: boolean - required: - - id - - name - - class - - activated deleter: nullable: true merger: @@ -6709,9 +6842,6 @@ paths: type: string url: type: string - required: - - text - - url privileges: type: object properties: @@ -6751,6 +6881,7 @@ paths: type: string uid: type: number + description: A user identifier topicStaleDays: type: number reputation:disabled: @@ -6798,10 +6929,6 @@ paths: type: boolean qs: type: string - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -6862,14 +6989,19 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account picture: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" _header: type: object properties: @@ -6889,11 +7021,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -6909,11 +7036,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -6924,20 +7046,22 @@ paths: properties: html: type: string - required: - - html text/plain: schema: type: object properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -6962,10 +7086,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -6985,12 +7111,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score posts: type: array items: @@ -7000,8 +7120,10 @@ paths: type: number uid: type: number + description: A user identifier tid: type: number + description: A topic identifier content: type: string timestamp: @@ -7020,6 +7142,7 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) editedISO: type: string index: @@ -7029,10 +7152,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -7060,8 +7186,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string banned_until: @@ -7120,33 +7249,6 @@ paths: type: boolean display_post_menu: type: boolean - required: - - pid - - uid - - tid - - content - - timestamp - - votes - - upvotes - - deleted - - downvotes - - deleterUid - - edited - - timestampISO - - editedISO - - index - - user - - editor - - bookmarked - - upvoted - - downvoted - - replies - - selfPost - - display_edit_tools - - display_delete_tools - - display_moderator_tools - - display_move_tools - - display_post_menu category: type: object properties: @@ -7162,12 +7264,15 @@ paths: 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: @@ -7184,10 +7289,13 @@ paths: 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: {} @@ -7223,11 +7331,6 @@ paths: type: string activated: type: boolean - required: - - id - - name - - class - - activated deleter: nullable: true merger: @@ -7249,9 +7352,6 @@ paths: type: string url: type: string - required: - - text - - url privileges: type: object properties: @@ -7291,6 +7391,7 @@ paths: type: string uid: type: number + description: A user identifier topicStaleDays: type: number reputation:disabled: @@ -7338,10 +7439,6 @@ paths: type: boolean qs: type: string - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -7402,14 +7499,19 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account picture: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" _header: type: object properties: @@ -7429,11 +7531,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -7449,11 +7546,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -7464,8 +7556,6 @@ paths: properties: html: type: string - required: - - html "401": description: "" content: @@ -7514,12 +7604,16 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -7544,10 +7638,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -7567,12 +7663,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score posts: type: array items: @@ -7582,10 +7672,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) nullable: true type: object votes: @@ -7594,6 +7687,7 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string pid: @@ -7602,6 +7696,7 @@ paths: type: number uid: type: number + description: A user identifier upvotes: type: number bookmarks: @@ -7618,32 +7713,31 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" administrator: type: boolean - required: - - uid - - username - - userslug - - picture - - icon:text - - icon:bgColor - - administrator text: type: string count: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) deleted: type: number downvotes: @@ -7652,6 +7746,7 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) editedISO: type: string index: @@ -7661,12 +7756,15 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account fullname: type: string userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -7695,8 +7793,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string banned_until: @@ -7720,13 +7821,6 @@ paths: type: string userTitle: type: string - required: - - name - - slug - - labelColor - - textColor - - icon - - userTitle custom_profile_info: type: array items: {} @@ -7755,36 +7849,7 @@ paths: properties: username: type: string - required: - - votes - - timestamp - - tid - - content - - pid - - uid - - deleted - - upvotes - - downvotes - - deleterUid - - edited - - timestampISO - - editedISO - - index - - user - - editor - - bookmarked - - upvoted - - downvoted - - replies - - selfPost - - display_edit_tools - - display_delete_tools - - display_moderator_tools - - display_move_tools - - display_post_menu - - toPid - - parent - - bookmarks + description: A friendly name for a given user account category: type: object properties: @@ -7800,12 +7865,15 @@ paths: 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: @@ -7822,10 +7890,13 @@ paths: 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: {} @@ -7861,11 +7932,6 @@ paths: type: string activated: type: boolean - required: - - id - - name - - class - - activated deleter: nullable: true merger: @@ -7887,9 +7953,6 @@ paths: type: string url: type: string - required: - - text - - url privileges: type: object properties: @@ -7929,6 +7992,7 @@ paths: type: string uid: type: number + description: A user identifier topicStaleDays: type: number reputation:disabled: @@ -7976,10 +8040,6 @@ paths: type: boolean qs: type: string - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -8040,14 +8100,19 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account picture: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" _header: type: object properties: @@ -8067,11 +8132,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -8087,11 +8147,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -8102,20 +8157,22 @@ paths: properties: html: type: string - required: - - html text/plain: schema: type: object properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -8140,10 +8197,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -8163,12 +8222,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score posts: type: array items: @@ -8178,10 +8231,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) nullable: true type: object votes: @@ -8190,6 +8246,7 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string pid: @@ -8198,6 +8255,7 @@ paths: type: number uid: type: number + description: A user identifier upvotes: type: number bookmarks: @@ -8214,32 +8272,31 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" administrator: type: boolean - required: - - uid - - username - - userslug - - picture - - icon:text - - icon:bgColor - - administrator text: type: string count: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) deleted: type: number downvotes: @@ -8248,6 +8305,7 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) editedISO: type: string index: @@ -8257,12 +8315,15 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account fullname: type: string userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -8291,8 +8352,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string banned_until: @@ -8316,13 +8380,6 @@ paths: type: string userTitle: type: string - required: - - name - - slug - - labelColor - - textColor - - icon - - userTitle custom_profile_info: type: array items: {} @@ -8351,36 +8408,7 @@ paths: properties: username: type: string - required: - - votes - - timestamp - - tid - - content - - pid - - uid - - deleted - - upvotes - - downvotes - - deleterUid - - edited - - timestampISO - - editedISO - - index - - user - - editor - - bookmarked - - upvoted - - downvoted - - replies - - selfPost - - display_edit_tools - - display_delete_tools - - display_moderator_tools - - display_move_tools - - display_post_menu - - toPid - - parent - - bookmarks + description: A friendly name for a given user account category: type: object properties: @@ -8396,12 +8424,15 @@ paths: 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: @@ -8418,10 +8449,13 @@ paths: 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: {} @@ -8457,11 +8491,6 @@ paths: type: string activated: type: boolean - required: - - id - - name - - class - - activated deleter: nullable: true merger: @@ -8483,9 +8512,6 @@ paths: type: string url: type: string - required: - - text - - url privileges: type: object properties: @@ -8525,6 +8551,7 @@ paths: type: string uid: type: number + description: A user identifier topicStaleDays: type: number reputation:disabled: @@ -8572,10 +8599,6 @@ paths: type: boolean qs: type: string - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -8636,14 +8659,19 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account picture: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" _header: type: object properties: @@ -8663,11 +8691,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -8683,11 +8706,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -8698,8 +8716,6 @@ paths: properties: html: type: string - required: - - html "401": description: "" content: @@ -8811,6 +8827,7 @@ paths: type: string uid: type: number + description: A user identifier datetime: type: number reporter: @@ -8818,13 +8835,17 @@ paths: properties: username: type: string + description: A friendly name for a given user account picture: nullable: true type: string icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar labelClass: type: string target_readable: @@ -8833,19 +8854,6 @@ paths: type: string assignee: type: string - required: - - state - - flagId - - type - - targetId - - description - - uid - - datetime - - reporter - - labelClass - - target_readable - - datetimeISO - - assignee analytics: type: array items: @@ -8925,10 +8933,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -9003,11 +9007,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -9023,11 +9022,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -9069,6 +9063,7 @@ paths: type: string uid: type: number + description: A user identifier datetime: type: number datetimeISO: @@ -9085,6 +9080,7 @@ paths: properties: uid: type: number + description: A user identifier fields: type: object properties: @@ -9099,16 +9095,22 @@ paths: properties: username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true uid: type: number + description: A user identifier icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" notes: type: array items: {} @@ -9117,18 +9119,24 @@ paths: properties: username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true reputation: type: number uid: type: number + description: A user identifier icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" type_path: type: string assignees: @@ -9138,16 +9146,22 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: number + description: Whether the user has confirmed their email address or not joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -9225,8 +9239,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -9235,47 +9252,6 @@ paths: type: number banned_until_readable: type: string - required: - - uid - - username - - userslug - - email - - email:confirmed - - joindate - - lastonline - - picture - - fullname - - location - - birthday - - website - - aboutme - - signature - - uploadedpicture - - profileviews - - reputation - - postcount - - topiccount - - lastposttime - - banned - - banned:expire - - status - - flags - - followerCount - - followingCount - - cover:url - - cover:position - - groupTitle - - fbid - - gplusid - - githubid - - twid - - groupTitleArray - - icon:text - - icon:bgColor - - joindateISO - - lastonlineISO - - banned_until - - banned_until_readable type_bool: type: object properties: @@ -9360,11 +9336,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -9380,11 +9351,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -9419,6 +9385,7 @@ paths: type: string uid: type: number + description: A user identifier type: type: string data: @@ -9439,11 +9406,13 @@ paths: items: {} uid: type: number + description: A user identifier req: type: object properties: uid: type: number + description: A user identifier ip: type: string host: @@ -9493,10 +9462,12 @@ paths: type: boolean timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) rawContent: type: string tid: type: number + description: A topic identifier toPid: nullable: true user: @@ -9504,17 +9475,23 @@ paths: properties: username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string uid: type: number + description: A user identifier icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: @@ -9531,6 +9508,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string description: @@ -9545,10 +9523,13 @@ paths: 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: @@ -9567,16 +9548,10 @@ paths: type: number totalPostCount: type: number + description: The number of posts in the category totalTopicCount: type: number - required: - - id - - uid - - type - - data - - user - - topic - - category + description: The number of topics in the category pagination: type: object properties: @@ -9652,11 +9627,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -9672,11 +9642,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -9734,12 +9699,16 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -9762,6 +9731,7 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category upvotes: type: number downvotes: @@ -9770,6 +9740,7 @@ paths: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -9779,6 +9750,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -9801,10 +9773,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -9821,8 +9796,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string fullname: @@ -9834,30 +9812,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -9875,12 +9862,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score isOwner: type: boolean ignored: @@ -9903,41 +9884,6 @@ paths: type: number isSolved: type: number - required: - - tid - - uid - - cid - - mainPid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - teaserPid - - deleted - - locked - - pinned - - upvotes - - downvotes - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index - - thumb - - isQuestion - - isSolved tag: type: string breadcrumbs: @@ -9949,9 +9895,6 @@ paths: type: string url: type: string - required: - - text - - url title: type: string categories: @@ -9961,6 +9904,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string level: @@ -9969,6 +9913,7 @@ paths: 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: @@ -9977,16 +9922,6 @@ paths: type: boolean imageClass: type: string - required: - - cid - - name - - level - - icon - - parentCid - - color - - bgColor - - selected - - imageClass pagination: type: object properties: @@ -10012,10 +9947,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -10092,11 +10023,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -10112,11 +10038,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -10160,12 +10081,6 @@ paths: type: string bgColor: type: string - required: - - value - - score - - valueEscaped - - color - - bgColor displayTagSearch: type: boolean nextStart: @@ -10179,8 +10094,6 @@ paths: type: string url: type: string - required: - - text title: type: string loggedIn: @@ -10217,11 +10130,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -10237,11 +10145,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -10252,669 +10155,6 @@ paths: properties: html: type: string - /api/categories: - get: - tags: - - categories - summary: /api/categories - responses: - "200": - description: "" - content: - application/json: - schema: - type: object - properties: - title: - type: string - categories: - type: array - items: - type: object - properties: - cid: - type: number - name: - type: string - description: - type: string - icon: - type: string - slug: - type: string - topic_count: - type: number - order: - type: number - bgColor: - type: string - link: - type: string - class: - type: string - numRecentReplies: - type: number - color: - type: string - post_count: - type: number - descriptionParsed: - type: string - parentCid: - type: number - disabled: - type: number - isSection: - type: number - totalPostCount: - type: number - totalTopicCount: - type: number - tagWhitelist: - type: array - items: {} - unread-class: - type: string - children: - type: array - items: - type: object - properties: - cid: - type: number - name: - type: string - description: - type: string - icon: - type: string - slug: - type: string - topic_count: - type: number - order: - type: number - bgColor: - type: string - link: - type: string - class: - type: string - numRecentReplies: - type: number - color: - type: string - post_count: - type: number - parentCid: - type: number - disabled: - type: number - isSection: - type: number - totalPostCount: - type: number - totalTopicCount: - type: number - descriptionParsed: - type: string - tagWhitelist: - type: array - items: {} - unread-class: - type: string - children: - type: array - items: {} - parent: - type: object - properties: - link: - type: string - class: - type: string - icon: - type: string - description: - type: string - order: - type: number - topic_count: - type: number - name: - type: string - cid: - type: number - post_count: - type: number - numRecentReplies: - type: number - bgColor: - type: string - slug: - type: string - color: - type: string - disabled: - type: number - descriptionParsed: - type: string - isSection: - type: number - parentCid: - type: number - totalPostCount: - type: number - totalTopicCount: - type: number - tagWhitelist: - type: array - items: {} - unread-class: - type: string - imageClass: - type: string - posts: - type: array - items: - type: object - properties: - pid: - type: number - timestamp: - type: number - content: - type: string - timestampISO: - type: string - user: - type: object - properties: - uid: - type: number - username: - type: string - userslug: - type: string - picture: - nullable: true - type: string - icon:text: - type: string - icon:bgColor: - type: string - index: - type: number - cid: - type: number - parentCid: - type: number - topic: - type: object - properties: - slug: - type: string - title: - type: string - required: - - pid - - timestamp - - content - - timestampISO - - user - - index - - cid - - parentCid - - topic - imageClass: - type: string - timesClicked: - type: number - required: - - cid - - name - - description - - icon - - bgColor - - color - - slug - - topic_count - - disabled - - order - - link - - numRecentReplies - - class - - post_count - - parentCid - - isSection - - totalPostCount - - totalTopicCount - - descriptionParsed - - tagWhitelist - - unread-class - - children - - parent - - posts - - imageClass - - timesClicked - posts: - type: array - items: - type: object - properties: - pid: - type: number - timestamp: - type: number - content: - type: string - timestampISO: - type: string - user: - type: object - properties: - uid: - type: number - username: - type: string - userslug: - type: string - picture: - nullable: true - type: string - icon:text: - type: string - icon:bgColor: - type: string - index: - type: number - cid: - type: number - parentCid: - type: number - topic: - type: object - properties: - slug: - type: string - title: - type: string - required: - - pid - - timestamp - - content - - timestampISO - - user - - index - - cid - - parentCid - - topic - teaser: - type: object - properties: - url: - type: string - timestampISO: - type: string - pid: - type: number - topic: - type: object - properties: - slug: - type: string - title: - type: string - imageClass: - type: string - required: - - cid - - name - - description - - icon - - slug - - topic_count - - disabled - - order - - bgColor - - link - - class - - numRecentReplies - - color - - post_count - - parentCid - - descriptionParsed - - isSection - - totalPostCount - - totalTopicCount - - tagWhitelist - - unread-class - - children - - posts - - teaser - - imageClass - breadcrumbs: - type: array - items: - type: object - properties: - text: - type: string - url: - type: string - required: - - text - loggedIn: - type: boolean - relative_path: - type: string - template: - type: object - properties: - name: - type: string - categories: - type: boolean - url: - type: string - bodyClass: - type: string - topics: - type: array - items: - type: object - properties: - tid: - type: number - uid: - type: number - cid: - type: number - mainPid: - type: number - title: - type: string - slug: - type: string - timestamp: - type: number - lastposttime: - type: number - postcount: - type: number - viewcount: - type: number - teaserPid: - type: number - upvotes: - type: number - downvotes: - type: number - deleted: - type: number - locked: - type: number - pinned: - type: number - titleRaw: - type: string - timestampISO: - type: string - lastposttimeISO: - type: string - votes: - type: number - category: - type: object - properties: - cid: - type: number - name: - type: string - slug: - type: string - icon: - type: string - image: - nullable: true - imageClass: - nullable: true - type: string - bgColor: - type: string - color: - type: string - disabled: - type: number - user: - type: object - properties: - uid: - type: number - username: - type: string - fullname: - type: string - userslug: - type: string - reputation: - type: number - postcount: - type: number - picture: - nullable: true - type: string - signature: - nullable: true - type: string - banned: - type: number - status: - type: string - icon:text: - type: string - icon:bgColor: - type: string - banned_until_readable: - type: string - teaser: - type: object - properties: - pid: - type: number - uid: - type: number - timestamp: - type: number - tid: - type: number - content: - type: string - timestampISO: - type: string - user: - type: object - properties: - uid: - type: number - username: - type: string - userslug: - type: string - picture: - nullable: true - type: string - icon:text: - type: string - icon:bgColor: - type: string - index: - type: number - tags: - type: array - items: - type: object - properties: - value: - type: string - valueEscaped: - type: string - color: - type: string - bgColor: - type: string - score: - type: number - required: - - value - - valueEscaped - - color - - bgColor - - score - isOwner: - type: boolean - ignored: - type: boolean - unread: - type: boolean - bookmark: - nullable: true - unreplied: - type: boolean - icons: - type: array - items: {} - index: - type: number - thumb: - type: string - isQuestion: - nullable: true - required: - - tid - - uid - - cid - - mainPid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - upvotes - - downvotes - - teaserPid - - deleted - - locked - - pinned - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index - - thumb - recentCards: - type: object - properties: - title: - type: string - opacity: - type: string - textShadow: - type: string - enableCarousel: - type: number - enableCarouselPagination: - type: number - _header: - type: object - properties: - tags: - type: object - properties: - meta: - type: array - items: - type: object - properties: - name: - type: string - content: - type: string - noEscape: - type: boolean - property: - type: string - required: - - name - - content - - noEscape - - property - link: - type: array - items: - type: object - properties: - rel: - type: string - type: - type: string - href: - type: string - title: - type: string - sizes: - type: string - required: - - rel - - href - - type - - sizes - widgets: - type: object - properties: - sidebar: - type: array - items: - type: object - properties: - html: - type: string - required: - - html - header: - type: array - items: - type: object - properties: - html: - type: string - footer: - type: array - items: - type: object - properties: - html: - type: string - motd: - type: array - items: - type: object - properties: - html: - type: string - "304": - description: "" /api/popular: get: tags: @@ -10939,10 +10179,13 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier title: type: string slug: @@ -10957,10 +10200,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category thumb: type: string mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") teaserPid: oneOf: - type: number @@ -10977,6 +10222,7 @@ paths: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -10986,6 +10232,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -11007,12 +10254,15 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account fullname: type: string userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -11029,8 +10279,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string teaser: @@ -11040,30 +10293,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -11081,12 +10343,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score isOwner: type: boolean ignored: @@ -11102,39 +10358,6 @@ paths: items: {} index: type: number - required: - - tid - - uid - - cid - - mainPid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - teaserPid - - thumb - - upvotes - - downvotes - - deleted - - locked - - pinned - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index tids: type: array items: @@ -11148,6 +10371,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string level: @@ -11156,6 +10380,7 @@ paths: 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: @@ -11164,16 +10389,6 @@ paths: type: boolean imageClass: type: string - required: - - cid - - name - - level - - icon - - parentCid - - color - - bgColor - - selected - - imageClass allCategoriesUrl: type: string selectedCids: @@ -11198,11 +10413,6 @@ paths: type: boolean filter: type: string - required: - - name - - url - - selected - - filter selectedFilter: type: object properties: @@ -11227,11 +10437,6 @@ paths: type: boolean term: type: string - required: - - name - - url - - selected - - term selectedTerm: type: object properties: @@ -11268,10 +10473,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -11321,8 +10522,6 @@ paths: type: string url: type: string - required: - - text loggedIn: type: boolean relative_path: @@ -11357,11 +10556,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -11377,11 +10571,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -11416,12 +10605,16 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -11446,10 +10639,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -11459,6 +10654,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -11481,12 +10677,15 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account fullname: type: string userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -11503,8 +10702,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string teaser: @@ -11514,30 +10716,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -11555,12 +10766,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score isOwner: type: boolean ignored: @@ -11580,39 +10785,6 @@ paths: type: string isQuestion: nullable: true - required: - - tid - - uid - - cid - - mainPid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - upvotes - - downvotes - - teaserPid - - deleted - - locked - - pinned - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index - - thumb tids: type: array items: @@ -11626,6 +10798,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string level: @@ -11634,6 +10807,7 @@ paths: 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: @@ -11642,16 +10816,6 @@ paths: type: boolean imageClass: type: string - required: - - cid - - name - - level - - icon - - parentCid - - color - - bgColor - - selected - - imageClass allCategoriesUrl: type: string selectedCids: @@ -11676,11 +10840,6 @@ paths: type: boolean filter: type: string - required: - - name - - url - - selected - - filter selectedFilter: type: object properties: @@ -11705,11 +10864,6 @@ paths: type: boolean term: type: string - required: - - name - - url - - selected - - term selectedTerm: type: object properties: @@ -11746,10 +10900,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -11799,8 +10949,6 @@ paths: type: string url: type: string - required: - - text loggedIn: type: boolean relative_path: @@ -11835,11 +10983,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -11855,11 +10998,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -11894,12 +11032,16 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -11924,10 +11066,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -11937,6 +11081,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -11958,10 +11103,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -11978,8 +11126,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string fullname: @@ -11991,30 +11142,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -12032,12 +11192,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score isOwner: type: boolean ignored: @@ -12055,37 +11209,6 @@ paths: type: number thumb: type: string - required: - - tid - - uid - - cid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - mainPid - - upvotes - - downvotes - - deleted - - locked - - pinned - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index tids: type: array items: @@ -12099,6 +11222,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string level: @@ -12107,6 +11231,7 @@ paths: 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: @@ -12115,16 +11240,6 @@ paths: type: boolean imageClass: type: string - required: - - cid - - name - - level - - icon - - parentCid - - color - - bgColor - - selected - - imageClass allCategoriesUrl: type: string selectedCategory: @@ -12132,6 +11247,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string level: @@ -12140,6 +11256,7 @@ paths: 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: @@ -12169,11 +11286,6 @@ paths: type: boolean filter: type: string - required: - - name - - url - - selected - - filter selectedFilter: type: object properties: @@ -12198,11 +11310,6 @@ paths: type: boolean term: type: string - required: - - name - - url - - selected - - term selectedTerm: type: object properties: @@ -12239,10 +11346,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -12292,8 +11395,6 @@ paths: type: string url: type: string - required: - - text loggedIn: type: boolean relative_path: @@ -12328,11 +11429,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -12348,11 +11444,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -12387,12 +11478,16 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -12417,10 +11512,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -12430,6 +11527,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -12452,12 +11550,15 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account fullname: type: string userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -12474,8 +11575,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string teaser: @@ -12485,30 +11589,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -12526,12 +11639,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score isOwner: type: boolean ignored: @@ -12549,38 +11656,6 @@ paths: type: number isQuestion: nullable: true - required: - - tid - - uid - - cid - - mainPid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - teaserPid - - deleted - - locked - - pinned - - upvotes - - downvotes - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index topicCount: type: number title: @@ -12635,6 +11710,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string level: @@ -12643,6 +11719,7 @@ paths: 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: @@ -12651,16 +11728,6 @@ paths: type: boolean imageClass: type: string - required: - - cid - - name - - level - - icon - - parentCid - - color - - bgColor - - selected - - imageClass allCategoriesUrl: type: string selectedCids: @@ -12675,8 +11742,6 @@ paths: type: string url: type: string - required: - - text filters: type: array items: @@ -12690,11 +11755,6 @@ paths: type: boolean filter: type: string - required: - - name - - url - - selected - - filter selectedFilter: type: object properties: @@ -12740,11 +11800,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -12760,11 +11815,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -12823,12 +11873,15 @@ paths: 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: @@ -12839,14 +11892,17 @@ paths: 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 descriptionParsed: type: string tagWhitelist: @@ -12864,10 +11920,13 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier title: type: string slug: @@ -12884,6 +11943,7 @@ paths: type: string mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") upvotes: type: number downvotes: @@ -12894,10 +11954,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -12907,6 +11969,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -12928,10 +11991,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -12948,8 +12014,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string fullname: @@ -12961,30 +12030,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -13007,39 +12085,6 @@ paths: type: number teaserPid: type: number - required: - - tid - - uid - - cid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - thumb - - mainPid - - upvotes - - downvotes - - deleted - - locked - - pinned - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index - - teaserPid nextStart: type: number isWatched: @@ -13057,9 +12102,6 @@ paths: type: string url: type: string - required: - - text - - url title: type: string privileges: @@ -13077,6 +12119,7 @@ paths: type: string uid: type: number + description: A user identifier editable: type: boolean view_deleted: @@ -13116,10 +12159,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -13194,11 +12233,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -13214,11 +12248,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -13258,6 +12287,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string description: @@ -13268,6 +12298,7 @@ paths: type: string topic_count: type: number + description: The number of topics in the category order: type: number bgColor: @@ -13282,18 +12313,22 @@ paths: 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: {} @@ -13309,10 +12344,13 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier title: type: string slug: @@ -13327,10 +12365,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category thumb: type: string mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") teaserPid: type: number upvotes: @@ -13345,6 +12385,7 @@ paths: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -13354,6 +12395,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -13375,12 +12417,15 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account fullname: type: string userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -13397,8 +12442,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string teaser: @@ -13408,30 +12456,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -13449,12 +12506,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score isOwner: type: boolean ignored: @@ -13474,41 +12525,6 @@ paths: type: number isSolved: type: number - required: - - tid - - uid - - cid - - mainPid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - teaserPid - - deleted - - locked - - pinned - - upvotes - - downvotes - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index - - thumb - - isQuestion - - isSolved nextStart: type: number isWatched: @@ -13526,9 +12542,6 @@ paths: type: string url: type: string - required: - - text - - url title: type: string privileges: @@ -13546,6 +12559,7 @@ paths: type: string uid: type: number + description: A user identifier editable: type: boolean view_deleted: @@ -13585,10 +12599,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -13663,11 +12673,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -13683,11 +12688,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -13749,16 +12749,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -13819,8 +12824,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -13942,11 +12950,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -13964,10 +12967,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -13980,34 +12985,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -14016,6 +13031,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -14023,6 +13039,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -14031,6 +13048,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -14041,21 +13059,6 @@ paths: nullable: true isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost latestPosts: type: array items: @@ -14065,10 +13068,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -14081,34 +13086,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -14117,6 +13132,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -14124,6 +13140,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -14132,6 +13149,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -14142,21 +13160,6 @@ paths: nullable: true isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost bestPosts: type: array items: @@ -14166,10 +13169,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -14182,34 +13187,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -14218,6 +13233,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -14225,6 +13241,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -14233,6 +13250,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -14244,21 +13262,6 @@ paths: type: string isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost hasPrivateChat: type: number breadcrumbs: @@ -14270,8 +13273,6 @@ paths: type: string url: type: string - required: - - text title: type: string allowCoverPicture: @@ -14361,11 +13362,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -14381,11 +13377,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -14402,16 +13393,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -14472,8 +13468,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -14595,11 +13594,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -14617,10 +13611,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -14633,34 +13629,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -14669,6 +13675,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -14676,6 +13683,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -14684,6 +13692,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -14694,21 +13703,6 @@ paths: nullable: true isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost latestPosts: type: array items: @@ -14718,10 +13712,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -14734,34 +13730,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -14770,6 +13776,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -14777,6 +13784,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -14785,6 +13793,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -14795,21 +13804,6 @@ paths: nullable: true isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost bestPosts: type: array items: @@ -14819,10 +13813,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -14835,34 +13831,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -14871,6 +13877,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -14878,6 +13885,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -14886,6 +13894,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -14897,21 +13906,6 @@ paths: type: string isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost hasPrivateChat: type: number breadcrumbs: @@ -14923,8 +13917,6 @@ paths: type: string url: type: string - required: - - text title: type: string allowCoverPicture: @@ -15014,11 +14006,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -15034,11 +14021,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -15083,16 +14065,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -15152,8 +14139,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -15245,13 +14235,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -15267,11 +14250,6 @@ paths: type: string deauthUrl: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -15335,9 +14313,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -15372,11 +14347,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -15392,11 +14362,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -15428,16 +14393,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -15498,8 +14468,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -15605,30 +14578,6 @@ paths: type: string cover:position: type: string - required: - - name - - slug - - createtime - - userTitle - - description - - memberCount - - deleted - - hidden - - system - - private - - ownerUid - - icon - - labelColor - - cover:url - - cover:position - - userTitleEnabled - - disableJoinRequests - - disableLeave - - nameEncoded - - displayName - - textColor - - createtimeISO - - cover:thumb:url disableSignatures: type: boolean reputation:disabled: @@ -15665,13 +14614,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -15687,12 +14629,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - deauthUrl - - name - - icon websiteLink: type: string websiteName: @@ -15712,10 +14648,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -15727,6 +14666,7 @@ paths: type: number email:confirmed: type: number + description: Whether the user has confirmed their email address or not lastonline: type: number flags: @@ -15737,10 +14677,14 @@ paths: type: number joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -15751,27 +14695,6 @@ paths: type: string administrator: type: boolean - required: - - uid - - username - - userslug - - picture - - status - - postcount - - reputation - - email:confirmed - - lastonline - - flags - - banned - - banned:expire - - joindate - - icon:text - - icon:bgColor - - joindateISO - - lastonlineISO - - banned_until - - banned_until_readable - - administrator pagination: type: object properties: @@ -15795,10 +14718,6 @@ paths: type: boolean qs: type: string - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -15848,9 +14767,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -15885,11 +14801,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -15905,11 +14816,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -15941,16 +14847,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -16011,8 +14922,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -16116,29 +15030,6 @@ paths: type: string cover:thumb:url: type: string - required: - - name - - slug - - createtime - - userTitle - - description - - deleted - - hidden - - system - - private - - icon - - labelColor - - memberCount - - cover:url - - cover:thumb:url - - userTitleEnabled - - disableJoinRequests - - disableLeave - - nameEncoded - - displayName - - textColor - - createtimeISO - - cover:position disableSignatures: type: boolean reputation:disabled: @@ -16175,13 +15066,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -16195,11 +15079,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -16215,6 +15094,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string level: @@ -16223,6 +15103,7 @@ paths: 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: @@ -16241,21 +15122,6 @@ paths: type: boolean imageClass: type: string - required: - - cid - - name - - level - - icon - - parentCid - - color - - bgColor - - descriptionParsed - - depth - - slug - - isIgnored - - isWatched - - isNotWatched - - imageClass title: type: string loggedIn: @@ -16292,11 +15158,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -16312,11 +15173,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -16348,16 +15204,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -16418,8 +15279,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -16511,13 +15375,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -16531,11 +15388,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -16603,9 +15455,6 @@ paths: type: string url: type: string - required: - - text - - url showSort: type: boolean sortOptions: @@ -16619,10 +15468,6 @@ paths: type: string selected: type: boolean - required: - - url - - name - - selected loggedIn: type: boolean relative_path: @@ -16657,11 +15502,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -16677,11 +15517,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -16713,16 +15548,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -16782,8 +15622,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -16855,11 +15698,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -16875,10 +15713,13 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier title: type: string slug: @@ -16895,6 +15736,7 @@ paths: type: string mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") teaserPid: type: number upvotes: @@ -16907,10 +15749,12 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -16920,6 +15764,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -16941,10 +15786,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -16959,8 +15807,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string teaser: @@ -16970,30 +15821,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -17014,38 +15874,6 @@ paths: items: {} index: type: number - required: - - tid - - uid - - cid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - mainPid - - teaserPid - - upvotes - - downvotes - - deleted - - locked - - pinned - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index nextStart: type: number pagination: @@ -17102,9 +15930,6 @@ paths: type: string url: type: string - required: - - text - - url showSort: type: boolean sortOptions: @@ -17118,10 +15943,6 @@ paths: type: string selected: type: boolean - required: - - url - - name - - selected loggedIn: type: boolean relative_path: @@ -17156,11 +15977,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -17176,11 +15992,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -17212,16 +16023,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -17281,8 +16097,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -17358,11 +16177,6 @@ paths: type: string deauthUrl: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -17380,10 +16194,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -17396,34 +16212,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -17432,6 +16258,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -17439,6 +16266,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -17447,6 +16275,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -17513,9 +16342,6 @@ paths: type: string url: type: string - required: - - text - - url showSort: type: boolean sortOptions: @@ -17529,10 +16355,6 @@ paths: type: string selected: type: boolean - required: - - url - - name - - selected loggedIn: type: boolean relative_path: @@ -17567,11 +16389,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -17587,11 +16404,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -17623,16 +16435,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -17693,8 +16510,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -17786,13 +16606,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -17806,11 +16619,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -17830,9 +16638,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -17867,11 +16672,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -17887,11 +16687,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -17925,16 +16720,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -17995,8 +16795,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -18088,13 +16891,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -18108,11 +16904,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -18180,9 +16971,6 @@ paths: type: string url: type: string - required: - - text - - url showSort: type: boolean sortOptions: @@ -18196,10 +16984,6 @@ paths: type: string selected: type: boolean - required: - - url - - name - - selected loggedIn: type: boolean relative_path: @@ -18234,11 +17018,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -18254,11 +17033,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -18290,16 +17064,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -18360,8 +17139,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -18469,30 +17251,6 @@ paths: type: string cover:position: type: string - required: - - name - - slug - - createtime - - userTitle - - description - - memberCount - - deleted - - hidden - - system - - private - - ownerUid - - icon - - labelColor - - cover:url - - cover:position - - userTitleEnabled - - disableJoinRequests - - disableLeave - - nameEncoded - - displayName - - textColor - - createtimeISO - - cover:thumb:url disableSignatures: type: boolean reputation:disabled: @@ -18529,13 +17287,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -18551,12 +17302,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - deauthUrl - - name - - icon websiteLink: type: string websiteName: @@ -18574,12 +17319,16 @@ paths: properties: tid: type: number + description: A topic identifier uid: type: number + description: A user identifier cid: type: number + description: A category identifier mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") title: type: string slug: @@ -18606,12 +17355,14 @@ paths: type: number pinned: type: number + description: Whether or not this particular topic is pinned to the top of the category deleterUid: type: number titleRaw: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) lastposttimeISO: type: string votes: @@ -18621,6 +17372,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string slug: @@ -18644,10 +17396,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) reputation: type: number postcount: @@ -18663,8 +17418,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string fullname: @@ -18676,30 +17434,39 @@ paths: type: number uid: type: number + description: A user identifier timestamp: type: number tid: type: number + description: A topic identifier content: type: string timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" index: type: number tags: @@ -18717,12 +17484,6 @@ paths: type: string score: type: number - required: - - value - - valueEscaped - - color - - bgColor - - score isOwner: type: boolean ignored: @@ -18745,40 +17506,6 @@ paths: type: number isSolved: type: number - required: - - tid - - uid - - cid - - mainPid - - title - - slug - - timestamp - - lastposttime - - postcount - - viewcount - - teaserPid - - upvotes - - downvotes - - deleted - - locked - - pinned - - deleterUid - - titleRaw - - timestampISO - - lastposttimeISO - - votes - - category - - user - - teaser - - tags - - isOwner - - ignored - - unread - - bookmark - - unreplied - - icons - - index - - thumb nextStart: type: number pagination: @@ -18804,10 +17531,6 @@ paths: type: boolean qs: type: string - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -18861,9 +17584,6 @@ paths: type: string url: type: string - required: - - text - - url showSort: type: boolean sortOptions: @@ -18877,10 +17597,6 @@ paths: type: string selected: type: boolean - required: - - url - - name - - selected loggedIn: type: boolean relative_path: @@ -18915,11 +17631,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -18935,11 +17646,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -18971,16 +17677,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -19040,8 +17751,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -19135,13 +17849,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -19157,11 +17864,6 @@ paths: type: string deauthUrl: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -19229,9 +17931,6 @@ paths: type: string url: type: string - required: - - text - - url showSort: type: boolean sortOptions: @@ -19245,10 +17944,6 @@ paths: type: string selected: type: boolean - required: - - url - - name - - selected loggedIn: type: boolean relative_path: @@ -19283,11 +17978,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -19303,11 +17993,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -19363,16 +18048,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -19432,8 +18122,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -19525,13 +18218,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -19547,11 +18233,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -19601,9 +18282,6 @@ paths: type: string url: type: string - required: - - text - - url editButtons: type: array items: {} @@ -19641,11 +18319,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -19661,11 +18334,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -19717,16 +18385,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -19786,8 +18459,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -19879,13 +18555,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -19901,11 +18570,6 @@ paths: type: string deauthUrl: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -19927,9 +18591,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -19964,11 +18625,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -19984,11 +18640,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -20033,16 +18684,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -20102,8 +18758,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -20197,13 +18856,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -20219,11 +18871,6 @@ paths: type: string deauthUrl: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -20245,9 +18892,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -20282,11 +18926,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -20302,11 +18941,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -20338,16 +18972,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -20407,8 +19046,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -20500,13 +19142,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -20520,11 +19155,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -20550,9 +19180,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -20587,11 +19214,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -20607,11 +19229,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -20643,16 +19260,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -20713,8 +19335,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -20822,30 +19447,6 @@ paths: type: string cover:position: type: string - required: - - name - - slug - - createtime - - userTitle - - description - - memberCount - - deleted - - hidden - - system - - private - - ownerUid - - icon - - labelColor - - cover:url - - cover:position - - userTitleEnabled - - disableJoinRequests - - disableLeave - - nameEncoded - - displayName - - textColor - - createtimeISO - - cover:thumb:url disableSignatures: type: boolean reputation:disabled: @@ -20882,13 +19483,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -20904,12 +19498,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - deauthUrl - - name - - icon websiteLink: type: string websiteName: @@ -20934,19 +19522,13 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) timestampReadable: type: string title: type: string titleRaw: type: string - required: - - pid - - timestamp - - timestampISO - - timestampReadable - - title - - titleRaw bans: type: array items: {} @@ -20971,15 +19553,6 @@ paths: type: boolean datetimeISO: type: string - required: - - ip - - uuid - - datetime - - platform - - browser - - version - - current - - datetimeISO usernames: type: array items: @@ -20991,6 +19564,7 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) emails: type: array items: @@ -21002,6 +19576,7 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) moderationNotes: type: array items: {} @@ -21057,9 +19632,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -21094,11 +19666,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -21114,11 +19681,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -21150,16 +19712,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -21220,8 +19787,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -21327,30 +19897,6 @@ paths: - type: number ownerUid: type: number - required: - - name - - slug - - createtime - - userTitle - - description - - memberCount - - hidden - - system - - private - - icon - - labelColor - - userTitleEnabled - - disableJoinRequests - - disableLeave - - nameEncoded - - displayName - - textColor - - createtimeISO - - cover:thumb:url - - cover:url - - cover:position - - deleted - - ownerUid disableSignatures: type: boolean reputation:disabled: @@ -21387,13 +19933,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -21409,12 +19948,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - deauthUrl - - name - - icon websiteLink: type: string websiteName: @@ -21516,6 +20049,7 @@ paths: type: string uid: type: number + description: A user identifier languages: type: array items: @@ -21529,11 +20063,6 @@ paths: type: string selected: type: boolean - required: - - name - - code - - dir - - selected acpLanguages: type: array items: @@ -21547,11 +20076,6 @@ paths: type: string selected: type: boolean - required: - - name - - code - - dir - - selected notification-sound: type: array items: @@ -21570,10 +20094,6 @@ paths: type: string selected: type: boolean - required: - - name - - value - - selected notificationSound: type: array items: @@ -21583,9 +20103,6 @@ paths: type: string selected: type: boolean - required: - - name - - selected chat-incoming-sound: type: array items: @@ -21604,10 +20121,6 @@ paths: type: string selected: type: boolean - required: - - name - - value - - selected incomingChatSound: type: array items: @@ -21617,9 +20130,6 @@ paths: type: string selected: type: boolean - required: - - name - - selected chat-outgoing-sound: type: array items: @@ -21638,10 +20148,6 @@ paths: type: string selected: type: boolean - required: - - name - - value - - selected outgoingChatSound: type: array items: @@ -21651,9 +20157,6 @@ paths: type: string selected: type: boolean - required: - - name - - selected customSettings: type: array items: {} @@ -21668,10 +20171,6 @@ paths: type: string selected: type: boolean - required: - - route - - name - - selected notificationSettings: type: array items: @@ -21689,13 +20188,6 @@ paths: type: boolean notificationemail: type: boolean - required: - - name - - label - - none - - notification - - email - - notificationemail disableEmailSubscriptions: type: number dailyDigestFreqOptions: @@ -21709,10 +20201,6 @@ paths: type: string selected: type: boolean - required: - - value - - name - - selected bootswatchSkinOptions: type: array items: @@ -21724,10 +20212,6 @@ paths: type: string selected: type: boolean - required: - - name - - value - - selected upvoteNotifFreq: type: array items: @@ -21737,9 +20221,6 @@ paths: type: string selected: type: boolean - required: - - name - - selected categoryWatchState: type: object properties: @@ -21770,9 +20251,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -21807,11 +20285,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -21827,11 +20300,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -21883,16 +20351,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -21953,8 +20426,11 @@ paths: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -22048,13 +20524,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -22068,11 +20537,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -22138,9 +20602,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -22175,11 +20636,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -22195,11 +20651,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -22231,16 +20682,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -22300,8 +20756,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -22395,13 +20854,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -22417,11 +20869,6 @@ paths: type: string deauthUrl: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -22450,9 +20897,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -22487,11 +20931,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -22507,11 +20946,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -22543,16 +20977,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -22612,8 +21051,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -22707,13 +21149,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -22729,11 +21164,6 @@ paths: type: string icon: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -22797,9 +21227,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -22834,11 +21261,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -22854,11 +21276,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -22890,16 +21307,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) email: type: string + description: Email address associated with the user account email:confirmed: type: boolean joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created lastonline: type: number picture: @@ -22959,8 +21381,11 @@ paths: items: {} icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -23054,13 +21479,6 @@ paths: type: boolean icon: type: string - required: - - id - - route - - name - - visibility - - public - - icon sso: type: array items: @@ -23076,11 +21494,6 @@ paths: type: string deauthUrl: type: string - required: - - associated - - url - - name - - icon websiteLink: type: string websiteName: @@ -23103,9 +21516,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -23140,11 +21550,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -23160,11 +21565,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -23222,6 +21622,7 @@ paths: - type: string tid: type: number + description: A topic identifier path: type: string nid: @@ -23243,16 +21644,22 @@ paths: properties: username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string uid: type: number + description: A user identifier icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" image: type: string read: @@ -23261,24 +21668,6 @@ paths: type: string subject: type: string - required: - - type - - bodyShort - - bodyLong - - pid - - path - - nid - - tid - - from - - mergeId - - topicTitle - - importance - - datetime - - datetimeISO - - user - - image - - read - - readClass pagination: type: object properties: @@ -23331,9 +21720,6 @@ paths: type: string selected: type: boolean - required: - - name - - filter regularFilters: type: array items: @@ -23345,9 +21731,6 @@ paths: type: string selected: type: boolean - required: - - name - - filter moderatorFilters: type: array items: @@ -23357,9 +21740,6 @@ paths: type: string filter: type: string - required: - - name - - filter selectedFilter: type: object properties: @@ -23380,8 +21760,6 @@ paths: type: string url: type: string - required: - - text loggedIn: type: boolean relative_path: @@ -23416,11 +21794,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -23436,11 +21809,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -23509,6 +21877,7 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) editedISO: type: string messageId: @@ -23518,10 +21887,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: @@ -23530,8 +21902,11 @@ paths: type: boolean icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string deleted: @@ -23544,21 +21919,6 @@ paths: type: number cleanedContent: type: string - required: - - content - - timestamp - - fromuid - - roomId - - deleted - - system - - edited - - timestampISO - - editedISO - - messageId - - fromUser - - self - - newSet - - index isOwner: type: boolean users: @@ -23568,16 +21928,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" isOwner: type: boolean canReply: @@ -23614,10 +21979,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -23627,20 +21995,13 @@ paths: type: number icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string - required: - - uid - - username - - userslug - - picture - - status - - lastonline - - icon:text - - icon:bgColor - - lastonlineISO groupChat: type: boolean unread: @@ -23656,15 +22017,19 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -23674,8 +22039,11 @@ paths: type: number icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string lastUser: @@ -23683,10 +22051,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -23696,30 +22067,25 @@ paths: type: number icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string usernames: type: string - required: - - owner - - roomId - - roomName - - users - - groupChat - - unread - - teaser - - lastUser - - usernames nextStart: type: number title: type: string uid: type: number + description: A user identifier userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) canViewInfo: type: boolean loggedIn: @@ -23756,11 +22122,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -23776,11 +22137,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -23822,6 +22178,7 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) editedISO: type: string messageId: @@ -23831,10 +22188,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: @@ -23843,8 +22203,11 @@ paths: type: boolean icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" banned_until_readable: type: string deleted: @@ -23857,21 +22220,6 @@ paths: type: number cleanedContent: type: string - required: - - content - - timestamp - - fromuid - - roomId - - deleted - - system - - edited - - timestampISO - - editedISO - - messageId - - fromUser - - self - - newSet - - index isOwner: type: boolean users: @@ -23881,16 +22229,21 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" isOwner: type: boolean canReply: @@ -23927,10 +22280,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -23940,20 +22296,13 @@ paths: type: number icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string - required: - - uid - - username - - userslug - - picture - - status - - lastonline - - icon:text - - icon:bgColor - - lastonlineISO groupChat: type: boolean unread: @@ -23969,15 +22318,19 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -23987,8 +22340,11 @@ paths: type: number icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string lastUser: @@ -23996,10 +22352,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -24009,30 +22368,25 @@ paths: type: number icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" lastonlineISO: type: string usernames: type: string - required: - - owner - - roomId - - roomName - - users - - groupChat - - unread - - teaser - - lastUser - - usernames nextStart: type: number title: type: string uid: type: number + description: A user identifier userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) canViewInfo: type: boolean loggedIn: @@ -24069,11 +22423,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -24089,11 +22438,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -24156,10 +22500,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: nullable: true type: string @@ -24171,6 +22518,7 @@ paths: type: number email:confirmed: type: number + description: Whether the user has confirmed their email address or not lastonline: type: number flags: @@ -24181,10 +22529,14 @@ paths: type: number joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -24195,27 +22547,6 @@ paths: type: string administrator: type: boolean - required: - - uid - - username - - userslug - - picture - - status - - postcount - - reputation - - email:confirmed - - lastonline - - flags - - banned - - banned:expire - - joindate - - icon:text - - icon:bgColor - - joindateISO - - lastonlineISO - - banned_until - - banned_until_readable - - administrator pagination: type: object properties: @@ -24241,10 +22572,6 @@ paths: type: string separator: type: boolean - required: - - page - - active - - qs currentPage: type: number pageCount: @@ -24298,8 +22625,6 @@ paths: type: string url: type: string - required: - - text isAdminOrGlobalMod: type: boolean isAdmin: @@ -24356,11 +22681,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -24376,11 +22696,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -24464,54 +22779,27 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account picture: nullable: true type: string userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string - required: - - uid - - username - - picture - - userslug - - icon:text - - icon:bgColor + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" truncated: type: boolean ownerUid: type: number - required: - - name - - description - - deleted - - hidden - - system - - userTitle - - icon - - labelColor - - slug - - createtime - - memberCount - - private - - cover:url - - cover:position - - userTitleEnabled - - disableJoinRequests - - disableLeave - - nameEncoded - - displayName - - textColor - - createtimeISO - - cover:thumb:url - - members - - truncated - - ownerUid allowGroupCreation: type: boolean nextStart: @@ -24527,8 +22815,6 @@ paths: type: string url: type: string - required: - - text loggedIn: type: boolean relative_path: @@ -24563,11 +22849,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -24583,11 +22864,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -24677,10 +22953,13 @@ paths: properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: @@ -24691,6 +22970,7 @@ paths: type: number email:confirmed: type: number + description: Whether the user has confirmed their email address or not lastonline: type: number flags: @@ -24702,10 +22982,14 @@ paths: type: number joindate: type: number + description: A UNIX timestamp representing the moment the user's account was created icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" joindateISO: type: string lastonlineISO: @@ -24718,28 +23002,6 @@ paths: type: boolean isOwner: type: boolean - required: - - uid - - username - - userslug - - picture - - status - - postcount - - reputation - - email:confirmed - - lastonline - - flags - - banned - - banned:expire - - joindate - - icon:text - - icon:bgColor - - joindateISO - - lastonlineISO - - banned_until - - banned_until_readable - - administrator - - isOwner membersNextStart: type: number pending: @@ -24765,10 +23027,12 @@ paths: type: number tid: type: number + description: A topic identifier content: type: string uid: type: number + description: A user identifier timestamp: type: number deleted: @@ -24781,34 +23045,44 @@ paths: type: number timestampISO: type: string + description: An ISO 8601 formatted date string (complementing `timestamp`) user: type: object properties: uid: type: number + description: A user identifier username: type: string + description: A friendly name for a given user account userslug: type: string + description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) picture: type: string status: type: string icon:text: type: string + description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar icon:bgColor: type: string + description: A six-character hexadecimal colour code assigned to the user. This value is used in conjunction with `icon:text` for the user's auto-generated icon + example: "#f44336" topic: type: object properties: uid: type: number + description: A user identifier tid: type: number + description: A topic identifier title: type: string cid: type: number + description: A category identifier slug: type: string deleted: @@ -24817,6 +23091,7 @@ paths: type: number mainPid: type: number + description: The post id of the first post in this topic (also called the "original post") titleRaw: type: string category: @@ -24824,6 +23099,7 @@ paths: properties: cid: type: number + description: A category identifier name: type: string icon: @@ -24832,6 +23108,7 @@ paths: type: string parentCid: type: number + description: The category identifier for the category that is the immediate ancestor of the current category bgColor: type: string color: @@ -24843,21 +23120,6 @@ paths: type: string isMainPost: type: boolean - required: - - pid - - tid - - content - - uid - - timestamp - - deleted - - upvotes - - downvotes - - votes - - timestampISO - - user - - topic - - category - - isMainPost isAdmin: type: boolean isGlobalMod: @@ -24873,9 +23135,6 @@ paths: type: string url: type: string - required: - - text - - url loggedIn: type: boolean relative_path: @@ -24910,11 +23169,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -24930,11 +23184,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: @@ -24998,11 +23247,6 @@ paths: type: boolean property: type: string - required: - - name - - content - - noEscape - - property link: type: array items: @@ -25018,11 +23262,6 @@ paths: type: string sizes: type: string - required: - - rel - - href - - type - - sizes widgets: type: object properties: