fix(API): Add missing branch parameter to job comment endpoints #STRI…

…NGS-988 (#724)
phrase · Dec 9, 2024 · 64d399c · 64d399c
1 parent 26a798c
commit 64d399c
Show file tree

Hide file tree

Showing 10 changed files with 46 additions and 78 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
@@ -4848,6 +4848,15 @@
           "type": "string"
         }
       },
+      "branch": {
+        "name": "branch",
+        "in": "query",
+        "description": "Branch to use",
+        "schema": {
+          "type": "string"
+        },
+        "example": "my-feature-branch"
+      },
       "page": {
         "in": "query",
         "name": "page",
@@ -16903,13 +16912,7 @@
             "$ref": "#/components/parameters/per_page"
           },
           {
-            "description": "specify the branch to use",
-            "example": "my-feature-branch",
-            "name": "branch",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            }
+            "$ref": "#/components/parameters/branch"
           }
         ],
         "responses": {
@@ -17116,13 +17119,7 @@
             "$ref": "#/components/parameters/id"
           },
           {
-            "description": "specify the branch to use",
-            "example": "my-feature-branch",
-            "name": "branch",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            }
+            "$ref": "#/components/parameters/branch"
           }
         ],
         "responses": {
@@ -17318,13 +17315,7 @@
             "$ref": "#/components/parameters/id"
           },
           {
-            "description": "specify the branch to use",
-            "example": "my-feature-branch",
-            "name": "branch",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            }
+            "$ref": "#/components/parameters/branch"
           }
         ],
         "responses": {
@@ -26846,13 +26837,7 @@
             "$ref": "#/components/parameters/id"
           },
           {
-            "description": "specify the branch to use",
-            "example": "my-feature-branch",
-            "name": "branch",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            }
+            "$ref": "#/components/parameters/branch"
           }
         ],
         "responses": {
@@ -26974,6 +26959,11 @@
                     "description": "Comment message",
                     "type": "string",
                     "example": "Some message..."
+                  },
+                  "branch": {
+                    "description": "Branch name for the job",
+                    "type": "string",
+                    "example": "my-feature-branch"
                   }
                 }
               }
@@ -27003,13 +26993,7 @@
             "$ref": "#/components/parameters/id"
           },
           {
-            "description": "specify the branch to use",
-            "example": "my-feature-branch",
-            "name": "branch",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            }
+            "$ref": "#/components/parameters/branch"
           }
         ],
         "responses": {
@@ -27058,13 +27042,7 @@
             "$ref": "#/components/parameters/job_id"
           },
           {
-            "description": "specify the branch to use",
-            "example": "my-feature-branch",
-            "name": "branch",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            }
+            "$ref": "#/components/parameters/branch"
           },
           {
             "description": "Order direction. Can be one of: asc, desc.",
@@ -27201,6 +27179,11 @@
                     "description": "Job comment message",
                     "type": "string",
                     "example": "Some message..."
+                  },
+                  "branch": {
+                    "description": "Branch name for the job",
+                    "type": "string",
+                    "example": "my-feature-branch"
                   }
                 }
               }

diff --git a/parameters.yaml b/parameters.yaml
@@ -207,6 +207,13 @@ tag:
   required: false
   schema:
     type: string
+branch:
+  name: branch
+  in: query
+  description: Branch to use
+  schema:
+    type: string
+  example: my-feature-branch
 page:
   in: query
   name: page

diff --git a/paths/job_comments/create.yaml b/paths/job_comments/create.yaml
@@ -55,4 +55,8 @@ requestBody:
             description: Job comment message
             type: string
             example: Some message...
+          branch:
+            description: Branch name for the job
+            type: string
+            example: my-feature-branch
 x-cli-version: '2.5'
diff --git a/paths/job_comments/destroy.yaml b/paths/job_comments/destroy.yaml
@@ -9,12 +9,7 @@ parameters:
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/job_id"
 - "$ref": "../../parameters.yaml#/id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
+- "$ref": "../../parameters.yaml#/branch"
 responses:
   '204':
     "$ref": "../../responses.yaml#/204"

diff --git a/paths/job_comments/index.yaml b/paths/job_comments/index.yaml
@@ -8,12 +8,7 @@ parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/job_id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
+- "$ref": "../../parameters.yaml#/branch"
 - description: 'Order direction. Can be one of: asc, desc.'
   name: order
   in: query

diff --git a/paths/job_comments/show.yaml b/paths/job_comments/show.yaml
@@ -9,12 +9,7 @@ parameters:
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/job_id"
 - "$ref": "../../parameters.yaml#/id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
+- "$ref": "../../parameters.yaml#/branch"
 responses:
   '200':
     description: OK

diff --git a/paths/job_comments/update.yaml b/paths/job_comments/update.yaml
@@ -57,4 +57,8 @@ requestBody:
             description: Comment message
             type: string
             example: Some message...
+          branch:
+            description: Branch name for the job
+            type: string
+            example: my-feature-branch
 x-cli-version: '2.5'
diff --git a/paths/job_locales/destroy.yaml b/paths/job_locales/destroy.yaml
@@ -9,12 +9,7 @@ parameters:
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/job_id"
 - "$ref": "../../parameters.yaml#/id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
+- "$ref": "../../parameters.yaml#/branch"
 responses:
   '204':
     "$ref": "../../responses.yaml#/204"

diff --git a/paths/job_locales/index.yaml b/paths/job_locales/index.yaml
@@ -10,12 +10,7 @@ parameters:
 - "$ref": "../../parameters.yaml#/job_id"
 - "$ref": "../../parameters.yaml#/page"
 - "$ref": "../../parameters.yaml#/per_page"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
+- "$ref": "../../parameters.yaml#/branch"
 responses:
   '200':
     description: OK

diff --git a/paths/job_locales/show.yaml b/paths/job_locales/show.yaml
@@ -9,12 +9,7 @@ parameters:
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/job_id"
 - "$ref": "../../parameters.yaml#/id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
+- "$ref": "../../parameters.yaml#/branch"
 responses:
   '200':
     description: OK