aboutsummaryrefslogtreecommitdiff
path: root/docs/api/schemas/v1.2
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2019-11-30 18:48:36 +0000
committerStephen Finucane <stephen@that.guru>2019-12-24 11:15:21 +0000
commitcd3a2ce81ae4595fceb82edd43488f6f2422371e (patch)
tree372bcdb29cf5f70dcfd9a096ac57abac450fca61 /docs/api/schemas/v1.2
parentcedfaa9e0b449a939a107794cdb2e61d323cc925 (diff)
downloadpatchwork-cd3a2ce81ae4595fceb82edd43488f6f2422371e.tar
patchwork-cd3a2ce81ae4595fceb82edd43488f6f2422371e.tar.gz
REST: Allow configuration of user settings via API
Expose the embedded UserProfile field via the REST API. Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/api/schemas/v1.2')
-rw-r--r--docs/api/schemas/v1.2/patchwork.yaml39
1 files changed, 33 insertions, 6 deletions
diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index d7b4d29..50db73c 100644
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -1092,7 +1092,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/UserSelf'
'403':
description: Forbidden
content:
@@ -1129,7 +1129,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/UserSelf'
'400':
description: Bad request
content:
@@ -1172,7 +1172,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/UserSelf'
'400':
description: Bad request
content:
@@ -1307,13 +1307,13 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/UserSelf'
multipart/form-data:
schema:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/UserSelf'
application/x-www-form-urlencoded:
schema:
- $ref: '#/components/schemas/User'
+ $ref: '#/components/schemas/UserSelf'
schemas:
Index:
type: object
@@ -2165,6 +2165,33 @@ components:
format: email
readOnly: true
minLength: 1
+ UserSelf:
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/User'
+ - type: object
+ properties:
+ settings:
+ type: object
+ properties:
+ send_email:
+ title: Send email
+ description: >
+ Whether Patchwork should send email on your behalf.
+ Only present and configurable for your account.
+ type: boolean
+ items_per_page:
+ title: Items per page
+ description: >
+ Number of items to display per page (web UI).
+ Only present and configurable for your account.
+ type: integer
+ show_ids:
+ title: Show IDs
+ description:
+ Show click-to-copy IDs in the list view (web UI).
+ Only present and configurable for your account.
+ type: boolean
CheckEmbedded:
type: object
properties: