From 6bd33cbd72eacf630e603d1e5b5ce266452fc2cb Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephen@that.guru>
Date: Thu, 16 Apr 2020 13:45:28 +0100
Subject: 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>
---
 docs/api/schemas/v1.2/patchwork.yaml | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)

(limited to 'docs/api/schemas/v1.2')

diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index f2ee2a8..9bab378 100644
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -379,7 +379,7 @@ paths:
               schema:
                 type: array
                 items:
-                  oneOf:
+                  anyOf:
                     - $ref: '#/components/schemas/EventCoverCreated'
                     - $ref: '#/components/schemas/EventPatchCreated'
                     - $ref: '#/components/schemas/EventPatchCompleted'
@@ -1636,6 +1636,7 @@ components:
           title: Actor
           description: The user that caused/created this event.
           readOnly: true
+          nullable: true
           allOf:
             - $ref: '#/components/schemas/UserEmbedded'
         payload:
@@ -1651,9 +1652,7 @@ components:
             payload:
               properties:
                 cover:
-                  title: Cover
-                  type: string
-                  readOnly: true
+                  $ref: '#/components/schemas/CoverLetterEmbedded'
     EventPatchCreated:
       allOf:
         - $ref: '#/components/schemas/EventBase'
@@ -1729,13 +1728,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'
-- 
cgit v1.2.3