Skip to content

Commit

Permalink
feat(api spec): add PatchUser endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
tomcur committed Jan 10, 2024
1 parent 0cc2ffa commit 719fa7d
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -640,6 +640,40 @@ paths:
$ref: "#/components/responses/ErrorRateLimit"
'500':
$ref: "#/components/responses/ErrorInternalServer"
patch:
summary: Patch the user's details.
operationId: patchUserByUsername
security:
- bearerAuth: []
tags:
- users
parameters:
- name: username
in: path
required: true
description: The username of the user to patch the details of.
schema:
type: string
requestBody:
description: The user patch.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PatchUser"
responses:
'200':
description: User details.
content:
application/json:
schema:
$ref: "#/components/schemas/User"
'401':
$ref: "#/components/responses/ErrorUnauthorized"
'429':
$ref: "#/components/responses/ErrorRateLimit"
'500':
$ref: "#/components/responses/ErrorInternalServer"
"/users/{username}/kit-memberships":
get:
summary: Get a user's kit memberships.
Expand Down Expand Up @@ -1268,6 +1302,15 @@ components:
username: douglas
password: hunter2
emailAddress: [email protected]
PatchUser:
type: object
properties:
displayName:
type: string
emailAddress:
type: string
useEmailAddressForGravatar:
type: boolean
AuthUser:
type: object
required:
Expand Down

0 comments on commit 719fa7d

Please sign in to comment.