aboutsummaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2020-04-16 10:02:36 +0100
committerStephen Finucane <stephen@that.guru>2020-04-18 11:57:28 +0100
commitd9d8968c7c6afbbdac1fb81c34a08bc2dc6e6b8b (patch)
treec32ff315a58e46cd0259585ccff9779f1a0e1b3c /docs/api
parent9da843141155c1f0835f671bc473e7c7424244e3 (diff)
downloadpatchwork-d9d8968c7c6afbbdac1fb81c34a08bc2dc6e6b8b.tar
patchwork-d9d8968c7c6afbbdac1fb81c34a08bc2dc6e6b8b.tar.gz
docs: Resolve issues with 'patches'
Two issues: - Errors are reported as a mapping of the field name to an array of errors, not a string. - We were attempting to validate an invalid request. Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/schemas/latest/patchwork.yaml16
-rw-r--r--docs/api/schemas/patchwork.j216
-rw-r--r--docs/api/schemas/v1.0/patchwork.yaml16
-rw-r--r--docs/api/schemas/v1.1/patchwork.yaml16
-rw-r--r--docs/api/schemas/v1.2/patchwork.yaml16
5 files changed, 60 insertions, 20 deletions
diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index 0ebcbf4..794140a 100644
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/patchwork.yaml
@@ -2532,19 +2532,27 @@ components:
properties:
state:
title: State
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
target_url:
title: Target URL
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
context:
title: Context
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
description:
title: Description
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
ErrorPatchUpdate:
type: object
diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index 56ecd83..867add9 100644
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -2634,19 +2634,27 @@ components:
properties:
state:
title: State
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
target_url:
title: Target URL
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
context:
title: Context
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
description:
title: Description
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
ErrorPatchUpdate:
type: object
diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml
index 680d4d6..b697ce9 100644
--- a/docs/api/schemas/v1.0/patchwork.yaml
+++ b/docs/api/schemas/v1.0/patchwork.yaml
@@ -2153,19 +2153,27 @@ components:
properties:
state:
title: State
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
target_url:
title: Target URL
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
context:
title: Context
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
description:
title: Description
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
ErrorPatchUpdate:
type: object
diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml
index d5e441f..45790c8 100644
--- a/docs/api/schemas/v1.1/patchwork.yaml
+++ b/docs/api/schemas/v1.1/patchwork.yaml
@@ -2237,19 +2237,27 @@ components:
properties:
state:
title: State
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
target_url:
title: Target URL
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
context:
title: Context
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
description:
title: Description
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
ErrorPatchUpdate:
type: object
diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index a6b811f..e02c612 100644
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -2532,19 +2532,27 @@ components:
properties:
state:
title: State
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
target_url:
title: Target URL
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
context:
title: Context
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
description:
title: Description
- type: string
+ type: array
+ items:
+ type: string
readOnly: true
ErrorPatchUpdate:
type: object