From 2395d2be2e7d47843f95b10107b32ac7ccb09a17 Mon Sep 17 00:00:00 2001
From: Julian Lam <julian@nodebb.org>
Date: Tue, 14 Apr 2020 20:58:10 -0400
Subject: [PATCH] fix(openapi): added PostsObject component

---
 .../components/schemas/PostsObject.yaml       | 110 +++
 public/openapi/read.yaml                      | 770 +-----------------
 2 files changed, 118 insertions(+), 762 deletions(-)
 create mode 100644 public/openapi/components/schemas/PostsObject.yaml

diff --git a/public/openapi/components/schemas/PostsObject.yaml b/public/openapi/components/schemas/PostsObject.yaml
new file mode 100644
index 0000000000..9a6e0eaee3
--- /dev/null
+++ b/public/openapi/components/schemas/PostsObject.yaml
@@ -0,0 +1,110 @@
+PostsObject:
+  type: array
+  items:
+    type: object
+    properties:
+      pid:
+        type: number
+      tid:
+        type: number
+        description: A topic identifier
+      content:
+        type: string
+      uid:
+        type: number
+        description: A user identifier
+      timestamp:
+        type: number
+      deleted:
+        type: boolean
+      upvotes:
+        type: number
+      downvotes:
+        type: number
+      votes:
+        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:
+            type: number
+          postcount:
+            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:
+        type: object
+        properties:
+          cid:
+            type: number
+            description: A category identifier
+          name:
+            type: string
+          icon:
+            type: string
+          slug:
+            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:
+            type: string
+          image:
+            nullable: true
+          imageClass:
+            nullable: true
+            type: string
+      isMainPost:
+        type: boolean
\ No newline at end of file
diff --git a/public/openapi/read.yaml b/public/openapi/read.yaml
index 4e295e9178..a936d9a72f 100644
--- a/public/openapi/read.yaml
+++ b/public/openapi/read.yaml
@@ -2804,114 +2804,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  type: object
-                  properties:
-                    pid:
-                      type: number
-                    tid:
-                      type: number
-                      description: A topic identifier
-                    content:
-                      type: string
-                    uid:
-                      type: number
-                      description: A user identifier
-                    timestamp:
-                      type: number
-                    deleted:
-                      type: boolean
-                    upvotes:
-                      type: number
-                    downvotes:
-                      type: number
-                    votes:
-                      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
-                        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:
-                          type: number
-                        postcount:
-                          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:
-                      type: object
-                      properties:
-                        cid:
-                          type: number
-                          description: A category identifier
-                        name:
-                          type: string
-                        icon:
-                          type: string
-                        slug:
-                          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:
-                          type: string
-                        image:
-                          nullable: true
-                        imageClass:
-                          nullable: true
-                          type: string
-                    isMainPost:
-                      type: boolean
+                $ref: components/schemas/PostsObject.yaml#/PostsObject
   /api/unread/total:
     get:
       tags:
@@ -3262,115 +3155,7 @@ paths:
                   - type: object
                     properties:
                       posts:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            pid:
-                              type: number
-                            tid:
-                              type: number
-                              description: A topic identifier
-                            content:
-                              type: string
-                            uid:
-                              type: number
-                              description: A user identifier
-                            timestamp:
-                              type: number
-                            deleted:
-                              type: boolean
-                            upvotes:
-                              type: number
-                            downvotes:
-                              type: number
-                            votes:
-                              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:
-                                  type: number
-                                postcount:
-                                  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:
-                              type: object
-                              properties:
-                                cid:
-                                  type: number
-                                  description: A category identifier
-                                name:
-                                  type: string
-                                icon:
-                                  type: string
-                                slug:
-                                  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:
-                                  type: string
-                                image:
-                                  nullable: true
-                                imageClass:
-                                  nullable: true
-                                  type: string
-                            isMainPost:
-                              type: boolean
+                        $ref: components/schemas/PostsObject.yaml#/PostsObject
                       matchCount:
                         type: number
                       pageCount:
@@ -4647,9 +4432,7 @@ paths:
                                   type: object
                                   properties:
                                     cid:
-                                      oneOf:
-                                        - type: number
-                                        - type: string
+                                      type: number
                                     title:
                                       type: string
                                     titleRaw:
@@ -6823,333 +6606,11 @@ paths:
                   - type: object
                     properties:
                       posts:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            pid:
-                              type: number
-                            tid:
-                              type: number
-                              description: A topic identifier
-                            content:
-                              type: string
-                            uid:
-                              type: number
-                              description: A user identifier
-                            timestamp:
-                              type: number
-                            deleted:
-                              type: boolean
-                            upvotes:
-                              type: number
-                            downvotes:
-                              type: number
-                            votes:
-                              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:
-                                  type: number
-                                postcount:
-                                  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:
-                              type: object
-                              properties:
-                                cid:
-                                  type: number
-                                  description: A category identifier
-                                name:
-                                  type: string
-                                icon:
-                                  type: string
-                                slug:
-                                  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:
-                                  type: string
-                                image:
-                                  nullable: true
-                                imageClass:
-                                  nullable: true
-                            isMainPost:
-                              type: boolean
+                        $ref: components/schemas/PostsObject.yaml#/PostsObject
                       latestPosts:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            pid:
-                              type: number
-                            tid:
-                              type: number
-                              description: A topic identifier
-                            content:
-                              type: string
-                            uid:
-                              type: number
-                              description: A user identifier
-                            timestamp:
-                              type: number
-                            deleted:
-                              type: boolean
-                            upvotes:
-                              type: number
-                            downvotes:
-                              type: number
-                            votes:
-                              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:
-                                  type: number
-                                postcount:
-                                  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:
-                              type: object
-                              properties:
-                                cid:
-                                  type: number
-                                  description: A category identifier
-                                name:
-                                  type: string
-                                icon:
-                                  type: string
-                                slug:
-                                  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:
-                                  type: string
-                                image:
-                                  nullable: true
-                                imageClass:
-                                  nullable: true
-                            isMainPost:
-                              type: boolean
+                        $ref: components/schemas/PostsObject.yaml#/PostsObject
                       bestPosts:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            pid:
-                              type: number
-                            tid:
-                              type: number
-                              description: A topic identifier
-                            content:
-                              type: string
-                            uid:
-                              type: number
-                              description: A user identifier
-                            timestamp:
-                              type: number
-                            deleted:
-                              type: boolean
-                            upvotes:
-                              type: number
-                            downvotes:
-                              type: number
-                            votes:
-                              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:
-                                  type: number
-                                postcount:
-                                  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:
-                              type: object
-                              properties:
-                                cid:
-                                  type: number
-                                  description: A category identifier
-                                name:
-                                  type: string
-                                icon:
-                                  type: string
-                                slug:
-                                  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:
-                                  type: string
-                                image:
-                                  nullable: true
-                                imageClass:
-                                  nullable: true
-                                  type: string
-                            isMainPost:
-                              type: boolean
+                        $ref: components/schemas/PostsObject.yaml#/PostsObject
                       hasPrivateChat:
                         type: number
                       title:
@@ -7813,114 +7274,7 @@ paths:
                   - type: object
                     properties:
                       posts:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            pid:
-                              type: number
-                            tid:
-                              type: number
-                              description: A topic identifier
-                            content:
-                              type: string
-                            uid:
-                              type: number
-                              description: A user identifier
-                            timestamp:
-                              type: number
-                            deleted:
-                              type: boolean
-                            upvotes:
-                              type: number
-                            downvotes:
-                              type: number
-                            votes:
-                              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:
-                                  type: number
-                                postcount:
-                                  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:
-                              type: object
-                              properties:
-                                cid:
-                                  type: number
-                                  description: A category identifier
-                                name:
-                                  type: string
-                                icon:
-                                  type: string
-                                slug:
-                                  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:
-                                  type: string
-                                image:
-                                  nullable: true
-                                imageClass:
-                                  nullable: true
-                            isMainPost:
-                              type: boolean
+                        $ref: components/schemas/PostsObject.yaml#/PostsObject
                       nextStart:
                         type: number
                       noItemsFoundKey:
@@ -10095,115 +9449,7 @@ paths:
                           isOwner:
                             type: boolean
                       posts:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            pid:
-                              type: number
-                            tid:
-                              type: number
-                              description: A topic identifier
-                            content:
-                              type: string
-                            uid:
-                              type: number
-                              description: A user identifier
-                            timestamp:
-                              type: number
-                            deleted:
-                              type: boolean
-                            upvotes:
-                              type: number
-                            downvotes:
-                              type: number
-                            votes:
-                              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:
-                                  type: number
-                                postcount:
-                                  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:
-                              type: object
-                              properties:
-                                cid:
-                                  type: number
-                                  description: A category identifier
-                                name:
-                                  type: string
-                                icon:
-                                  type: string
-                                slug:
-                                  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:
-                                  type: string
-                                image:
-                                  nullable: true
-                                imageClass:
-                                  nullable: true
-                                  type: string
-                            isMainPost:
-                              type: boolean
+                        $ref: components/schemas/PostsObject.yaml#/PostsObject
                       isAdmin:
                         type: boolean
                       isGlobalMod: