Compare commits

...

1 Commits

Author SHA1 Message Date
Julian Lam
bfdbcddd51 docs: fix openapi spec to include fullname and displayname where necessary
I am not certain when this mismatch started, why it happened, or why our tests did not catch it, because tests currently pass on `develop` branch.

However they do not pass on my local machine, and these changes fix it. Let's see if it blows up tests via our github ci pipeline...
2023-04-13 14:37:42 -04:00
2 changed files with 24 additions and 11 deletions

View File

@@ -546,10 +546,6 @@ UserObjectSlim:
type: string type: string
description: A friendly name for a given user account description: A friendly name for a given user account
example: Dragon Fruit example: Dragon Fruit
displayname:
type: string
description: This is either username or fullname depending on forum and user settings
example: Dragon Fruit
userslug: userslug:
type: string type: string
description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.)
@@ -598,6 +594,14 @@ UserObjectSlim:
type: number type: number
description: A UNIX timestamp representing the moment the user's account was created description: A UNIX timestamp representing the moment the user's account was created
example: 1585337827953 example: 1585337827953
fullname:
type: string
example: Mr. Dragon Fruit Jr.
nullable: true
displayname:
type: string
description: This is either username or fullname depending on forum and user settings
example: Dragon Fruit
'icon:text': 'icon:text':
type: string type: string
description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar
@@ -631,10 +635,6 @@ UserObjectACP:
type: string type: string
description: A friendly name for a given user account description: A friendly name for a given user account
example: Dragon Fruit example: Dragon Fruit
displayname:
type: string
description: This is either username or fullname depending on forum and user settings
example: Dragon Fruit
userslug: userslug:
type: string type: string
description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.) description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.)
@@ -675,6 +675,14 @@ UserObjectACP:
type: number type: number
description: Whether the user has confirmed their email address or not description: Whether the user has confirmed their email address or not
example: 1 example: 1
fullname:
type: string
example: Mr. Dragon Fruit Jr.
nullable: true
displayname:
type: string
description: This is either username or fullname depending on forum and user settings
example: Dragon Fruit
'icon:text': 'icon:text':
type: string type: string
description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar description: A single-letter representation of a username. This is used in the auto-generated icon given to users without an avatar

View File

@@ -38,9 +38,6 @@ get:
username: username:
type: string type: string
description: A friendly name for a given user account 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: userslug:
type: string type: string
description: An URL-safe variant of the username (i.e. lower-cased, spaces description: An URL-safe variant of the username (i.e. lower-cased, spaces
@@ -69,6 +66,14 @@ get:
type: number type: number
description: A UNIX timestamp representing the moment the user's account was description: A UNIX timestamp representing the moment the user's account was
created created
fullname:
type: string
example: Mr. Dragon Fruit Jr.
nullable: true
displayname:
type: string
description: This is either username or fullname depending on forum and user settings
example: Dragon Fruit
icon:text: icon:text:
type: string type: string
description: A single-letter representation of a username. This is used in the description: A single-letter representation of a username. This is used in the