diff options
| author | Stephen Finucane <stephen@that.guru> | 2018-10-26 22:16:04 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2018-12-22 17:19:07 +0000 |
| commit | ee2ef8e5c49c7de1f2d09a1196e3ac3a7c7432ef (patch) | |
| tree | 379ecc7674b1dd858b45e7b4cf429fdc04f35aef /docs/api | |
| parent | adb749056ec8ebc4aecffb0d30b69d4c01a13b92 (diff) | |
| download | patchwork-ee2ef8e5c49c7de1f2d09a1196e3ac3a7c7432ef.tar patchwork-ee2ef8e5c49c7de1f2d09a1196e3ac3a7c7432ef.tar.gz | |
docs: Document the '/covers/{id}/comments' resource
Our first nested resource. Nothing too weird here though, save for the
raising of a HTTP 404 on a list resource (due to a missing patch).
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/schemas/patchwork.yaml | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/api/schemas/patchwork.yaml b/docs/api/schemas/patchwork.yaml index b533424..931280f 100644 --- a/docs/api/schemas/patchwork.yaml +++ b/docs/api/schemas/patchwork.yaml @@ -163,6 +163,42 @@ paths: $ref: '#/components/schemas/Error' tags: - covers + /api/covers/{id}/comments/: + get: + description: List comments + operationId: cover_comments_list + parameters: + - in: path + name: id + required: true + schema: + description: '' + title: '' + type: string + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + responses: + '200': + description: '' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Comment' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - comments /api/patches/: get: description: List patches. @@ -941,6 +977,49 @@ components: type: string format: uri readOnly: true + Comment: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + msgid: + title: Message ID + type: string + readOnly: true + minLength: 1 + maxLength: 255 + date: + title: Date + type: string + format: iso8601 + readOnly: true + subject: + title: Subject + type: string + readOnly: true + submitter: + type: object + title: Submitter + allOf: + - $ref: '#/components/schemas/PersonEmbedded' + content: + title: Content + type: string + readOnly: true + minLength: 1 + headers: + title: Headers + type: array + items: + type: string + readOnly: true CoverLetterList: type: object properties: |