diff --git a/public/openapi/components/schemas/PostObject.yaml b/public/openapi/components/schemas/PostObject.yaml new file mode 100644 index 0000000000..04c7e40937 --- /dev/null +++ b/public/openapi/components/schemas/PostObject.yaml @@ -0,0 +1,116 @@ +PostObject: + description: A single post in the array returned from `Posts.getPostSummaryByPids` + 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 + 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") + teaserPid: + type: number + description: The post id of the teaser (the most recent post, depending on settings) + nullable: true + 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 + backgroundImage: + nullable: true + imageClass: + nullable: true + type: string + isMainPost: + type: boolean + replies: + type: number \ No newline at end of file diff --git a/public/openapi/write/groups/slug.yaml b/public/openapi/write/groups/slug.yaml new file mode 100644 index 0000000000..eb867a6897 --- /dev/null +++ b/public/openapi/write/groups/slug.yaml @@ -0,0 +1,26 @@ +delete: + tags: + - groups + summary: Delete an existing group + description: This operation deletes an existing group, all members within this group will cease to be members after the group is deleted. + parameters: + - in: path + name: slug + schema: + type: string + required: true + description: slug of the group you wish to delete + example: my-test-group + responses: + '200': + description: group successfully deleted + content: + application/json: + schema: + type: object + properties: + status: + $ref: ../../components/schemas/Status.yaml#/Status + response: + type: object + properties: {} \ No newline at end of file diff --git a/public/openapi/write/users/uid/tokens/token.yaml b/public/openapi/write/users/uid/tokens/token.yaml new file mode 100644 index 0000000000..ef17a8e752 --- /dev/null +++ b/public/openapi/write/users/uid/tokens/token.yaml @@ -0,0 +1,31 @@ +delete: + tags: + - users + summary: delete user token + parameters: + - in: path + name: uid + schema: + type: integer + required: true + description: uid of the user whose token you want to delete + example: 1 + - in: path + name: token + schema: + type: string + required: true + description: a valid API token + example: 6d03a630-86fd-4515-9a35-e957502f4f89 + responses: + '200': + description: successfully deleted user token + content: + application/json: + schema: + type: object + properties: + status: + $ref: ../../../../components/schemas/Status.yaml#/Status + response: + type: object \ No newline at end of file