diff --git a/public/openapi/components/schemas/TeaserObject.yaml b/public/openapi/components/schemas/TeaserObject.yaml index 93eeafa86e..2018685c1b 100644 --- a/public/openapi/components/schemas/TeaserObject.yaml +++ b/public/openapi/components/schemas/TeaserObject.yaml @@ -1,14 +1,24 @@ TeaserObject: type: object + nullable: true properties: - roomId: + pid: type: number - fromuid: - type: number - content: + url: type: string + uid: + type: number + description: A user identifier timestamp: type: number + tid: + type: number + description: A topic identifier + content: + type: string + sourceContent: + type: string + nullable: true timestampISO: type: string description: An ISO 8601 formatted date string (complementing `timestamp`) @@ -18,15 +28,13 @@ TeaserObject: uid: type: number description: A user identifier - isLocal: - type: boolean - description: Whether the user belongs to the local installation or not. username: type: string description: A friendly name for a given user account displayname: type: string - description: This is either username or fullname depending on forum and user settings + isLocal: + type: boolean userslug: type: string description: An URL-safe variant of the username (i.e. lower-cased, spaces @@ -34,10 +42,6 @@ TeaserObject: picture: nullable: true type: string - status: - type: string - lastonline: - type: number icon:text: type: string description: A single-letter representation of a username. This is used in the @@ -50,6 +54,10 @@ TeaserObject: `icon:text` for the user's auto-generated icon example: "#f44336" - lastonlineISO: - type: string - nullable: true + topic: + type: object + additionalProperties: {} + index: + type: number + required: + - pid \ No newline at end of file diff --git a/public/openapi/read/user/userslug/chats/roomid.yaml b/public/openapi/read/user/userslug/chats/roomid.yaml index 4468d9c0a1..448f350a42 100644 --- a/public/openapi/read/user/userslug/chats/roomid.yaml +++ b/public/openapi/read/user/userslug/chats/roomid.yaml @@ -264,7 +264,60 @@ get: unread: type: boolean teaser: - $ref: ../../../../components/schemas/TeaserObject.yaml#/TeaserObject + type: object + properties: + roomId: + type: number + fromuid: + type: number + content: + type: string + timestamp: + 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 + isLocal: + type: boolean + description: Whether the user belongs to the local installation or not. + username: + type: string + description: A friendly name for a given user account + displayname: + type: string + description: This is either username or fullname depending on forum and user settings + 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 + lastonline: + 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 + nullable: true lastUser: type: object properties: @@ -375,7 +428,58 @@ get: unread: type: boolean teaser: - $ref: ../../../../components/schemas/TeaserObject.yaml#/TeaserObject + type: object + properties: + fromuid: + type: number + content: + type: string + timestamp: + 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 + isLocal: + type: boolean + description: Whether the user belongs to the local installation or not. + username: + type: string + description: A friendly name for a given user account + displayname: + type: string + description: This is either username or fullname depending on forum and user settings + 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 + lastonline: + 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 + nullable: true lastUser: type: object properties: diff --git a/public/openapi/write/chats.yaml b/public/openapi/write/chats.yaml index 5206482565..37204a9b5c 100644 --- a/public/openapi/write/chats.yaml +++ b/public/openapi/write/chats.yaml @@ -47,7 +47,54 @@ get: type: boolean description: Whether or not the chat has unread messages within teaser: - $ref: ../components/schemas/TeaserObject.yaml#/TeaserObject + type: object + nullable: true + properties: + fromuid: + type: number + content: + type: string + timestamp: + type: number + timestampISO: + type: string + user: + type: object + properties: + uid: + type: number + description: A user identifier + username: + type: string + description: A friendly name for a given user account + displayname: + type: string + description: This is either username or fullname depending on forum and user settings + 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 + lastonline: + 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 users: type: array items: