docs: Document the '/patch/{id}/comments' resource

Signed-off-by: Stephen Finucane <stephen@that.guru>

diff --git a/docs/api/schemas/patchwork.yaml b/docs/api/schemas/patchwork.yaml
index 931280f0ced7f6460bdb16002945ed15d804ab71..5e48d5c84cb947804ad4d9fef7655b7ef3afcbaa 100644 (file)
--- 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.