aboutsummaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2020-04-16 14:03:54 +0100
committerStephen Finucane <stephen@that.guru>2020-04-18 11:57:28 +0100
commitc3d73a00536ff92e65639b912eaeddd462b7cbc3 (patch)
tree6c4c1b32aec34d7412639426909ca737d4cf400a /docs/api
parent6bd33cbd72eacf630e603d1e5b5ce266452fc2cb (diff)
downloadpatchwork-c3d73a00536ff92e65639b912eaeddd462b7cbc3.tar
patchwork-c3d73a00536ff92e65639b912eaeddd462b7cbc3.tar.gz
docs: Resolve issues with 'relations'
Two issues here: - 'PATCH /patches/{id}' and 'PUT /patches/{id}' expect a list of integers on the 'related' field - not strings - 'GET /patches' and 'GET /patches/{id}' return a list of embedded patch objects on the 'related' field - not strings Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/schemas/latest/patchwork.yaml4
-rw-r--r--docs/api/schemas/patchwork.j24
-rw-r--r--docs/api/schemas/v1.2/patchwork.yaml4
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index 9fcafd0..20ca90e 100644
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/patchwork.yaml
@@ -1887,7 +1887,7 @@ components:
title: Relations
type: array
items:
- type: string
+ $ref: '#/components/schemas/PatchEmbedded'
PatchDetail:
allOf:
- $ref: '#/components/schemas/PatchList'
@@ -1948,7 +1948,7 @@ components:
title: Relations
type: array
items:
- type: string
+ type: integer
Person:
type: object
properties:
diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index e587cd7..1ec3848 100644
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -1964,7 +1964,7 @@ components:
title: Relations
type: array
items:
- type: string
+ $ref: '#/components/schemas/PatchEmbedded'
{% endif %}
PatchDetail:
allOf:
@@ -2027,7 +2027,7 @@ components:
title: Relations
type: array
items:
- type: string
+ type: integer
{% endif %}
Person:
type: object
diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index 9bab378..6545493 100644
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -1887,7 +1887,7 @@ components:
title: Relations
type: array
items:
- type: string
+ $ref: '#/components/schemas/PatchEmbedded'
PatchDetail:
allOf:
- $ref: '#/components/schemas/PatchList'
@@ -1948,7 +1948,7 @@ components:
title: Relations
type: array
items:
- type: string
+ type: integer
Person:
type: object
properties: