From 9da843141155c1f0835f671bc473e7c7424244e3 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephen@that.guru>
Date: Thu, 16 Apr 2020 00:51:17 +0100
Subject: docs: Resolve issues with 'covers'

Two issues to correct:

- Each header in the 'headers' field can be either a string or a list
  value.
- We state that the 'content' field will always have content but our
  tests were configuring otherwise.

Signed-off-by: Stephen Finucane <stephen@that.guru>
---
 docs/api/schemas/latest/patchwork.yaml | 12 +++++++++---
 docs/api/schemas/patchwork.j2          | 12 +++++++++---
 docs/api/schemas/v1.0/patchwork.yaml   | 12 +++++++++---
 docs/api/schemas/v1.1/patchwork.yaml   | 12 +++++++++---
 docs/api/schemas/v1.2/patchwork.yaml   | 12 +++++++++---
 5 files changed, 45 insertions(+), 15 deletions(-)

(limited to 'docs')

diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index 8d5acdd..0ebcbf4 100644
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/patchwork.yaml
@@ -1590,9 +1590,15 @@ components:
         - properties:
             headers:
               title: Headers
-              type: array
-              items:
-                type: string
+              anyOf:
+                - type: object
+                  additionalProperties:
+                    type: array
+                    items:
+                      type: string
+                - type: object
+                  additionalProperties:
+                    type: string
               readOnly: true
             content:
               title: Content
diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index 98ca16c..56ecd83 100644
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -1656,9 +1656,15 @@ components:
         - properties:
             headers:
               title: Headers
-              type: array
-              items:
-                type: string
+              anyOf:
+                - type: object
+                  additionalProperties:
+                    type: array
+                    items:
+                      type: string
+                - type: object
+                  additionalProperties:
+                    type: string
               readOnly: true
             content:
               title: Content
diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml
index a2b1b85..680d4d6 100644
--- a/docs/api/schemas/v1.0/patchwork.yaml
+++ b/docs/api/schemas/v1.0/patchwork.yaml
@@ -1386,9 +1386,15 @@ components:
         - properties:
             headers:
               title: Headers
-              type: array
-              items:
-                type: string
+              anyOf:
+                - type: object
+                  additionalProperties:
+                    type: array
+                    items:
+                      type: string
+                - type: object
+                  additionalProperties:
+                    type: string
               readOnly: true
             content:
               title: Content
diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml
index dcec32e..d5e441f 100644
--- a/docs/api/schemas/v1.1/patchwork.yaml
+++ b/docs/api/schemas/v1.1/patchwork.yaml
@@ -1411,9 +1411,15 @@ components:
         - properties:
             headers:
               title: Headers
-              type: array
-              items:
-                type: string
+              anyOf:
+                - type: object
+                  additionalProperties:
+                    type: array
+                    items:
+                      type: string
+                - type: object
+                  additionalProperties:
+                    type: string
               readOnly: true
             content:
               title: Content
diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index 0007cd2..a6b811f 100644
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -1590,9 +1590,15 @@ components:
         - properties:
             headers:
               title: Headers
-              type: array
-              items:
-                type: string
+              anyOf:
+                - type: object
+                  additionalProperties:
+                    type: array
+                    items:
+                      type: string
+                - type: object
+                  additionalProperties:
+                    type: string
               readOnly: true
             content:
               title: Content
-- 
cgit v1.2.3