diff options
author | Stephen Finucane <stephen@that.guru> | 2020-04-16 00:51:17 +0100 |
---|---|---|
committer | Stephen Finucane <stephen@that.guru> | 2020-04-18 11:57:28 +0100 |
commit | 9da843141155c1f0835f671bc473e7c7424244e3 (patch) | |
tree | e0ddb2a4ae8b9b30924a7707ffa692b520a3f56f | |
parent | cdceccaa939a08190dc438fe3614659c3090aa8e (diff) | |
download | patchwork-9da843141155c1f0835f671bc473e7c7424244e3.tar patchwork-9da843141155c1f0835f671bc473e7c7424244e3.tar.gz |
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>
-rw-r--r-- | docs/api/schemas/latest/patchwork.yaml | 12 | ||||
-rw-r--r-- | docs/api/schemas/patchwork.j2 | 12 | ||||
-rw-r--r-- | docs/api/schemas/v1.0/patchwork.yaml | 12 | ||||
-rw-r--r-- | docs/api/schemas/v1.1/patchwork.yaml | 12 | ||||
-rw-r--r-- | docs/api/schemas/v1.2/patchwork.yaml | 12 | ||||
-rw-r--r-- | patchwork/tests/utils.py | 2 |
6 files changed, 46 insertions, 16 deletions
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 diff --git a/patchwork/tests/utils.py b/patchwork/tests/utils.py index 7759c8f..1a7baa2 100644 --- 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) |