fix(writeapi): more tweaks to schema files

NodeBB · Oct 28, 2020 · b2e9e3e · b2e9e3e
1 parent 9f9e3c1
commit b2e9e3e
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 18 deletions.
diff --git a/public/openapi/write/admin/settings/setting.yaml b/public/openapi/write/admin/settings/setting.yaml
@@ -11,6 +11,24 @@ put:
       required: true
       description: backend id of the setting to update
       example: maximumRelatedTopics
+    - in: path
+      name: value
+      schema:
+        type: string
+      required: true
+      description: the value of the new setting
+      example: 2
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            value:
+              type: string
+              description: the value of the new setting
+              example: 2
   responses:
     '200':
       description: Admin setting updated

diff --git a/public/openapi/write/files.yaml b/public/openapi/write/files.yaml
@@ -13,10 +13,9 @@ delete:
             path:
               type: string
               description: Path to the file (relative to the configured `upload_path`)
+              example: files/test.txt
           required:
             - path
-        example:
-          path: files/uploaded_file.jpg
   responses:
     '200':
       description: File deleted

diff --git a/public/openapi/write/posts/pid/bookmark.yaml b/public/openapi/write/posts/pid/bookmark.yaml
@@ -10,7 +10,7 @@ put:
         type: string
       required: true
       description: a valid post id
-      example: 1
+      example: 2
   responses:
     '200':
       description: Post successfully bookmarked
@@ -36,7 +36,7 @@ delete:
         type: string
       required: true
       description: a valid post id
-      example: 1
+      example: 2
   responses:
     '200':
       description: Post successfully unbookmarked

diff --git a/public/openapi/write/posts/pid/state.yaml b/public/openapi/write/posts/pid/state.yaml
@@ -1,19 +1,19 @@
-put:
+delete:
   tags:
     - posts
-  summary: restore a post
-  description: This operation restores a post.
+  summary: deletes a post
+  description: This operation soft deletes a post.
   parameters:
     - in: path
       name: pid
       schema:
         type: string
       required: true
       description: a valid post id
-      example: 1
+      example: 2
   responses:
     '200':
-      description: Topic successfully restored
+      description: Post successfully deleted
       content:
         application/json:
           schema:
@@ -24,22 +24,22 @@ put:
               response:
                 type: object
                 properties: {}
-delete:
+put:
   tags:
     - posts
-  summary: deletes a post
-  description: This operation soft deletes a post.
+  summary: restore a post
+  description: This operation restores a post.
   parameters:
     - in: path
       name: pid
       schema:
         type: string
       required: true
       description: a valid post id
-      example: 1
+      example: 2
   responses:
     '200':
-      description: Post successfully deleted
+      description: Topic successfully restored
       content:
         application/json:
           schema:

diff --git a/public/openapi/write/posts/pid/vote.yaml b/public/openapi/write/posts/pid/vote.yaml
@@ -10,7 +10,7 @@ put:
         type: string
       required: true
       description: a valid post id
-      example: 1
+      example: 2
   requestBody:
     required: true
     content:
@@ -21,8 +21,7 @@ put:
             delta:
               type: number
               description: Positive integer for upvote, negative integer for downvote (0 to unvote.)
-        example:
-          delta: 1
+              example: 1
   responses:
     '200':
       description: Post successfully upvoted
@@ -41,6 +40,14 @@ delete:
     - posts
   summary: unvote a post
   description: This operation removes a pre-cast vote on a post.
+  parameters:
+    - in: path
+      name: pid
+      schema:
+        type: string
+      required: true
+      description: a valid post id
+      example: 2
   responses:
     '200':
       description: Post successfully unvoted

diff --git a/public/openapi/write/topics/tid.yaml b/public/openapi/write/topics/tid.yaml
@@ -51,7 +51,7 @@ delete:
         type: string
       required: true
       description: a valid topic id
-      example: 2
+      example: 3
   responses:
     '200':
       description: Topic successfully purged