aboutsummaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/schemas/latest/patchwork.yaml39
-rw-r--r--docs/api/schemas/patchwork.j253
-rw-r--r--docs/api/schemas/v1.2/patchwork.yaml39
3 files changed, 119 insertions, 12 deletions
diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index a5e235b..4d660d5 100644
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/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:
diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index 196d784..c2f5ea6 100644
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -1101,7 +1101,11 @@ paths:
content:
application/json:
schema:
+{% if version >= (1, 2) %}
+ $ref: '#/components/schemas/UserDetail'
+{% else %}
$ref: '#/components/schemas/User'
+{% endif %}
'403':
description: Forbidden
content:
@@ -1138,7 +1142,11 @@ paths:
content:
application/json:
schema:
+{% if version >= (1, 2) %}
+ $ref: '#/components/schemas/UserDetail'
+{% else %}
$ref: '#/components/schemas/User'
+{% endif %}
'400':
description: Bad request
content:
@@ -1181,7 +1189,11 @@ paths:
content:
application/json:
schema:
+{% if version >= (1, 2) %}
+ $ref: '#/components/schemas/UserDetail'
+{% else %}
$ref: '#/components/schemas/User'
+{% endif %}
'400':
description: Bad request
content:
@@ -1318,13 +1330,25 @@ components:
content:
application/json:
schema:
+{% if version >= (1, 2) %}
+ $ref: '#/components/schemas/UserDetail'
+{% else %}
$ref: '#/components/schemas/User'
+{% endif %}
multipart/form-data:
schema:
+{% if version >= (1, 2) %}
+ $ref: '#/components/schemas/UserDetail'
+{% else %}
$ref: '#/components/schemas/User'
+{% endif %}
application/x-www-form-urlencoded:
schema:
+{% if version >= (1, 2) %}
+ $ref: '#/components/schemas/UserDetail'
+{% else %}
$ref: '#/components/schemas/User'
+{% endif %}
schemas:
Index:
type: object
@@ -2209,6 +2233,35 @@ components:
format: email
readOnly: true
minLength: 1
+{% if version >= (1, 2) %}
+ UserDetail:
+ 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
+{% endif %}
CheckEmbedded:
type: object
properties:
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:
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-21 23:54:41 +0000