aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2018-10-26 22:17:12 +0100
committerStephen Finucane <stephen@that.guru>2018-12-22 17:19:07 +0000
commit2c64cf11257883fc23ed3c6531692dfa70e34d13 (patch)
treee0a3f4e71bd9f44dddc28d012e48d8fcbf163edb /docs
parentee2ef8e5c49c7de1f2d09a1196e3ac3a7c7432ef (diff)
downloadpatchwork-2c64cf11257883fc23ed3c6531692dfa70e34d13.tar
patchwork-2c64cf11257883fc23ed3c6531692dfa70e34d13.tar.gz
docs: Document the '/patch/{id}/comments' resource
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs')
-rw-r--r--docs/api/schemas/patchwork.yaml36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/api/schemas/patchwork.yaml b/docs/api/schemas/patchwork.yaml
index 931280f..5e48d5c 100644
--- a/docs/api/schemas/patchwork.yaml
+++ b/docs/api/schemas/patchwork.yaml
@@ -373,6 +373,42 @@ paths:
$ref: '#/components/schemas/Error'
tags:
- patches
+ /api/patches/{id}/comments/:
+ get:
+ description: List comments
+ operationId: patch_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/people/:
get:
description: List people.