diff --git a/public/openapi/read/categories.yaml b/public/openapi/read/categories.yaml index 74e2a9d486..278ab8a7c1 100644 --- a/public/openapi/read/categories.yaml +++ b/public/openapi/read/categories.yaml @@ -193,6 +193,9 @@ get: description: An ISO 8601 formatted date string (complementing `timestamp`) pid: type: number + index: + type: number + description: The index of the post topic: type: object properties: @@ -200,6 +203,32 @@ get: type: string title: type: string + user: + type: object + properties: + uid: + type: number + example: 1 + username: + type: string + example: Dragon Fruit + userslug: + type: string + example: dragon-fruit + picture: + type: string + example: 'https://images.unsplash.com/photo-1560070094-e1f2ddec4337?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=256&h=256&q=80' + nullable: true + displayname: + type: string + description: This is either username or fullname depending on forum and user settings + example: Dragon Fruit + 'icon:text': + type: string + example: D + 'icon:bgColor': + type: string + example: '#9c27b0' imageClass: type: string - $ref: ../components/schemas/Pagination.yaml#/Pagination diff --git a/public/openapi/read/index.yaml b/public/openapi/read/index.yaml index 4e6c6e446b..41848f596b 100644 --- a/public/openapi/read/index.yaml +++ b/public/openapi/read/index.yaml @@ -195,6 +195,9 @@ get: description: An ISO 8601 formatted date string (complementing `timestamp`) pid: type: number + index: + type: number + description: The index of the post topic: type: object properties: @@ -202,6 +205,32 @@ get: type: string title: type: string + user: + type: object + properties: + uid: + type: number + example: 1 + username: + type: string + example: Dragon Fruit + userslug: + type: string + example: dragon-fruit + picture: + type: string + example: 'https://images.unsplash.com/photo-1560070094-e1f2ddec4337?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=256&h=256&q=80' + nullable: true + displayname: + type: string + description: This is either username or fullname depending on forum and user settings + example: Dragon Fruit + 'icon:text': + type: string + example: D + 'icon:bgColor': + type: string + example: '#9c27b0' imageClass: type: string - $ref: ../components/schemas/Pagination.yaml#/Pagination