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>

diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index 8d5acddba7ee9c702be625b5f02228f3d209d75e..0ebcbf4eb518d4e724df0b0b8cbf9f5e21c8b666 100644 (file)
--- 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 98ca16cc644a6d52d1949cdfeb098e1f3cea9d4b..56ecd83efaa167c73196bf29928db899c50596a9 100644 (file)
--- 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 a2b1b858feb796b01c308f5a6a4bfcca75556569..680d4d6ef1d0424cea7fff9798b728d22e7f2e86 100644 (file)
--- 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 dcec32efc6123902091dfce940b3e525a7b66288..d5e441f3d7379edfdf044e7f9b32b53af49875a8 100644 (file)
--- 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 0007cd265f464ad6c7b5af20a2ed84303ecd94f9..a6b811f02ce8421a7fe765be09a349c8ccd6d9e8 100644 (file)
--- 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

diff --git a/patchwork/tests/utils.py b/patchwork/tests/utils.py
index 7759c8f37a300144e47780a8095e27a3e1d9ea58..1a7baa285a99588d690ccc394b64749daa474ad3 100644 (file)
--- a/patchwork/tests/utils.py
+++ b/patchwork/tests/utils.py
@@ -228,7 +228,7 @@ def create_cover(**kwargs):
         'msgid': make_msgid(),
         'name': 'testpatch%d' % num,
         'headers': '',
-        'content': '',
+        'content': 'foo',
     }
     values.update(kwargs)