[PATCH 14/17] docs: Document the '/patch/{patchID}/comments' resource
Stephen Finucane
stephen at that.guru
Tue Oct 30 22:19:13 AEDT 2018
Signed-off-by: Stephen Finucane <stephen at that.guru>
---
docs/api/schemas/patchwork.yaml | 34 +++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/docs/api/schemas/patchwork.yaml b/docs/api/schemas/patchwork.yaml
index d9044624..bb66c8a9 100644
--- a/docs/api/schemas/patchwork.yaml
+++ b/docs/api/schemas/patchwork.yaml
@@ -377,6 +377,40 @@ 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:
+ $ref: '#/components/schemas/CommentList'
+ '404':
+ description: 'Not found'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ tags:
+ - comments
/api/people/:
get:
description: List people.
--
2.17.2
More information about the Patchwork
mailing list