From: Stephen Finucane <stephen@that.guru>
Date: Fri, 26 Oct 2018 21:17:12 +0000 (+0100)
Subject: docs: Document the '/patch/{id}/comments' resource
X-Git-Tag: v2.2.0-rc1~185
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2c64cf11257883fc23ed3c6531692dfa70e34d13;p=thirdparty%2Fpatchwork.git

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 931280f0..5e48d5c8 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.