aboutsummaryrefslogtreecommitdiff
path: root/docs/api/schemas/v1.2
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2020-04-15 23:36:59 +0100
committerStephen Finucane <stephen@that.guru>2020-04-18 11:57:28 +0100
commit2047107468a1d78daf2e917ddce1253b38ea23ea (patch)
tree0677aefee680ff31665c41a9c95b1ae61f7a9ab9 /docs/api/schemas/v1.2
parent11131063b49b81d86cf51a8c2704370997db3d38 (diff)
downloadpatchwork-2047107468a1d78daf2e917ddce1253b38ea23ea.tar
patchwork-2047107468a1d78daf2e917ddce1253b38ea23ea.tar.gz
docs: Resolve issues with 'patches'
Four issues to resolve: - The 'tags' field is a key-value mapping, not an array. - Each header in the 'headers' field can be either a string or a list value. - Errors are reported as a mapping of the field name to an array of errors, not a string. - The security type information isn't complete and doesn't account for security types. Skip it for now. 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.yaml116
1 files changed, 65 insertions, 51 deletions
diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index 8166840..aac7032 100644
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -76,9 +76,9 @@ paths:
post:
description: Create a bundle.
operationId: bundles_create
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/Bundle'
responses:
@@ -132,9 +132,9 @@ paths:
patch:
description: Update a bundle (partial).
operationId: bundles_partial_update
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/Bundle'
responses:
@@ -167,9 +167,9 @@ paths:
put:
description: Update a bundle.
operationId: bundles_update
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/Bundle'
responses:
@@ -519,9 +519,9 @@ paths:
patch:
description: Update a patch (partial).
operationId: patches_partial_update
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -560,9 +560,9 @@ paths:
put:
description: Update a patch.
operationId: patches_update
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -700,9 +700,9 @@ paths:
post:
description: Create a check.
operationId: checks_create
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
@@ -770,9 +770,9 @@ paths:
get:
description: List people.
operationId: people_list
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
@@ -810,9 +810,9 @@ paths:
get:
description: Show a person.
operationId: people_read
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
responses:
'200':
description: ''
@@ -887,9 +887,9 @@ paths:
patch:
description: Update a project (partial).
operationId: projects_partial_update
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -922,9 +922,9 @@ paths:
put:
description: Update a project.
operationId: projects_update
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -1022,9 +1022,9 @@ paths:
get:
description: List users.
operationId: users_list
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
@@ -1062,9 +1062,9 @@ paths:
get:
description: Show a user.
operationId: users_read
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
responses:
'200':
description: ''
@@ -1089,9 +1089,9 @@ paths:
patch:
description: Update a user (partial).
operationId: users_partial_update
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/User'
responses:
@@ -1124,9 +1124,9 @@ paths:
put:
description: Update a user.
operationId: users_update
- security:
- - basicAuth: []
- - apiKeyAuth: []
+# security:
+# - basicAuth: []
+# - apiKeyAuth: []
requestBody:
$ref: '#/components/requestBodies/User'
responses:
@@ -1871,8 +1871,8 @@ components:
readOnly: true
tags:
title: Tags
- type: array
- items:
+ type: object
+ additionalProperties:
type: string
readOnly: true
related:
@@ -1886,9 +1886,15 @@ components:
- properties:
headers:
title: Headers
- type: array
- items:
- type: string
+ anyOf:
+ - type: object
+ additionalProperties:
+ type: array
+ items:
+ type: string
+ - type: object
+ additionalProperties:
+ type: string
readOnly: true
content:
title: Content
@@ -2532,19 +2538,27 @@ components:
properties:
state:
title: State
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
delegate:
title: Delegate
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
commit_ref:
title: Commit ref
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
archived:
title: Archived
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
ErrorProjectUpdate:
type: object