diff --git a/doc/compiled.json b/doc/compiled.json index f2fe2987c..a53a9662f 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -4277,16 +4277,7 @@ }, "description": "The child translation keys linked to the parent." } - }, - "required": [ - "created_at", - "updated_at", - "created_by", - "updated_by", - "account", - "parent", - "children" - ] + } } }, "parameters": { @@ -4755,8 +4746,8 @@ "paths": { "/icu/skeleton": { "post": { - "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" @@ -5882,6 +5873,9 @@ "schema": { "type": "object", "title": "styleguide/create/parameters", + "required": [ + "title" + ], "properties": { "title": { "description": "Style guide title", @@ -6804,6 +6798,10 @@ "schema": { "type": "object", "title": "invitation/create/parameters", + "required": [ + "email", + "role" + ], "properties": { "email": { "description": "The email of the invited user. The email can not be updated once created. Create a new invitation for each unique email.", @@ -7537,6 +7535,9 @@ "schema": { "type": "object", "title": "screenshot_marker/create/parameters", + "required": [ + "key_id" + ], "properties": { "branch": { "description": "specify the branch to use", @@ -7666,15 +7667,6 @@ }, { "$ref": "#/components/parameters/screenshot_id" - }, - { - "description": "specify the branch to use", - "example": "my-feature-branch", - "name": "branch", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -7701,6 +7693,24 @@ "source": "phrase screenshot_markers delete \\\n--project_id \\\n--screenshot_id \\\n--branch my-feature-branch \\\n--access_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" } }, @@ -7964,6 +7974,10 @@ "schema": { "type": "object", "title": "locale/create/parameters", + "required": [ + "name", + "code" + ], "properties": { "branch": { "description": "specify the branch to use", @@ -8246,15 +8260,6 @@ }, { "$ref": "#/components/parameters/locale_id_as_id" - }, - { - "description": "specify the branch to use", - "example": "my-feature-branch", - "name": "branch", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -8281,6 +8286,24 @@ "source": "phrase locales delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "locale/delete/parameters", + "properties": { + "name": { + "description": "Name of the branch", + "type": "string", + "example": "my-branch" + } + } + } + } + } + }, "x-cli-version": "2.5" } }, @@ -8655,6 +8678,9 @@ "schema": { "type": "object", "title": "distribution/create/parameters", + "required": [ + "name" + ], "properties": { "name": { "description": "Name of the distribution", @@ -9619,6 +9645,9 @@ "schema": { "type": "object", "title": "job/create/parameters", + "required": [ + "name" + ], "properties": { "branch": { "description": "specify the branch to use", @@ -10279,15 +10308,6 @@ }, { "$ref": "#/components/parameters/id" - }, - { - "description": "specify the branch to use", - "example": "my-feature-branch", - "name": "branch", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -10314,6 +10334,24 @@ "source": "phrase jobs lock \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_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" } }, @@ -10334,15 +10372,6 @@ }, { "$ref": "#/components/parameters/id" - }, - { - "description": "specify the branch to use", - "example": "my-feature-branch", - "name": "branch", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -10369,6 +10398,24 @@ "source": "phrase jobs unlock \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_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" } }, @@ -11064,6 +11111,9 @@ "schema": { "type": "object", "title": "glossary/create/parameters", + "required": [ + "name" + ], "properties": { "name": { "description": "Name of the glossary", @@ -11431,6 +11481,9 @@ "schema": { "type": "object", "title": "authorization/create/parameters", + "required": [ + "note" + ], "properties": { "note": { "description": "A note to help you remember what the access is used for.", @@ -12085,27 +12138,6 @@ }, { "$ref": "#/components/parameters/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": { @@ -12167,6 +12199,13 @@ "description": "Comment message", "type": "string", "example": "Some message..." + }, + "locale_ids": { + "description": "Locales for the comment", + "type": "array", + "items": { + "type": "string" + } } } } @@ -12687,24 +12726,6 @@ }, { "$ref": "#/components/parameters/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": { @@ -12752,6 +12773,29 @@ "source": "phrase reactions create \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--data '{\"branch\":\"my-feature-branch\", \"emoji\": \"👍\"]}' \\\n--access_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" } }, @@ -13083,24 +13127,6 @@ }, { "$ref": "#/components/parameters/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": { @@ -13148,6 +13174,29 @@ "source": "phrase replies create \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--data '{\"branch\":\"my-feature-branch\", \"message\": \"Some message...\"]}' \\\n--access_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" } }, @@ -13995,7 +14044,7 @@ "example": null }, "locale_mapping": { - "description": "Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.", + "description": "Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.", "type": "object", "properties": {}, "example": "{\"en\": \"2\"}" @@ -15108,6 +15157,10 @@ "schema": { "type": "object", "title": "glossary_term_translation/create/parameters", + "required": [ + "locale_code", + "content" + ], "properties": { "locale_code": { "description": "Identifies the language for this translation", @@ -15427,6 +15480,9 @@ "schema": { "type": "object", "title": "project/create/parameters", + "required": [ + "name" + ], "properties": { "name": { "description": "Name of the project", @@ -17036,15 +17092,6 @@ }, { "$ref": "#/components/parameters/job_template_locale_id" - }, - { - "description": "specify the branch to use", - "example": "my-feature-branch", - "name": "branch", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -17071,6 +17118,24 @@ "source": "phrase job_template_locales delete \\\n--project_id \\\n--job_template_id \\\n--job_template_locale_id \\\n--branch my-feature-branch \\\n--access_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" } }, @@ -17564,6 +17629,9 @@ "schema": { "type": "object", "title": "branch/create/parameters", + "required": [ + "name" + ], "properties": { "name": { "description": "Name of the branch", @@ -17858,15 +17926,6 @@ }, { "$ref": "#/components/parameters/name" - }, - { - "description": "Name of the branch", - "example": "my-branch", - "name": "name", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -17904,6 +17963,24 @@ "source": "phrase branches compare \\\n--project_id \\\n--name \\\n--name my-branch \\\n--access_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" } }, @@ -19088,6 +19165,9 @@ "schema": { "type": "object", "title": "glossary_term/create/parameters", + "required": [ + "term" + ], "properties": { "term": { "description": "Glossary term", @@ -19477,16 +19557,19 @@ "schema": { "type": "object", "title": "tag/create/parameters", + "required": [ + "name" + ], "properties": { - "branch": { - "description": "specify the branch to use", - "type": "string", - "example": "my-feature-branch" - }, "name": { "description": "Name of the tag", "type": "string", "example": "my-feature" + }, + "branch": { + "description": "specify the branch to use", + "type": "string", + "example": "my-feature-branch" } } } @@ -19584,15 +19667,6 @@ }, { "$ref": "#/components/parameters/name" - }, - { - "description": "specify the branch to use", - "example": "my-feature-branch", - "name": "branch", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -19619,6 +19693,24 @@ "source": "phrase tags delete \\\n--project_id \\\n--name \\\n--branch my-feature-branch \\\n--access_token " } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "tag/delete/parameters", + "properties": { + "name": { + "description": "Name of the branch", + "type": "string", + "example": "my-branch" + } + } + } + } + } + }, "x-cli-version": "2.5" } }, @@ -19770,6 +19862,9 @@ "schema": { "type": "object", "title": "blacklisted_key/create/parameters", + "required": [ + "name" + ], "properties": { "name": { "description": "Blocked key name", @@ -20156,6 +20251,9 @@ "schema": { "type": "object", "title": "key/create/parameters", + "required": [ + "name" + ], "properties": { "branch": { "description": "specify the branch to use", @@ -20268,33 +20366,6 @@ }, { "$ref": "#/components/parameters/project_id" - }, - { - "description": "specify the branch to use", - "example": "my-feature-branch", - "name": "branch", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n
    \n
  • ids:key_id,... for queries on a comma-separated list of ids
    • \n
  • name:key_name for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes
    • \n
  • tags:tag_name to filter for keys with certain tags
    • \n
  • translated:{true|false} for translation status (also requires locale_id to be specified)
    • \n
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • \n
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • \n
\nFind more examples here.\n", - "example": "mykey* translated:true", - "name": "q", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "description": "Locale used to determine the translation state of a key when filtering for untranslated or translated keys.", - "example": "abcd1234abcd1234abcd1234abcd1234", - "name": "locale_id", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -20339,6 +20410,34 @@ "source": "phrase keys delete-collection \\\n--project_id \\\n--branch my-feature-branch \\\n--query 'mykey* translated:true' \\\n--locale_id abcd1234abcd1234abcd1234abcd1234 \\\n--access_token " } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "key/delete-collection/parameters", + "properties": { + "name": { + "description": "Name of the branch", + "type": "string", + "example": "my-branch" + }, + "locale_id": { + "description": "Locale used to determine the translation state of a key when filtering for untranslated or translated keys", + "type": "string", + "example": "abcd1234abcd1234abcd1234abcd1234" + }, + "q": { + "example": "mykey* translated:true", + "type": "string", + "description": "Specify a query to do broad search for keys by name (including wildcards).

\nThe following qualifiers are also supported in the search term:
\n
    \n
  • ids:key_id,... for queries on a comma-separated list of ids
    • \n
  • name:key_name for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes
    • \n
  • tags:tag_name to filter for keys with certain tags
    • \n
  • translated:{true|false} for translation status (also requires locale_id to be specified)
    • \n
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • \n
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • \n
\nFind more examples here.\n" + } + } + } + } + } + }, "x-cli-version": "2.5" } }, @@ -21261,6 +21360,10 @@ "schema": { "type": "object", "title": "order/create/parameters", + "required": [ + "name", + "lsp" + ], "properties": { "branch": { "description": "specify the branch to use", @@ -21439,15 +21542,6 @@ }, { "$ref": "#/components/parameters/id" - }, - { - "description": "specify the branch to use", - "example": "my-feature-branch", - "name": "branch", - "in": "query", - "schema": { - "type": "string" - } } ], "responses": { @@ -21474,6 +21568,24 @@ "source": "phrase orders delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "order/delete/parameters", + "properties": { + "name": { + "description": "Name of the branch", + "type": "string", + "example": "my-branch" + } + } + } + } + } + }, "x-cli-version": "2.5" } }, @@ -21873,6 +21985,9 @@ "schema": { "type": "object", "title": "space/create/parameters", + "required": [ + "name" + ], "properties": { "name": { "description": "Name of the space", @@ -22213,9 +22328,12 @@ "schema": { "type": "object", "title": "spaces/projects/create/parameters", + "required": [ + "id" + ], "properties": { "id": { - "description": "Project ID to add or to the Space", + "description": "Project ID to add to the Space", "type": "string", "example": "a4b3c2d1" } @@ -22415,6 +22533,9 @@ "schema": { "type": "object", "title": "team/create/parameters", + "required": [ + "name" + ], "properties": { "name": { "description": "Name of the team", @@ -22678,6 +22799,9 @@ "schema": { "type": "object", "title": "teams/projects/create/parameters", + "required": [ + "id" + ], "properties": { "id": { "description": "Project ID to add to the Team", @@ -22802,6 +22926,9 @@ "schema": { "type": "object", "title": "teams/spaces/create/parameters", + "required": [ + "id" + ], "properties": { "id": { "description": "Space ID to add to the Team", @@ -22926,6 +23053,9 @@ "schema": { "type": "object", "title": "teams/users/create/parameters", + "required": [ + "id" + ], "properties": { "id": { "description": "User ID to add to the Team", @@ -23170,14 +23300,13 @@ "schema": { "type": "object", "title": "translation/create/parameters", + "required": [ + "locale_id", + "key_id" + ], "properties": { - "branch": { - "description": "specify the branch to use", - "type": "string", - "example": "my-feature-branch" - }, "locale_id": { - "description": "Locale. Can be the name or public id of the locale. Preferred is the public id.", + "description": "Locale. Can be the name or id of the locale. Preferred is the id", "type": "string", "example": "abcd1234cdef1234abcd1234cdef1234" }, @@ -23186,6 +23315,11 @@ "type": "string", "example": "abcd1234cdef1234abcd1234cdef1234" }, + "branch": { + "description": "Branch name", + "type": "string", + "example": "my-feature-branch" + }, "content": { "description": "Translation content", "type": "string", @@ -26697,7 +26831,7 @@ } }, "get": { - "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": [ diff --git a/paths/authorizations/create.yaml b/paths/authorizations/create.yaml index f6da62d61..ca044d50c 100644 --- a/paths/authorizations/create.yaml +++ b/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. diff --git a/paths/blacklisted_keys/create.yaml b/paths/blacklisted_keys/create.yaml index 4ceb9e151..36dd6c762 100644 --- a/paths/blacklisted_keys/create.yaml +++ b/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 diff --git a/paths/branches/compare.yaml b/paths/branches/compare.yaml index 847f6b290..1f823e850 100644 --- a/paths/branches/compare.yaml +++ b/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 my-branch \ --access_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' diff --git a/paths/branches/create.yaml b/paths/branches/create.yaml index aceca3d0d..849c0e520 100644 --- a/paths/branches/create.yaml +++ b/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 diff --git a/paths/comment_reactions/create.yaml b/paths/comment_reactions/create.yaml index 8589d7115..338bcdc46 100644 --- a/paths/comment_reactions/create.yaml +++ b/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 \ --data '{"branch":"my-feature-branch", "emoji": "👍"]}' \ --access_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' diff --git a/paths/comment_replies/create.yaml b/paths/comment_replies/create.yaml index 70ed06276..7540bd9c6 100644 --- a/paths/comment_replies/create.yaml +++ b/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 \ --data '{"branch":"my-feature-branch", "message": "Some message..."]}' \ --access_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' diff --git a/paths/comments/create.yaml b/paths/comments/create.yaml index ddb6a988e..aa82db5bf 100644 --- a/paths/comments/create.yaml +++ b/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' diff --git a/paths/distributions/create.yaml b/paths/distributions/create.yaml index d033e0e39..07a18ea83 100644 --- a/paths/distributions/create.yaml +++ b/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 diff --git a/paths/glossaries/create.yaml b/paths/glossaries/create.yaml index 76d4fd2d9..a6665413e 100644 --- a/paths/glossaries/create.yaml +++ b/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 diff --git a/paths/glossary_term_translations/create.yaml b/paths/glossary_term_translations/create.yaml index 88a0c398e..368427fb4 100644 --- a/paths/glossary_term_translations/create.yaml +++ b/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 diff --git a/paths/glossary_terms/create.yaml b/paths/glossary_terms/create.yaml index 77fc6cac2..87a03c65b 100644 --- a/paths/glossary_terms/create.yaml +++ b/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 diff --git a/paths/icu/skeleton.yaml b/paths/icu/skeleton.yaml index 2697fdf33..3886e3db7 100644 --- a/paths/icu/skeleton.yaml +++ b/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 diff --git a/paths/invitations/create.yaml b/paths/invitations/create.yaml index e6f3bed8f..0abedf3f0 100644 --- a/paths/invitations/create.yaml +++ b/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 email can not be updated once created. Create a new invitation for each unique email. diff --git a/paths/job_template_locales/destroy.yaml b/paths/job_template_locales/destroy.yaml index e7bf2e9a6..86694987e 100644 --- a/paths/job_template_locales/destroy.yaml +++ b/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 \ --branch my-feature-branch \ --access_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' diff --git a/paths/jobs/create.yaml b/paths/jobs/create.yaml index 5dc2b1050..556d342fb 100644 --- a/paths/jobs/create.yaml +++ b/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 diff --git a/paths/jobs/lock.yaml b/paths/jobs/lock.yaml index 8df5e2f77..ad4e90a3c 100644 --- a/paths/jobs/lock.yaml +++ b/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 \ --branch my-feature-branch \ --access_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' diff --git a/paths/jobs/unlock.yaml b/paths/jobs/unlock.yaml index 3efc47a53..db2182aa6 100644 --- a/paths/jobs/unlock.yaml +++ b/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 \ --branch my-feature-branch \ --access_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' diff --git a/paths/key_links/index.yaml b/paths/key_links/index.yaml index 7ce181bd3..f23044eba 100644 --- a/paths/key_links/index.yaml +++ b/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: diff --git a/paths/keys/create.yaml b/paths/keys/create.yaml index f34057b14..75c73a8e1 100644 --- a/paths/keys/create.yaml +++ b/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' diff --git a/paths/keys/destroy-collection.yaml b/paths/keys/destroy-collection.yaml index e1c37494e..80594fa1e 100644 --- a/paths/keys/destroy-collection.yaml +++ b/paths/keys/destroy-collection.yaml @@ -7,35 +7,6 @@ tags: parameters: - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" - "$ref": "../../parameters.yaml#/project_id" -- description: specify the branch to use - example: my-feature-branch - name: branch - in: query - schema: - type: string -- description: | - Specify a query to do broad search for keys by name (including wildcards).

- The following qualifiers are also supported in the search term:
-
    -
  • ids:key_id,... for queries on a comma-separated list of ids
    • -
  • name:key_name for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes
    • -
  • tags:tag_name to filter for keys with certain tags
    • -
  • translated:{true|false} for translation status (also requires locale_id to be specified)
    • -
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • -
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • -
- Find more examples here. - example: mykey* translated:true - name: q - in: query - schema: - type: string -- description: Locale used to determine the translation state of a key when filtering for untranslated or translated keys. - example: abcd1234abcd1234abcd1234abcd1234 - name: locale_id - in: query - schema: - type: string responses: '200': description: OK @@ -72,4 +43,35 @@ x-code-samples: --query 'mykey* translated:true' \ --locale_id abcd1234abcd1234abcd1234abcd1234 \ --access_token +requestBody: + required: true + content: + application/json: + schema: + type: object + title: key/delete-collection/parameters + properties: + name: + description: Name of the branch + type: string + example: my-branch + locale_id: + description: Locale used to determine the translation state of a key when filtering for untranslated or translated keys + type: string + example: abcd1234abcd1234abcd1234abcd1234 + q: + example: mykey* translated:true + type: string + description: | + Specify a query to do broad search for keys by name (including wildcards).

+ The following qualifiers are also supported in the search term:
+
    +
  • ids:key_id,... for queries on a comma-separated list of ids
    • +
  • name:key_name for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes
    • +
  • tags:tag_name to filter for keys with certain tags
    • +
  • translated:{true|false} for translation status (also requires locale_id to be specified)
    • +
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
    • +
  • unmentioned_in_upload:upload_id to filter keys unmentioned within upload
    • +
+ Find more examples here. x-cli-version: '2.5' diff --git a/paths/locales/create.yaml b/paths/locales/create.yaml index 40c7f42f1..3525b50de 100644 --- a/paths/locales/create.yaml +++ b/paths/locales/create.yaml @@ -48,6 +48,9 @@ requestBody: schema: type: object title: locale/create/parameters + required: + - name + - code properties: branch: description: specify the branch to use diff --git a/paths/locales/destroy.yaml b/paths/locales/destroy.yaml index 888413648..77f39e811 100644 --- a/paths/locales/destroy.yaml +++ b/paths/locales/destroy.yaml @@ -8,12 +8,6 @@ parameters: - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" - "$ref": "../../parameters.yaml#/project_id" - "$ref": "../../parameters.yaml#/locale_id_as_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 \ --branch my-feature-branch \ --access_token +requestBody: + required: true + content: + application/json: + schema: + type: object + title: locale/delete/parameters + properties: + name: + description: Name of the branch + type: string + example: my-branch x-cli-version: '2.5' diff --git a/paths/orders/create.yaml b/paths/orders/create.yaml index 3d3478b28..9b118bc18 100644 --- a/paths/orders/create.yaml +++ b/paths/orders/create.yaml @@ -48,6 +48,9 @@ requestBody: schema: type: object title: order/create/parameters + required: + - name + - lsp properties: branch: description: specify the branch to use diff --git a/paths/orders/destroy.yaml b/paths/orders/destroy.yaml index d30a517c0..33aec9aff 100644 --- a/paths/orders/destroy.yaml +++ b/paths/orders/destroy.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 \ --branch my-feature-branch \ --access_token +requestBody: + required: true + content: + application/json: + schema: + type: object + title: order/delete/parameters + properties: + name: + description: Name of the branch + type: string + example: my-branch x-cli-version: '2.5' diff --git a/paths/projects/create.yaml b/paths/projects/create.yaml index 8dbee1653..945356d64 100644 --- a/paths/projects/create.yaml +++ b/paths/projects/create.yaml @@ -47,6 +47,8 @@ requestBody: schema: type: object title: project/create/parameters + required: + - name properties: name: description: Name of the project diff --git a/paths/screenshot_markers/create.yaml b/paths/screenshot_markers/create.yaml index 711b29e1f..6967a34fc 100644 --- a/paths/screenshot_markers/create.yaml +++ b/paths/screenshot_markers/create.yaml @@ -50,6 +50,8 @@ requestBody: schema: type: object title: screenshot_marker/create/parameters + required: + - key_id properties: branch: description: specify the branch to use diff --git a/paths/screenshot_markers/destroy.yaml b/paths/screenshot_markers/destroy.yaml index 293ad835a..79dcf5096 100644 --- a/paths/screenshot_markers/destroy.yaml +++ b/paths/screenshot_markers/destroy.yaml @@ -8,12 +8,6 @@ parameters: - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" - "$ref": "../../parameters.yaml#/project_id" - "$ref": "../../parameters.yaml#/screenshot_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: --screenshot_id \ --branch my-feature-branch \ --access_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' diff --git a/paths/spaces/add_project.yaml b/paths/spaces/add_project.yaml index cdd65eb49..64fb9616e 100644 --- a/paths/spaces/add_project.yaml +++ b/paths/spaces/add_project.yaml @@ -46,9 +46,11 @@ requestBody: schema: type: object title: spaces/projects/create/parameters + required: + - id properties: id: - description: Project ID to add or to the Space + description: Project ID to add to the Space type: string example: a4b3c2d1 x-cli-version: '2.5' diff --git a/paths/spaces/create.yaml b/paths/spaces/create.yaml index 3dc8529ce..468b4833b 100644 --- a/paths/spaces/create.yaml +++ b/paths/spaces/create.yaml @@ -48,6 +48,8 @@ requestBody: schema: type: object title: space/create/parameters + required: + - name properties: name: description: Name of the space diff --git a/paths/styleguides/create.yaml b/paths/styleguides/create.yaml index f49f66226..3a575c25e 100644 --- a/paths/styleguides/create.yaml +++ b/paths/styleguides/create.yaml @@ -48,6 +48,8 @@ requestBody: schema: type: object title: styleguide/create/parameters + required: + - title properties: title: description: Style guide title diff --git a/paths/tags/create.yaml b/paths/tags/create.yaml index e0938ac75..1e7dab8e3 100644 --- a/paths/tags/create.yaml +++ b/paths/tags/create.yaml @@ -48,13 +48,15 @@ requestBody: schema: type: object title: tag/create/parameters + required: + - name properties: - branch: - description: specify the branch to use - type: string - example: my-feature-branch name: description: Name of the tag type: string example: my-feature + branch: + description: specify the branch to use + type: string + example: my-feature-branch x-cli-version: '2.5' diff --git a/paths/tags/destroy.yaml b/paths/tags/destroy.yaml index 2f9358bac..d84cac959 100644 --- a/paths/tags/destroy.yaml +++ b/paths/tags/destroy.yaml @@ -8,12 +8,6 @@ parameters: - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" - "$ref": "../../parameters.yaml#/project_id" - "$ref": "../../parameters.yaml#/name" -- 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: --name \ --branch my-feature-branch \ --access_token +requestBody: + required: true + content: + application/json: + schema: + type: object + title: tag/delete/parameters + properties: + name: + description: Name of the branch + type: string + example: my-branch x-cli-version: '2.5' diff --git a/paths/teams/add_project.yaml b/paths/teams/add_project.yaml index 5e10deb0d..8adfaacb2 100644 --- a/paths/teams/add_project.yaml +++ b/paths/teams/add_project.yaml @@ -46,6 +46,8 @@ requestBody: schema: type: object title: teams/projects/create/parameters + required: + - id properties: id: description: Project ID to add to the Team diff --git a/paths/teams/add_space.yaml b/paths/teams/add_space.yaml index 664d2ae34..3c5612cc8 100644 --- a/paths/teams/add_space.yaml +++ b/paths/teams/add_space.yaml @@ -46,6 +46,8 @@ requestBody: schema: type: object title: teams/spaces/create/parameters + required: + - id properties: id: description: Space ID to add to the Team diff --git a/paths/teams/add_user.yaml b/paths/teams/add_user.yaml index b8f03ef57..b41e8e683 100644 --- a/paths/teams/add_user.yaml +++ b/paths/teams/add_user.yaml @@ -46,6 +46,8 @@ requestBody: schema: type: object title: teams/users/create/parameters + required: + - id properties: id: description: User ID to add to the Team diff --git a/paths/teams/create.yaml b/paths/teams/create.yaml index 945f2aaba..c4f19e277 100644 --- a/paths/teams/create.yaml +++ b/paths/teams/create.yaml @@ -48,6 +48,8 @@ requestBody: schema: type: object title: team/create/parameters + required: + - name properties: name: description: Name of the team diff --git a/paths/translations/create.yaml b/paths/translations/create.yaml index ca8040679..33a34f23f 100644 --- a/paths/translations/create.yaml +++ b/paths/translations/create.yaml @@ -48,19 +48,22 @@ requestBody: schema: type: object title: translation/create/parameters + required: + - locale_id + - key_id properties: - branch: - description: specify the branch to use - type: string - example: my-feature-branch locale_id: - description: Locale. Can be the name or public id of the locale. Preferred is the public id. + description: Locale. Can be the name or id of the locale. Preferred is the id type: string example: abcd1234cdef1234abcd1234cdef1234 key_id: description: Key type: string example: abcd1234cdef1234abcd1234cdef1234 + branch: + description: Branch name + type: string + example: my-feature-branch content: description: Translation content type: string diff --git a/paths/uploads/create.yaml b/paths/uploads/create.yaml index 396e011df..bc4d4ef12 100644 --- a/paths/uploads/create.yaml +++ b/paths/uploads/create.yaml @@ -107,7 +107,7 @@ requestBody: type: string example: locale_mapping: - description: Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. + description: Mapping between locale names and translation columns. Required in some formats like CSV or XLSX. type: object properties: {} example: '{"en": "2"}' diff --git a/schemas/key_link.yaml b/schemas/key_link.yaml index 33bee6e9a..8ec5a84f3 100644 --- a/schemas/key_link.yaml +++ b/schemas/key_link.yaml @@ -26,11 +26,3 @@ key_link: items: $ref: "./key_preview.yaml#/key_preview" description: The child translation keys linked to the parent. - required: - - created_at - - updated_at - - created_by - - updated_by - - account - - parent - - children