BREAKING CHANGE: Add missing required params

paths/authorizations/create.yaml

@@ -45,6 +45,8 @@ requestBody:
       schema:
         type: object
         title: authorization/create/parameters
+        required:
+          - note
         properties:
           note:
             description: A note to help you remember what the access is used for.

paths/blacklisted_keys/create.yaml

@@ -48,6 +48,8 @@ requestBody:
       schema:
         type: object
         title: blacklisted_key/create/parameters
+        required:
+          - name
         properties:
           name:
             description: Blocked key name

paths/branches/compare.yaml

@@ -8,12 +8,6 @@ parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/name"
-- description: Name of the branch
-  example: my-branch
-  name: name
-  in: query
-  schema:
-    type: string
 responses:
   '200':
     description: OK
@@ -42,4 +36,16 @@ x-code-samples:
     --name <name> \
     --name my-branch \
     --access_token <token>
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        title: reactions/create/parameters
+        properties:
+          branch:
+            description: Branch name
+            type: string
+            example: my-feature-branch
 x-cli-version: '2.5'

paths/branches/create.yaml

@@ -48,6 +48,8 @@ requestBody:
       schema:
         type: object
         title: branch/create/parameters
+        required:
+          - name
         properties:
           name:
             description: Name of the branch

paths/comment_reactions/create.yaml

@@ -9,18 +9,6 @@ parameters:
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/key_id"
 - "$ref": "../../parameters.yaml#/comment_id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
-- description: specify the emoji for the reaction
-  example: 👍
-  name: emoji
-  in: query
-  schema:
-    type: string
 responses:
   '201':
     description: Created
@@ -59,4 +47,20 @@ x-code-samples:
     --comment_id <comment_id> \
     --data '{"branch":"my-feature-branch", "emoji": "👍"]}' \
     --access_token <token>
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        title: reactions/create/parameters
+        properties:
+          branch:
+            description: specify the branch to use
+            type: string
+            example: my-feature-branch
+          message:
+            description: specify the emoji for the reaction
+            type: string
+            example: 👍
 x-cli-version: '2.9'

paths/comment_replies/create.yaml

@@ -9,18 +9,6 @@ parameters:
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/key_id"
 - "$ref": "../../parameters.yaml#/comment_id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
-- description: specify the message for the comment
-  example: some message...
-  name: message
-  in: query
-  schema:
-    type: string
 responses:
   '201':
     description: Created
@@ -59,4 +47,20 @@ x-code-samples:
     --comment_id <comment_id> \
     --data '{"branch":"my-feature-branch", "message": "Some message..."]}' \
     --access_token <token>
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        title: reply/create/parameters
+        properties:
+          branch:
+            description: specify the branch to use
+            type: string
+            example: my-feature-branch
+          message:
+            description: specify the message for the comment
+            type: string
+            example: some message...
 x-cli-version: '2.10'

paths/comments/create.yaml

@@ -8,20 +8,6 @@ parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/key_id"
-- description: specify the message for the comment
-  example: some message...
-  name: message
-  in: query
-  schema:
-    type: string
-- description: specify the locales for the comment
-  example: someId
-  name: locale_ids
-  in: query
-  schema:
-    type: array
-    items:
-      type: string
 responses:
   '201':
     description: Created
@@ -73,4 +59,9 @@ requestBody:
             description: Comment message
             type: string
             example: Some message...
+          locale_ids:
+            description: Locales for the comment
+            type: array
+            items:
+              type: string
 x-cli-version: '2.5'

paths/distributions/create.yaml

@@ -48,6 +48,8 @@ requestBody:
       schema:
         type: object
         title: distribution/create/parameters
+        required:
+          - name
         properties:
           name:
             description: Name of the distribution

paths/glossaries/create.yaml

@@ -48,6 +48,8 @@ requestBody:
       schema:
         type: object
         title: glossary/create/parameters
+        required:
+          - name
         properties:
           name:
             description: Name of the glossary

paths/glossary_term_translations/create.yaml

@@ -52,6 +52,9 @@ requestBody:
       schema:
         type: object
         title: glossary_term_translation/create/parameters
+        required:
+          - locale_code
+          - content
         properties:
           locale_code:
             description: Identifies the language for this translation

paths/glossary_terms/create.yaml

@@ -50,6 +50,8 @@ requestBody:
       schema:
         type: object
         title: glossary_term/create/parameters
+        required:
+          - term
         properties:
           term:
             description: Glossary term

paths/icu/skeleton.yaml

@@ -1,6 +1,6 @@
 ---
-summary: Build icu skeletons
-description: Returns icu skeletons for multiple locale codes based on a source content.
+summary: Build ICU skeletons
+description: Returns ICU skeletons for multiple locale codes based on a source content.
 operationId: icu/skeleton
 tags:
 - ICU

paths/invitations/create.yaml

@@ -54,6 +54,9 @@ requestBody:
       schema:
         type: object
         title: invitation/create/parameters
+        required:
+          - email
+          - role
         properties:
           email:
             description: The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email.

paths/job_template_locales/destroy.yaml

@@ -9,12 +9,6 @@ parameters:
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/job_template_id"
 - "$ref": "../../parameters.yaml#/job_template_locale_id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
 responses:
   '204':
     "$ref": "../../responses.yaml#/204"
@@ -40,4 +34,16 @@ x-code-samples:
     --job_template_locale_id <job_template_locale_id> \
     --branch my-feature-branch \
     --access_token <token>
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        title: job_template_locale/delete/parameters
+        properties:
+          name:
+            description: Name of the branch
+            type: string
+            example: my-branch
 x-cli-version: '2.5'

paths/jobs/create.yaml

@@ -48,6 +48,8 @@ requestBody:
       schema:
         type: object
         title: job/create/parameters
+        required:
+          - name
         properties:
           branch:
             description: specify the branch to use

paths/jobs/lock.yaml

@@ -8,12 +8,6 @@ parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
 responses:
   '204':
     "$ref": "../../responses.yaml#/204"
@@ -38,4 +32,16 @@ x-code-samples:
     --id <id> \
     --branch my-feature-branch \
     --access_token <token>
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        title: job/lock/parameters
+        properties:
+          name:
+            description: Name of the branch
+            type: string
+            example: my-branch
 x-cli-version: '2.5'

paths/jobs/unlock.yaml

@@ -8,12 +8,6 @@ parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
 - "$ref": "../../parameters.yaml#/project_id"
 - "$ref": "../../parameters.yaml#/id"
-- description: specify the branch to use
-  example: my-feature-branch
-  name: branch
-  in: query
-  schema:
-    type: string
 responses:
   '204':
     "$ref": "../../responses.yaml#/204"
@@ -38,4 +32,16 @@ x-code-samples:
     --id <id> \
     --branch my-feature-branch \
     --access_token <token>
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        title: job/lock/parameters
+        properties:
+          name:
+            description: Name of the branch
+            type: string
+            example: my-branch
 x-cli-version: '2.5'

paths/key_links/index.yaml

@@ -1,5 +1,5 @@
 ---
-summary: Retrieve all child keys linked to a specific parent key
+summary: List child keys of a parent key
 description: Returns detailed information about a parent key, including its linked child keys.
 operationId: key_links/index
 tags:

paths/keys/create.yaml

@@ -55,6 +55,8 @@ requestBody:
       schema:
         type: object
         title: key/create/parameters
+        required:
+          - name
         properties:
           branch:
             description: specify the branch to use
@@ -129,5 +131,5 @@ requestBody:
             example:
               fruit: Apple
               vegetable: Tomato
-            
+
 x-cli-version: '2.5'