Skip to content

Commit 48bdc9c

Browse files
committed
wip update api docs
1 parent b33d072 commit 48bdc9c

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

docs/api/schemas/patchwork.j2

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,9 +1250,13 @@ paths:
12501250
- series
12511251
{% if version >= (1, 4) %}
12521252
patch:
1253-
summary: Link both series.
1253+
summary: Link series to set a relationship between them
12541254
description: |
1255-
Apply a partial update to a Series
1255+
Apply a partial update to a Series, where only a few fields of the model are allowed:
1256+
- previous_series: Set the provided series as coming before the one specified by the id;
1257+
- subsequent_series: Set the provided series as coming after the one specified by the id;
1258+
- required_series: Set the provided series as requirements for one specified by the id;
1259+
- required_by_series: Set the series specified by the id as a requirement for the provided ones.
12561260
operationId: series_link
12571261
responses:
12581262
'200':
@@ -2734,8 +2738,29 @@ components:
27342738
readOnly: true
27352739
uniqueItems: true
27362740
{% if version >= (1, 4) %}
2737-
related_series:
2738-
title: Related series
2741+
previous_series:
2742+
title: Previous series
2743+
type: array
2744+
items:
2745+
$ref: '#/components/schemas/Series'
2746+
readOnly: true
2747+
uniqueItems: true
2748+
subsequent_series:
2749+
title: Subsequent series
2750+
type: array
2751+
items:
2752+
$ref: '#/components/schemas/Series'
2753+
readOnly: true
2754+
uniqueItems: true
2755+
required_series:
2756+
title: Required series
2757+
type: array
2758+
items:
2759+
$ref: '#/components/schemas/Series'
2760+
readOnly: true
2761+
uniqueItems: true
2762+
required_by_series:
2763+
title: Required by series
27392764
type: array
27402765
items:
27412766
$ref: '#/components/schemas/Series'

0 commit comments

Comments
 (0)