Skip to content

Commit 6bd33cb

Browse files
stephenfinstephenfin
committed
docs: Resolve issues with 'events'
Four things to change here: - The response is any array that can contain any type of event, not one of them. - The 'actor' field is nullable. - The 'cover' field of the 'cover-created' event is an embedded cover letter, not a string. - The specifications for the 'current_delegate' and 'previous_delegate' fields of the 'patch-delegated' field were apparently invalid. Signed-off-by: Stephen Finucane <[email protected]>
1 parent d11c8e2 commit 6bd33cb

File tree

6 files changed

+28
-51
lines changed

6 files changed

+28
-51
lines changed

‎docs/api/schemas/latest/patchwork.yaml‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ paths:
379379
schema:
380380
type: array
381381
items:
382-
oneOf:
382+
anyOf:
383383
- $ref: '#/components/schemas/EventCoverCreated'
384384
- $ref: '#/components/schemas/EventPatchCreated'
385385
- $ref: '#/components/schemas/EventPatchCompleted'
@@ -1636,6 +1636,7 @@ components:
16361636
title: Actor
16371637
description: The user that caused/created this event.
16381638
readOnly: true
1639+
nullable: true
16391640
allOf:
16401641
- $ref: '#/components/schemas/UserEmbedded'
16411642
payload:
@@ -1651,9 +1652,7 @@ components:
16511652
payload:
16521653
properties:
16531654
cover:
1654-
title: Cover
1655-
type: string
1656-
readOnly: true
1655+
$ref: '#/components/schemas/CoverLetterEmbedded'
16571656
EventPatchCreated:
16581657
allOf:
16591658
- $ref: '#/components/schemas/EventBase'
@@ -1729,13 +1728,9 @@ components:
17291728
patch:
17301729
$ref: '#/components/schemas/PatchEmbedded'
17311730
previous_delegate:
1732-
allOf:
1733-
- $ref: '#/components/schemas/UserEmbedded'
1734-
- title: Previous delegate
1731+
$ref: '#/components/schemas/UserEmbedded'
17351732
current_delegate:
1736-
allOf:
1737-
- $ref: '#/components/schemas/UserEmbedded'
1738-
- title: Current delegate
1733+
$ref: '#/components/schemas/UserEmbedded'
17391734
EventCheckCreated:
17401735
allOf:
17411736
- $ref: '#/components/schemas/EventBase'

‎docs/api/schemas/patchwork.j2‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ paths:
390390
schema:
391391
type: array
392392
items:
393-
oneOf:
393+
anyOf:
394394
- $ref: '#/components/schemas/EventCoverCreated'
395395
- $ref: '#/components/schemas/EventPatchCreated'
396396
- $ref: '#/components/schemas/EventPatchCompleted'
@@ -1703,6 +1703,7 @@ components:
17031703
title: Actor
17041704
description: The user that caused/created this event.
17051705
readOnly: true
1706+
nullable: true
17061707
allOf:
17071708
- $ref: '#/components/schemas/UserEmbedded'
17081709
{% endif %}
@@ -1719,9 +1720,7 @@ components:
17191720
payload:
17201721
properties:
17211722
cover:
1722-
title: Cover
1723-
type: string
1724-
readOnly: true
1723+
$ref: '#/components/schemas/CoverLetterEmbedded'
17251724
EventPatchCreated:
17261725
allOf:
17271726
- $ref: '#/components/schemas/EventBase'
@@ -1799,13 +1798,9 @@ components:
17991798
patch:
18001799
$ref: '#/components/schemas/PatchEmbedded'
18011800
previous_delegate:
1802-
allOf:
1803-
- $ref: '#/components/schemas/UserEmbedded'
1804-
- title: Previous delegate
1801+
$ref: '#/components/schemas/UserEmbedded'
18051802
current_delegate:
1806-
allOf:
1807-
- $ref: '#/components/schemas/UserEmbedded'
1808-
- title: Current delegate
1803+
$ref: '#/components/schemas/UserEmbedded'
18091804
EventCheckCreated:
18101805
allOf:
18111806
- $ref: '#/components/schemas/EventBase'

‎docs/api/schemas/v1.0/patchwork.yaml‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ paths:
270270
schema:
271271
type: array
272272
items:
273-
oneOf:
273+
anyOf:
274274
- $ref: '#/components/schemas/EventCoverCreated'
275275
- $ref: '#/components/schemas/EventPatchCreated'
276276
- $ref: '#/components/schemas/EventPatchCompleted'
@@ -1440,9 +1440,7 @@ components:
14401440
payload:
14411441
properties:
14421442
cover:
1443-
title: Cover
1444-
type: string
1445-
readOnly: true
1443+
$ref: '#/components/schemas/CoverLetterEmbedded'
14461444
EventPatchCreated:
14471445
allOf:
14481446
- $ref: '#/components/schemas/EventBase'
@@ -1500,13 +1498,9 @@ components:
15001498
patch:
15011499
$ref: '#/components/schemas/PatchEmbedded'
15021500
previous_delegate:
1503-
allOf:
1504-
- $ref: '#/components/schemas/UserEmbedded'
1505-
- title: Previous delegate
1501+
$ref: '#/components/schemas/UserEmbedded'
15061502
current_delegate:
1507-
allOf:
1508-
- $ref: '#/components/schemas/UserEmbedded'
1509-
- title: Current delegate
1503+
$ref: '#/components/schemas/UserEmbedded'
15101504
EventCheckCreated:
15111505
allOf:
15121506
- $ref: '#/components/schemas/EventBase'

‎docs/api/schemas/v1.1/patchwork.yaml‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ paths:
270270
schema:
271271
type: array
272272
items:
273-
oneOf:
273+
anyOf:
274274
- $ref: '#/components/schemas/EventCoverCreated'
275275
- $ref: '#/components/schemas/EventPatchCreated'
276276
- $ref: '#/components/schemas/EventPatchCompleted'
@@ -1465,9 +1465,7 @@ components:
14651465
payload:
14661466
properties:
14671467
cover:
1468-
title: Cover
1469-
type: string
1470-
readOnly: true
1468+
$ref: '#/components/schemas/CoverLetterEmbedded'
14711469
EventPatchCreated:
14721470
allOf:
14731471
- $ref: '#/components/schemas/EventBase'
@@ -1543,13 +1541,9 @@ components:
15431541
patch:
15441542
$ref: '#/components/schemas/PatchEmbedded'
15451543
previous_delegate:
1546-
allOf:
1547-
- $ref: '#/components/schemas/UserEmbedded'
1548-
- title: Previous delegate
1544+
$ref: '#/components/schemas/UserEmbedded'
15491545
current_delegate:
1550-
allOf:
1551-
- $ref: '#/components/schemas/UserEmbedded'
1552-
- title: Current delegate
1546+
$ref: '#/components/schemas/UserEmbedded'
15531547
EventCheckCreated:
15541548
allOf:
15551549
- $ref: '#/components/schemas/EventBase'

‎docs/api/schemas/v1.2/patchwork.yaml‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ paths:
379379
schema:
380380
type: array
381381
items:
382-
oneOf:
382+
anyOf:
383383
- $ref: '#/components/schemas/EventCoverCreated'
384384
- $ref: '#/components/schemas/EventPatchCreated'
385385
- $ref: '#/components/schemas/EventPatchCompleted'
@@ -1636,6 +1636,7 @@ components:
16361636
title: Actor
16371637
description: The user that caused/created this event.
16381638
readOnly: true
1639+
nullable: true
16391640
allOf:
16401641
- $ref: '#/components/schemas/UserEmbedded'
16411642
payload:
@@ -1651,9 +1652,7 @@ components:
16511652
payload:
16521653
properties:
16531654
cover:
1654-
title: Cover
1655-
type: string
1656-
readOnly: true
1655+
$ref: '#/components/schemas/CoverLetterEmbedded'
16571656
EventPatchCreated:
16581657
allOf:
16591658
- $ref: '#/components/schemas/EventBase'
@@ -1729,13 +1728,9 @@ components:
17291728
patch:
17301729
$ref: '#/components/schemas/PatchEmbedded'
17311730
previous_delegate:
1732-
allOf:
1733-
- $ref: '#/components/schemas/UserEmbedded'
1734-
- title: Previous delegate
1731+
$ref: '#/components/schemas/UserEmbedded'
17351732
current_delegate:
1736-
allOf:
1737-
- $ref: '#/components/schemas/UserEmbedded'
1738-
- title: Current delegate
1733+
$ref: '#/components/schemas/UserEmbedded'
17391734
EventCheckCreated:
17401735
allOf:
17411736
- $ref: '#/components/schemas/EventBase'

‎patchwork/tests/api/test_event.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,11 @@ def test_list_filter_category(self):
115115
# There should only be one
116116
self.assertEqual(1, len(resp.data))
117117

118-
resp = self.client.get(self.api_url(), {'category': 'foo-bar'})
118+
resp = self.client.get(
119+
self.api_url(),
120+
{'category': 'foo-bar'},
121+
validate_request=False,
122+
)
119123
self.assertEqual(0, len(resp.data))
120124

121125
def test_list_filter_patch(self):

0 commit comments

Comments
 (0)