feat(API): Add order param to comment list endpoints (#441)

* Add order param to comment index endpoints * Add compiled doc
phrase · Oct 23, 2023 · 441c9c4 · 441c9c4
1 parent 79b1c3a
commit 441c9c4
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 9 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
@@ -10967,6 +10967,15 @@
                 "type": "string"
               }
             }
+          },
+          {
+            "description": "Order direction. Can be one of: asc, desc.",
+            "name": "order",
+            "in": "query",
+            "example": "desc",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -11010,11 +11019,11 @@
         "x-code-samples": [
           {
             "lang": "Curl",
-            "source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch&filters=unread&query=something&locale_ids=someId\" \\\n  -u USERNAME_OR_ACCESS_TOKEN \\\n  -X GET \\\n  -H 'Content-Type: application/json'"
+            "source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch&filters=unread&query=something&locale_ids=someId&order=desc\" \\\n  -u USERNAME_OR_ACCESS_TOKEN \\\n  -X GET \\\n  -H 'Content-Type: application/json'"
           },
           {
             "lang": "CLI v2",
-            "source": "phrase comments list \\\n--project_id <project_id> \\\n--key_id <key_id> \\\n--branch \"my-feature-branch\" \\\n--filters unread \\\n--query \"Some comment content\" \\\n--locale_ids someId \\\n--access_token <token>"
+            "source": "phrase comments list \\\n--project_id <project_id> \\\n--key_id <key_id> \\\n--branch \"my-feature-branch\" \\\n--filters unread \\\n--order desc \\\n--query \"Some comment content\" \\\n--locale_ids someId \\\n--access_token <token>"
           }
         ],
         "requestBody": {
@@ -11056,6 +11065,11 @@
                       "read",
                       "unread"
                     ]
+                  },
+                  "order": {
+                    "description": "Specify ordering of comments",
+                    "type": "string",
+                    "example": "desc"
                   }
                 }
               }
@@ -11950,6 +11964,15 @@
                 "type": "string"
               }
             }
+          },
+          {
+            "description": "Order direction. Can be one of: asc, desc.",
+            "name": "order",
+            "in": "query",
+            "example": "desc",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -11996,11 +12019,11 @@
         "x-code-samples": [
           {
             "lang": "Curl",
-            "source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies?branch=my-feature-branch&filters=unread&query=something\" \\\n  -u USERNAME_OR_ACCESS_TOKEN \\\n  -X GET \\\n  -H 'Content-Type: application/json'"
+            "source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies?branch=my-feature-branch&filters=unread&query=something&order=desc\" \\\n  -u USERNAME_OR_ACCESS_TOKEN \\\n  -X GET \\\n  -H 'Content-Type: application/json'"
           },
           {
             "lang": "CLI v2",
-            "source": "phrase replies list \\\n--project_id <project_id> \\\n--key_id <key_id> \\\n--comment_id <comment_id> \\\n--branch \"my-feature-branch\" \\\n--filters unread \\\n--query \"Some comment content\" \\\n--access_token <token>"
+            "source": "phrase replies list \\\n--project_id <project_id> \\\n--key_id <key_id> \\\n--comment_id <comment_id> \\\n--branch \"my-feature-branch\" \\\n--filters unread \\\n--order desc \\\n--query \"Some comment content\" \\\n--access_token <token>"
           }
         ],
         "requestBody": {
@@ -12031,6 +12054,11 @@
                       "read",
                       "unread"
                     ]
+                  },
+                  "order": {
+                    "description": "Specify ordering of comments",
+                    "type": "string",
+                    "example": "desc"
                   }
                 }
               }
@@ -24164,6 +24192,15 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "description": "Order direction. Can be one of: asc, desc.",
+            "name": "order",
+            "in": "query",
+            "example": "desc",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -24207,11 +24244,11 @@
         "x-code-samples": [
           {
             "lang": "Curl",
-            "source": "curl \"https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/comments?branch=my-feature-branch\" \\\n  -u USERNAME_OR_ACCESS_TOKEN"
+            "source": "curl \"https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/comments?branch=my-feature-branch&order=desc\" \\\n  -u USERNAME_OR_ACCESS_TOKEN"
           },
           {
             "lang": "CLI v2",
-            "source": "phrase job_comments list \\\n--project_id <project_id> \\\n--job_id <key_id> \\\n--branch my-feature-branch \\\n--access_token <token>"
+            "source": "phrase job_comments list \\\n--project_id <project_id> \\\n--job_id <key_id> \\\n--branch my-feature-branch \\\n--order desc \\\n--access_token <token>"
           }
         ],
         "x-cli-version": "2.5"

diff --git a/paths/comment_replies/index.yaml b/paths/comment_replies/index.yaml
@@ -31,6 +31,12 @@ parameters:
     example: [read, unread]
     items:
       type: string
+- description: 'Order direction. Can be one of: asc, desc.'
+  name: order
+  in: query
+  example: desc
+  schema:
+    type: string
 responses:
   '200':
     description: OK
@@ -60,7 +66,7 @@ responses:
 x-code-samples:
 - lang: Curl
   source: |-
-    curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies?branch=my-feature-branch&filters=unread&query=something" \
+    curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:comment_id/replies?branch=my-feature-branch&filters=unread&query=something&order=desc" \
       -u USERNAME_OR_ACCESS_TOKEN \
       -X GET \
       -H 'Content-Type: application/json'
@@ -72,6 +78,7 @@ x-code-samples:
     --comment_id <comment_id> \
     --branch "my-feature-branch" \
     --filters unread \
+    --order desc \
     --query "Some comment content" \
     --access_token <token>
 requestBody:
@@ -96,4 +103,8 @@ requestBody:
             items:
               type: string
             example: [read, unread]
+          order:
+            description: Specify ordering of comments
+            type: string
+            example: desc
 x-cli-version: '2.10'
diff --git a/paths/comments/index.yaml b/paths/comments/index.yaml
@@ -38,6 +38,12 @@ parameters:
     example: [read, unread]
     items:
       type: string
+- description: 'Order direction. Can be one of: asc, desc.'
+  name: order
+  in: query
+  example: desc
+  schema:
+    type: string
 responses:
   '200':
     description: OK
@@ -65,7 +71,7 @@ responses:
 x-code-samples:
 - lang: Curl
   source: |-
-    curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch&filters=unread&query=something&locale_ids=someId" \
+    curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch&filters=unread&query=something&locale_ids=someId&order=desc" \
       -u USERNAME_OR_ACCESS_TOKEN \
       -X GET \
       -H 'Content-Type: application/json'
@@ -76,6 +82,7 @@ x-code-samples:
     --key_id <key_id> \
     --branch "my-feature-branch" \
     --filters unread \
+    --order desc \
     --query "Some comment content" \
     --locale_ids someId \
     --access_token <token>
@@ -107,4 +114,8 @@ requestBody:
             items:
               type: string
             example: [read, unread]
+          order:
+            description: Specify ordering of comments
+            type: string
+            example: desc
 x-cli-version: '2.5'
diff --git a/paths/job_comments/index.yaml b/paths/job_comments/index.yaml
@@ -14,6 +14,12 @@ parameters:
   in: query
   schema:
     type: string
+- description: 'Order direction. Can be one of: asc, desc.'
+  name: order
+  in: query
+  example: desc
+  schema:
+    type: string
 responses:
   '200':
     description: OK
@@ -41,13 +47,14 @@ responses:
 x-code-samples:
 - lang: Curl
   source: |-
-    curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/comments?branch=my-feature-branch" \
+    curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/comments?branch=my-feature-branch&order=desc" \
       -u USERNAME_OR_ACCESS_TOKEN
 - lang: CLI v2
   source: |-
     phrase job_comments list \
     --project_id <project_id> \
     --job_id <key_id> \
     --branch my-feature-branch \
+    --order desc \
     --access_token <token>
 x-cli-version: '2.5'