diff options
| author | Stephen Finucane <stephen@that.guru> | 2020-04-16 13:45:28 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2020-04-18 11:57:28 +0100 |
| commit | 6bd33cbd72eacf630e603d1e5b5ce266452fc2cb (patch) | |
| tree | e644c1e786310955e7817d2d143b32a3491f1f04 /docs/api/schemas/patchwork.j2 | |
| parent | d11c8e25b982ebc9697ab725a53585781816bba1 (diff) | |
| download | patchwork-6bd33cbd72eacf630e603d1e5b5ce266452fc2cb.tar patchwork-6bd33cbd72eacf630e603d1e5b5ce266452fc2cb.tar.gz | |
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 <stephen@that.guru>
Diffstat (limited to 'docs/api/schemas/patchwork.j2')
| -rw-r--r-- | docs/api/schemas/patchwork.j2 | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2 index 13cc278..e587cd7 100644 --- a/docs/api/schemas/patchwork.j2 +++ b/docs/api/schemas/patchwork.j2 @@ -390,7 +390,7 @@ paths: schema: type: array items: - oneOf: + anyOf: - $ref: '#/components/schemas/EventCoverCreated' - $ref: '#/components/schemas/EventPatchCreated' - $ref: '#/components/schemas/EventPatchCompleted' @@ -1703,6 +1703,7 @@ components: title: Actor description: The user that caused/created this event. readOnly: true + nullable: true allOf: - $ref: '#/components/schemas/UserEmbedded' {% endif %} @@ -1719,9 +1720,7 @@ components: payload: properties: cover: - title: Cover - type: string - readOnly: true + $ref: '#/components/schemas/CoverLetterEmbedded' EventPatchCreated: allOf: - $ref: '#/components/schemas/EventBase' @@ -1799,13 +1798,9 @@ components: patch: $ref: '#/components/schemas/PatchEmbedded' previous_delegate: - allOf: - - $ref: '#/components/schemas/UserEmbedded' - - title: Previous delegate + $ref: '#/components/schemas/UserEmbedded' current_delegate: - allOf: - - $ref: '#/components/schemas/UserEmbedded' - - title: Current delegate + $ref: '#/components/schemas/UserEmbedded' EventCheckCreated: allOf: - $ref: '#/components/schemas/EventBase' |