diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 5a28e2c2..7acecf92 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -21,6 +21,7 @@ jobs: node-version: "24.14.1" - run: npm install - run: npx swagger-cli bundle -t json -w 300 main.yaml > doc/compiled_new.json + - run: node scripts/inject-cli-examples.js doc/compiled_new.json - run: diff doc/compiled.json doc/compiled_new.json compile-go: diff --git a/Makefile b/Makefile index 2976566b..d41a54a9 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,5 @@ +.PHONY: run lint bundle examples watch_bundle ruby go typescript python java php cli + run: make lint make bundle @@ -16,6 +18,15 @@ lint: bundle: npx swagger-cli bundle -t json -w 300 main.yaml > doc/compiled.json npx swagger-cli bundle -t yaml -w 300 main.yaml > tmp/compiled.yaml + node scripts/inject-cli-examples.js doc/compiled.json tmp/compiled.yaml + +# Regenerate examples/cli.yaml from the bundled spec (examples-only, no client build). +# Needs Java/openapi-generator, so it is part of client generation (see `cli`), +# not `bundle`. Run this manually after changing an endpoint's parameters or +# x-cli-command, then re-run `make bundle` to inject the refreshed examples. +# Requires tmp/compiled.yaml to exist (produced by `make bundle`). +examples: + npx openapi-generator-cli generate -i tmp/compiled.yaml -g go -o tmp/cli-examples -c ./openapi-generator/cli_examples_lang.yaml -e handlebars watch_bundle: make lint npx swagger-cli bundle -t json -w 300 main.yaml > doc/compiled.json @@ -41,3 +52,5 @@ cli: go install golang.org/x/tools/cmd/goimports@v0.24.0 goimports -w clients/cli cd clients/cli && go mod tidy + make examples + make bundle diff --git a/README.md b/README.md index d1ef3a53..b86b2222 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,26 @@ The `change_type` is one of the following: You added an endpoint in Phrase Strings. In this project you do the following: 1. Add newly added schema (if any) to `/schemas/` directory and to `schemas.yaml` -2. Add new endpoints to `/paths/` directory and reference it in `paths.yaml` +2. Add new endpoints to `/paths/` directory and reference it in `paths.yaml`. Each + path file must include an `x-cli-command` field with the CLI command for the + endpoint, e.g. `x-cli-command: screenshots create` (the parent command plus the + subcommand). This drives the auto-generated CLI code sample. 3. `npm start` to re-build the clients 4. Open a PR with an informative title (e.g. `feat(API): Add an API endpoint for cat pics`) +### CLI code samples + +The `CLI v2` entries in `x-code-samples` are **generated**, not hand-written. They +are produced into `examples/cli.yaml` from each endpoint's `x-cli-command` and +parameters (during `make cli` / `npm start`, which needs Java) and injected into +the compiled spec (`doc/compiled.json`) during `make bundle` (Node only). Do not +add `CLI v2` samples to path files by hand — only the hand-written `Curl` sample +and the `x-cli-command` field belong there. + +`examples/cli.yaml` is committed and kept in sync by `npm start`. If you change an +endpoint's parameters or `x-cli-command` without a full rebuild, run `make examples` +then `make bundle` to refresh it. + ## Workflow The following repositories are generated upon pushing to this one: diff --git a/doc/compiled.json b/doc/compiled.json index 8a4a2227..57e970c5 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -5116,7 +5116,8 @@ "schema": { "type": "string" }, - "style": "simple" + "style": "simple", + "example": "2024-03-15T09:00:00Z" }, "If-None-Match": { "description": "ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)", @@ -5127,7 +5128,8 @@ "schema": { "type": "string" }, - "style": "simple" + "style": "simple", + "example": "W/\"123456789\"" }, "account_id": { "in": "path", @@ -5733,7 +5735,7 @@ }, { "lang": "CLI v2", - "source": "phrase icu skeleton \\\n--data '{\"content\":\"{number, plural, one {One} other {%{n}}}\",\"locale_codes\":[\"en\"],\"zero_form_enabled\": true}' \\\n--access_token " + "source": "phrase icu skeleton \\\n --data '{ \"content\": \"{number, plural, one {One} other {%{n}}}\", \"id\": \"abcd1234abcd1234abcd1234abcd1234\", \"locale_codes\": [\"en\"], \"keep_content\": null, \"zero_form_enabled\": null, \"cldr_version\": \"cldr_41\" }' \\\n --access_token " } ], "requestBody": { @@ -5785,6 +5787,7 @@ } } }, + "x-cli-command": "icu skeleton", "x-cli-version": "2.9" } }, @@ -5862,9 +5865,10 @@ }, { "lang": "CLI v2", - "source": "phrase formats list \\\n--access_token " + "source": "phrase formats list \\\n --access_token " } ], + "x-cli-command": "formats list", "x-cli-version": "2.5" } }, @@ -5977,9 +5981,10 @@ }, { "lang": "CLI v2", - "source": "phrase documents list \\\n--project_id \\\n--access_token " + "source": "phrase documents list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --q \"invoice\" \\\n --access_token " } ], + "x-cli-command": "documents list", "x-cli-version": "2.5" } }, @@ -6033,9 +6038,10 @@ }, { "lang": "CLI v2", - "source": "phrase documents delete \\\n--project_id \\\n--id \\\n--access_token " + "source": "phrase documents delete \\\n --project_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "documents delete", "x-cli-version": "2.5" } }, @@ -6113,9 +6119,10 @@ }, { "lang": "CLI v2", - "source": "phrase report show \\\n--project_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase reports show \\\n --project_id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "reports show", "x-cli-version": "2.13" } }, @@ -6208,9 +6215,10 @@ }, { "lang": "CLI v2", - "source": "phrase report locales list \\\n--project_id \\\n--branch my-feature-branch \\\n--locale_codes de \\\n--access_token " + "source": "phrase reports locales_list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --locale_codes \"localeCodes_example\" \\\n --tag \"tag_example\" \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "reports locales_list", "x-cli-version": "2.13" } }, @@ -6300,9 +6308,10 @@ }, { "lang": "CLI v2", - "source": "phrase figma_attachments list \\\n--project_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase figma_attachments list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "figma_attachments list", "x-cli-version": "2.13" }, "post": { @@ -6378,7 +6387,7 @@ }, { "lang": "CLI v2", - "source": "phrase figma_attachment create \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"url\":\"https://figma.com/file/xxxxx/sample\"}' \\\n--access_token " + "source": "phrase figma_attachments create \\\n --project_id \\\n --branch \"my-feature-branch\" \\\n --data '{ \"branch\": \"my-feature-branch\", \"url\": \"https://figma.com/file/xxxxx/sample\" }' \\\n --access_token " } ], "requestBody": { @@ -6407,6 +6416,7 @@ } } }, + "x-cli-command": "figma_attachments create", "x-cli-version": "2.13" } }, @@ -6484,9 +6494,10 @@ }, { "lang": "CLI v2", - "source": "phrase figma_attachment show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase figma_attachments show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "figma_attachments show", "x-cli-version": "2.13" }, "patch": { @@ -6565,7 +6576,7 @@ }, { "lang": "CLI v2", - "source": "phrase figma_attachment update \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"url\":\"https://figma.com/file/xxxxx/sample\" }' \\\n--access_token " + "source": "phrase figma_attachments update \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --data '{ \"branch\": \"my-feature-branch\", \"url\": \"https://figma.com/file/xxxxx/sample\" }' \\\n --access_token " } ], "requestBody": { @@ -6591,6 +6602,7 @@ } } }, + "x-cli-command": "figma_attachments update", "x-cli-version": "2.13" }, "delete": { @@ -6651,9 +6663,10 @@ }, { "lang": "CLI v2", - "source": "phrase figma_attachment delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase figma_attachments delete \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "figma_attachments delete", "x-cli-version": "2.13" } }, @@ -6709,9 +6722,10 @@ }, { "lang": "CLI v2", - "source": "phrase figma_attachment attach_to_key \\\n--project_id \\\n--figma_attachment_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase keys_figma_attachments attach_to_key \\\n --project_id \\\n --figma_attachment_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "keys_figma_attachments attach_to_key", "x-cli-version": "2.13" } }, @@ -6767,9 +6781,10 @@ }, { "lang": "CLI v2", - "source": "phrase figma_attachment detach_from_key \\\n--project_id \\\n--figma_attachment_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase keys_figma_attachments detach_from_key \\\n --project_id \\\n --figma_attachment_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "keys_figma_attachments detach_from_key", "x-cli-version": "2.13" } }, @@ -6850,9 +6865,10 @@ }, { "lang": "CLI v2", - "source": "phrase styleguides list \\\n--project_id \\\n--access_token " + "source": "phrase style_guides list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "style_guides list", "x-cli-version": "2.5" }, "post": { @@ -6915,11 +6931,11 @@ "x-code-samples": [ { "lang": "Curl", - "source": "curl \"https://api.phrase.com/v2/projects/:project_id/styleguides\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X POST \\\n -d '{\"title\":\"Web application style guide\",\"audience\":\"customer-facing\",\"target_audience\":\"teenager\",\"grammatical_person\":\"first_person_singular\",\"vocabulary_type\":\"technical\",\"business\":\"We are a travel site that helps customers find the best hotels and flights.\",\"company_branding\":\"ACME Inc. should never be translated.\",\"formatting\":\"Never use capital letters\",\"glossary_terms\":\"Apartment, cabin, loft\",\"grammar_consistency\":\",\"literal_translation\":\"Neutral\",\"overall_tone\":\"Tone should be fun and light\",\"samples\":\"http://www.myexample.com/my/document/path/to/samples.pdf\"}' \\\n -H 'Content-Type: application/json'" + "source": "curl \"https://api.phrase.com/v2/projects/:project_id/styleguides\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X POST \\\n -d '{\"title\":\"Web application style guide\",\"audience\":\"customer-facing\",\"target_audience\":\"teenager\",\"grammatical_person\":\"first_person_singular\",\"vocabulary_type\":\"technical\",\"business\":\"We are a travel site that helps customers find the best hotels and flights.\",\"company_branding\":\"ACME Inc. should never be translated.\",\"formatting\":\"Never use capital letters\",\"glossary_terms\":\"Apartment, cabin, loft\",\"grammar_consistency\":\"Use informal pronouns and consistent present-tense conjugation\",\"literal_translation\":\"Neutral\",\"overall_tone\":\"Tone should be fun and light\",\"samples\":\"http://www.myexample.com/my/document/path/to/samples.pdf\"}' \\\n -H 'Content-Type: application/json'" }, { "lang": "CLI v2", - "source": "phrase styleguides create \\\n--project_id \\\n--data '{\"title\": \"Web application style guide\", \"audience\":\"customer-facing\", \"target_audience\":\"teenager\", \"grammatical_person\":\"first_person_singular\", \"vocabulary_type\":\"technical\", \"business\": \"We are a travel site that helps customers find the best hotels and flights.\", \"company_branding\": \"ACME Inc. should never be translated.\", \"formatting\": \"Never use capital letters\", \"glossary_terms\": \"Apartment, cabin, loft\", \"grammar_consistency\":\", \"literal_translation\":\"Neutral\", \"overall_tone\": \"Tone should be fun and light\", \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\"}' \\\n--access_token " + "source": "phrase style_guides create \\\n --project_id \\\n --data '{ \"title\": \"Web application style guide\", \"audience\": \"customer-facing\", \"target_audience\": \"teenager\", \"grammatical_person\": \"first_person_singular\", \"vocabulary_type\": \"technical\", \"business\": \"We are a travel site that helps customers find the best hotels and flights.\", \"company_branding\": \"ACME Inc. should never be translated.\", \"formatting\": \"Never use capital letters\", \"glossary_terms\": \"Apartment, cabin, loft\", \"grammar_consistency\": \"Use informal pronouns and consistent present-tense conjugation\", \"literal_translation\": \"Neutral\", \"overall_tone\": \"Tone should be fun and light\", \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\" }' \\\n --access_token " } ], "requestBody": { @@ -7006,7 +7022,7 @@ "grammar_consistency": { "description": "Formal or informal pronouns, consistent conjugation, grammatical gender", "type": "string", - "example": "" + "example": "Use informal pronouns and consistent present-tense conjugation" }, "literal_translation": { "description": "Can be one of: Cultural/Conversational, Literal, Neutral.", @@ -7028,6 +7044,7 @@ } } }, + "x-cli-command": "style_guides create", "x-cli-version": "2.5" } }, @@ -7096,9 +7113,10 @@ }, { "lang": "CLI v2", - "source": "phrase styleguides show \\\n--project_id \\\n--id \\\n--access_token " + "source": "phrase style_guides show \\\n --project_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "style_guides show", "x-cli-version": "2.5" }, "patch": { @@ -7164,11 +7182,11 @@ "x-code-samples": [ { "lang": "Curl", - "source": "curl \"https://api.phrase.com/v2/projects/:project_id/styleguides/:id\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X PATCH \\\n -d '{\"title\":\"Web application style guide\",\"audience\":\"customer-facing\",\"target_audience\":\"teenager\",\"grammatical_person\":\"first_person_singular\",\"vocabulary_type\":\"technical\",\"business\":\"We are a travel site that helps customers find the best hotels and flights.\",\"company_branding\":\"ACME Inc. should never be translated.\",\"formatting\":\"Never use capital letters\",\"glossary_terms\":\"Apartment, cabin, loft\",\"grammar_consistency\":\",\"literal_translation\":\"Neutral\",\"overall_tone\":\"Tone should be fun and light\",\"samples\":\"http://www.myexample.com/my/document/path/to/samples.pdf\"}' \\\n -H 'Content-Type: application/json'" + "source": "curl \"https://api.phrase.com/v2/projects/:project_id/styleguides/:id\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X PATCH \\\n -d '{\"title\":\"Web application style guide\",\"audience\":\"customer-facing\",\"target_audience\":\"teenager\",\"grammatical_person\":\"first_person_singular\",\"vocabulary_type\":\"technical\",\"business\":\"We are a travel site that helps customers find the best hotels and flights.\",\"company_branding\":\"ACME Inc. should never be translated.\",\"formatting\":\"Never use capital letters\",\"glossary_terms\":\"Apartment, cabin, loft\",\"grammar_consistency\":\"Use informal pronouns and consistent present-tense conjugation\",\"literal_translation\":\"Neutral\",\"overall_tone\":\"Tone should be fun and light\",\"samples\":\"http://www.myexample.com/my/document/path/to/samples.pdf\"}' \\\n -H 'Content-Type: application/json'" }, { "lang": "CLI v2", - "source": "phrase styleguides update \\\n--project_id \\\n--id \\\n--data '{\"title\": \"Web application style guide\", \"audience\":\"customer-facing\", \"target_audience\":\"teenager\", \"grammatical_person\":\"first_person_singular\", \"vocabulary_type\":\"technical\", \"business\": \"We are a travel site that helps customers find the best hotels and flights.\", \"company_branding\": \"ACME Inc. should never be translated.\", \"formatting\": \"Never use capital letters\", \"glossary_terms\": \"Apartment, cabin, loft\", \"grammar_consistency\":\", \"literal_translation\":\"Neutral\", \"overall_tone\": \"Tone should be fun and light\", \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\"}' \\\n--access_token " + "source": "phrase style_guides update \\\n --project_id \\\n --id \\\n --data '{ \"title\": \"Web application style guide\", \"audience\": \"customer-facing\", \"target_audience\": \"teenager\", \"grammatical_person\": \"first_person_singular\", \"vocabulary_type\": \"technical\", \"business\": \"We are a travel site that helps customers find the best hotels and flights.\", \"company_branding\": \"ACME Inc. should never be translated.\", \"formatting\": \"Never use capital letters\", \"glossary_terms\": \"Apartment, cabin, loft\", \"grammar_consistency\": \"Use informal pronouns and consistent present-tense conjugation\", \"literal_translation\": \"Neutral\", \"overall_tone\": \"Tone should be fun and light\", \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\" }' \\\n --access_token " } ], "requestBody": { @@ -7252,7 +7270,7 @@ "grammar_consistency": { "description": "Formal or informal pronouns, consistent conjugation, grammatical gender", "type": "string", - "example": "" + "example": "Use informal pronouns and consistent present-tense conjugation" }, "literal_translation": { "description": "Can be one of: Cultural/Conversational, Literal, Neutral.", @@ -7274,6 +7292,7 @@ } } }, + "x-cli-command": "style_guides update", "x-cli-version": "2.5" }, "delete": { @@ -7325,9 +7344,10 @@ }, { "lang": "CLI v2", - "source": "phrase styleguides delete \\\n--project_id \\\n--id \\\n--access_token " + "source": "phrase style_guides delete \\\n --project_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "style_guides delete", "x-cli-version": "2.5" } }, @@ -7440,9 +7460,10 @@ }, { "lang": "CLI v2", - "source": "phrase custom_metadata_properties list \\\n--account_id \\\n--data_type boolean \\\n--project_id 1 \\\n--page 1 \\\n--per_page 10 \\\n--sort created_at \\\n--order desc \\\n--access_token " + "source": "phrase custom_metadata list \\\n --account_id \\\n --data_type \"boolean\" \\\n --project_id \"abcd1234cdef1234abcd1234cdef1234\" \\\n --page \"1\" \\\n --per_page \"25\" \\\n --q \"character_name\" \\\n --sort \"updated_at\" \\\n --order \"desc\" \\\n --access_token " } ], + "x-cli-command": "custom_metadata list", "x-cli-version": "2.9" }, "post": { @@ -7555,9 +7576,10 @@ }, { "lang": "CLI v2", - "source": "phrase custom_metadata_properties create \\\n--account_id \\\n--data '{\"name\":\"Fruit\",\"data_type\":\"multi_select\",\"description\":\"A healthy snack for all ages\",\"project_ids\":[\"1\",\"2\",\"3\"],\"value_options\":[\"apple\",\"banana\",\"coconut\"]}' \\\n--access_token " + "source": "phrase custom_metadata create \\\n --account_id \\\n --data '{ \"name\": \"Fruit\", \"data_type\": \"null\", \"project_ids\": [\"abcd1234cdef1234abcd1234cdef1234\",\"abcd1234cdef1234abcd1234cdef4321\"], \"description\": \"A healthy snack for all ages\", \"value_options\": [\"Apple\",\"Banana\",\"Coconut\"] }' \\\n --access_token " } ], + "x-cli-command": "custom_metadata create", "x-cli-version": "2.9" } }, @@ -7619,9 +7641,10 @@ }, { "lang": "CLI v2", - "source": "phrase custom_metadata_properties show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase custom_metadata show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "custom_metadata show", "x-cli-version": "2.9" }, "patch": { @@ -7727,9 +7750,10 @@ }, { "lang": "CLI v2", - "source": "phrase custom_metadata_properties update \\\n--account_id \\\n--id \\\n--data '{\"name\":\"Fruit\",\"description\":\"A healthy snack for all ages\",\"project_ids\":[\"1\",\"2\",\"3\"],\"value_options\":[\"apple\",\"banana\",\"coconut\"]}' \\\n--access_token " + "source": "phrase custom_metadata update \\\n --account_id \\\n --id \\\n --data '{ \"name\": \"Fruit\", \"project_ids\": [\"abcd1234cdef1234abcd1234cdef1234\",\"abcd1234cdef1234abcd1234cdef4321\"], \"description\": \"A healthy snack for all ages\", \"value_options\": [\"Apple\",\"Banana\",\"Coconut\"] }' \\\n --access_token " } ], + "x-cli-command": "custom_metadata update", "x-cli-version": "2.9" }, "delete": { @@ -7771,9 +7795,10 @@ }, { "lang": "CLI v2", - "source": "phrase custom_metadata_properties delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase custom_metadata delete \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "custom_metadata delete", "x-cli-version": "2.9" } }, @@ -7853,9 +7878,10 @@ }, { "lang": "CLI v2", - "source": "phrase invitations list \\\n--account_id \\\n--access_token " + "source": "phrase invitations list \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "invitations list", "x-cli-version": "2.5" }, "post": { @@ -7921,7 +7947,7 @@ }, { "lang": "CLI v2", - "source": "phrase invitations create \\\n--account_id \\\n--data '{\"email\":\"example@mail.com\", \"role\":\"Developer\", \"project_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"locale_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"space_ids\":[\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"],\"team_ids\":[\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"], \"default_locale_codes\":[\"de\",\"en\"], \"permissions\":\"{\"create_upload\"=>true, \"review_translations\"=>true}\"}' \\\n--access_token " + "source": "phrase invitations create \\\n --account_id \\\n --data '{ \"email\": \"example@mail.com\", \"role\": \"Developer\", \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"space_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"], \"team_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"], \"default_locale_codes\": [\"en\",\"de\"], \"permissions\": {\"create_upload\":true,\"review_translations\":true} }' \\\n --access_token " } ], "requestBody": { @@ -8005,6 +8031,7 @@ } } }, + "x-cli-command": "invitations create", "x-cli-version": "2.5" } }, @@ -8072,9 +8099,10 @@ }, { "lang": "CLI v2", - "source": "phrase invitations show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase invitations show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "invitations show", "x-cli-version": "2.5" }, "patch": { @@ -8143,7 +8171,7 @@ }, { "lang": "CLI v2", - "source": "phrase invitations update \\\n--account_id \\\n--id \\\n--data '{\"role\": \"Invitiation role\", \"project_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"locale_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"space_ids\":[\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"],\"team_ids\":[\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"], \"default_locale_codes\":[\"de\",\"en\"], \"permissions\":\"{\"create_upload\"=>true}\"}' \\\n--access_token " + "source": "phrase invitations update \\\n --account_id \\\n --id \\\n --data '{ \"role\": \"Invitiation role\", \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"space_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"], \"team_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"], \"default_locale_codes\": [\"en\",\"de\"], \"permissions\": {\"create_upload\":true} }' \\\n --access_token " } ], "requestBody": { @@ -8217,6 +8245,7 @@ } } }, + "x-cli-command": "invitations update", "x-cli-version": "2.5" }, "delete": { @@ -8267,9 +8296,10 @@ }, { "lang": "CLI v2", - "source": "phrase invitations delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase invitations delete \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "invitations delete", "x-cli-version": "2.5" } }, @@ -8340,9 +8370,10 @@ }, { "lang": "CLI v2", - "source": "phrase invitations resend \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase invitations resend \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "invitations resend", "x-cli-version": "2.5" } }, @@ -8413,7 +8444,7 @@ }, { "lang": "CLI v2", - "source": "phrase invitations update_settings \\\n--project_id \\\n--id \\\n--data '{\"project_role\":\"Developer\",\"locale_ids\":[\"fff565db236400772368235db2c6117e\",\"fff565db236400772368235db2c6117f\"]}' \\\n--access_token " + "source": "phrase invitations update_settings \\\n --project_id \\\n --id \\\n --data '{ \"project_role\": \"Developer\", \"locale_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"] }' \\\n --access_token " } ], "requestBody": { @@ -8445,6 +8476,7 @@ } } }, + "x-cli-command": "invitations update_settings", "x-cli-version": "2.5" } }, @@ -8537,9 +8569,10 @@ }, { "lang": "CLI v2", - "source": "phrase screenshot_markers list \\\n--project_id \\\n--branch my-feature-branch \\\n--id \\\n--access_token " + "source": "phrase screenshot_markers list \\\n --project_id \\\n --id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "screenshot_markers list", "x-cli-version": "2.5" } }, @@ -8620,9 +8653,10 @@ }, { "lang": "CLI v2", - "source": "phrase screenshot_markers show \\\n--project_id \\\n--screenshot_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase screenshot_markers show \\\n --project_id \\\n --screenshot_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "screenshot_markers show", "x-cli-version": "2.5" } }, @@ -8694,7 +8728,7 @@ }, { "lang": "CLI v2", - "source": "phrase screenshot_markers create \\\n--project_id \\\n--screenshot_id \\\n--data '{\"branch\":\"my-feature-branch\", \"key_id\":\"abcd1234abcd1234abcd1234abcd1234\", \"presentation\": \"{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }\"}' \\\n--access_token " + "source": "phrase screenshot_markers create \\\n --project_id \\\n --screenshot_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"key_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"presentation\": \"{ \\\"x\\\": 100, \\\"y\\\": 100, \\\"w\\\": 100, \\\"h\\\": 100 }\" }' \\\n --access_token " } ], "requestBody": { @@ -8728,6 +8762,7 @@ } } }, + "x-cli-command": "screenshot_markers create", "x-cli-version": "2.5" }, "patch": { @@ -8797,7 +8832,7 @@ }, { "lang": "CLI v2", - "source": "phrase screenshot_markers update \\\n--project_id \\\n--screenshot_id \\\n--data '{\"branch\":\"my-feature-branch\", \"key_id\":\"abcd1234abcd1234abcd1234abcd1234\", \"presentation\": \"{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }\"}' \\\n--access_token " + "source": "phrase screenshot_markers update \\\n --project_id \\\n --screenshot_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"key_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"presentation\": \"{ \\\"x\\\": 100, \\\"y\\\": 100, \\\"w\\\": 100, \\\"h\\\": 100 }\" }' \\\n --access_token " } ], "requestBody": { @@ -8828,6 +8863,7 @@ } } }, + "x-cli-command": "screenshot_markers update", "x-cli-version": "2.5" }, "delete": { @@ -8888,9 +8924,10 @@ }, { "lang": "CLI v2", - "source": "phrase screenshot_markers delete \\\n--project_id \\\n--screenshot_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase screenshot_markers delete \\\n --project_id \\\n --screenshot_id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "screenshot_markers delete", "x-cli-version": "2.5" } }, @@ -8984,9 +9021,10 @@ }, { "lang": "CLI v2", - "source": "phrase accounts locales \\\n--id \\\n--access_token " + "source": "phrase locales locales \\\n --id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "locales locales", "x-cli-version": "2.5" } }, @@ -9094,9 +9132,10 @@ }, { "lang": "CLI v2", - "source": "phrase locales list \\\n--project_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase locales list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --sort_by \"sortBy_example\" \\\n --branch \"my-feature-branch\" \\\n --q \"name:en\" \\\n --access_token " } ], + "x-cli-command": "locales list", "x-cli-version": "2.5" }, "post": { @@ -9163,7 +9202,7 @@ }, { "lang": "CLI v2", - "source": "phrase locales create \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"de\", \"code\":\"de-DE\", \"source_locale_id\":\"abcd1234abcd1234abcd1234abcd1234\", \"fallback_locale_id\":\"abcd1234abcd1234abcd1234abcd1234\"}' \\\n--access_token " + "source": "phrase locales create \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"de\", \"code\": \"de-DE\", \"default\": null, \"main\": null, \"rtl\": null, \"source_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"fallback_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"unverify_new_translations\": null, \"unverify_updated_translations\": null, \"autotranslate\": null, \"language_ai_profile\": \"abcd1234abcd1234abcd1234abcd1234\" }' \\\n --access_token " } ], "requestBody": { @@ -9243,6 +9282,7 @@ } } }, + "x-cli-command": "locales create", "x-cli-version": "2.5" } }, @@ -9320,9 +9360,10 @@ }, { "lang": "CLI v2", - "source": "phrase locales show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase locales show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "locales show", "x-cli-version": "2.5" }, "patch": { @@ -9392,7 +9433,7 @@ }, { "lang": "CLI v2", - "source": "phrase locales update \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"de\", \"code\":\"de-DE\", \"source_locale_id\":\"abcd1234abcd1234abcd1234abcd1234\"}' \\\n--access_token " + "source": "phrase locales update \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"de\", \"code\": \"de-DE\", \"default\": null, \"main\": null, \"rtl\": null, \"source_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"fallback_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"unverify_new_translations\": null, \"unverify_updated_translations\": null, \"autotranslate\": null, \"language_ai_profile\": \"abcd1234abcd1234abcd1234abcd1234\" }' \\\n --access_token " } ], "requestBody": { @@ -9468,6 +9509,7 @@ } } }, + "x-cli-command": "locales update", "x-cli-version": "2.5" }, "delete": { @@ -9528,9 +9570,10 @@ }, { "lang": "CLI v2", - "source": "phrase locales delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase locales delete \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "locales delete", "x-cli-version": "2.5" } }, @@ -9821,9 +9864,10 @@ }, { "lang": "CLI v2", - "source": "phrase locales download \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--file_format yml \\\n--tags feature1,feature2 \\\n--tag feature \\\n--access_token " + "source": "phrase locales download \\\n --project_id \\\n --id \\\n --if_modified_since \"2024-03-15T09:00:00Z\" \\\n --if_none_match \"W/\\\"123456789\\\"\" \\\n --branch \"my-feature-branch\" \\\n --file_format \"yml\" \\\n --tags \"feature1,feature2\" \\\n --tag \"feature\" \\\n --include_empty_translations true \\\n --exclude_empty_zero_forms true \\\n --include_translated_keys true \\\n --keep_notranslate_tags true \\\n --convert_emoji true \\\n --format_options '{ }' \\\n --encoding \"encoding_example\" \\\n --skip_unverified_translations true \\\n --include_unverified_translations true \\\n --use_last_reviewed_version true \\\n --fallback_locale_id \"fallbackLocaleId_example\" \\\n --use_locale_fallback true \\\n --fallback_for_unverified_translations true \\\n --source_locale_id \"sourceLocaleId_example\" \\\n --translation_key_prefix \"prefix_\" \\\n --filter_by_prefix true \\\n --custom_metadata_filters '{ }' \\\n --locale_ids '[\"de\",\"en\"]' \\\n --updated_since \"2023-01-01T00:00:00Z\" \\\n --access_token " } ], + "x-cli-command": "locales download", "x-cli-version": "2.6.4" } }, @@ -10027,9 +10071,10 @@ }, { "lang": "CLI v2", - "source": "phrase locale_downloads create \\\n--project_id \\\n--locale_id \\\n--branch my-feature-branch \\\n--file_format yml \\\n--tags feature1,feature2 \\\n--access_token " + "source": "phrase locale_downloads create \\\n --project_id \\\n --locale_id \\\n --if_modified_since \"2024-03-15T09:00:00Z\" \\\n --if_none_match \"W/\\\"123456789\\\"\" \\\n --data '{ \"file_format\": \"yml\", \"branch\": \"my-feature-branch\", \"tags\": \"feature1,feature2\", \"include_empty_translations\": true, \"exclude_empty_zero_forms\": true, \"include_translated_keys\": true, \"keep_notranslate_tags\": true, \"format_options\": {\"format_options\":{\"foo\":\"bar\"}}, \"encoding\": \"UTF-8\", \"include_unverified_translations\": true, \"use_last_reviewed_version\": null, \"locale_ids\": [\"de\",\"en\"], \"fallback_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"use_locale_fallback\": false, \"fallback_for_unverified_translations\": false, \"source_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"custom_metadata_filters\": null, \"translation_key_prefix\": \"prefix_\", \"filter_by_prefix\": null, \"updated_since\": \"2023-01-01T00:00:00Z\" }' \\\n --access_token " } ], + "x-cli-command": "locale_downloads create", "x-cli-version": "2.29.0" } }, @@ -10110,9 +10155,10 @@ }, { "lang": "CLI v2", - "source": "phrase locale_downloads show \\\n--project_id \\\n--locale_id \\\n--id \n--access_token " + "source": "phrase locale_downloads show \\\n --project_id \\\n --locale_id \\\n --id \\\n --if_modified_since \"2024-03-15T09:00:00Z\" \\\n --if_none_match \"W/\\\"123456789\\\"\" \\\n --access_token " } ], + "x-cli-command": "locale_downloads show", "x-cli-version": "2.29.0" } }, @@ -10193,9 +10239,10 @@ }, { "lang": "CLI v2", - "source": "phrase distributions list \\\n--account_id \\\n--access_token " + "source": "phrase distributions list \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "distributions list", "x-cli-version": "2.5" }, "post": { @@ -10262,7 +10309,7 @@ }, { "lang": "CLI v2", - "source": "phrase distributions create \\\n--account_id \\\n--data '{\"name\": \"My Android Distribution\", \"project_id\":\"abcd1234abcd1234abcd1234\", \"platforms\": \"android,ios\", \"locale_ids\":[\"fff565db236400772368235db2c6117e,abcd1234cdef1234abcd1234cdef1234\"], \"format_options\": \"{xml:{enclose_in_cdata:'1'}}\", \"fallback_to_non_regional_locale\":true, \"fallback_to_default_locale\":true, \"use_last_reviewed_version\":true}' \\\n--access_token " + "source": "phrase distributions create \\\n --account_id \\\n --data '{ \"name\": \"My Android Distribution\", \"project_id\": \"abcd1234abcd1234abcd1234\", \"platforms\": [\"android\",\"ios\"], \"locale_ids\": [\"abcd1234cdef1234abcd1234cdef1234\",\"fff565db236400772368235db2c6117e\"], \"format_options\": {\"enclose_in_cdata\":\"1\"}, \"fallback_locales_enabled\": true, \"fallback_to_non_regional_locale\": true, \"fallback_to_default_locale\": true, \"use_last_reviewed_version\": true }' \\\n --access_token " } ], "requestBody": { @@ -10315,7 +10362,9 @@ "additionalProperties": { "type": "string" }, - "example": "{xml:{enclose_in_cdata:'1'}}" + "example": { + "enclose_in_cdata": "1" + } }, "fallback_locales_enabled": { "description": "Use fallback locale if there is no translation in the current locale.", @@ -10342,6 +10391,7 @@ } } }, + "x-cli-command": "distributions create", "x-cli-version": "2.5" } }, @@ -10410,9 +10460,10 @@ }, { "lang": "CLI v2", - "source": "phrase distributions show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase distributions show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "distributions show", "x-cli-version": "2.5" }, "patch": { @@ -10482,7 +10533,7 @@ }, { "lang": "CLI v2", - "source": "phrase distributions update \\\n--account_id \\\n--id \\\n--data '{\"name\": \"My Android Distribution\", \"project_id\":\"abcd1234abcd1234abcd1234\", \"platforms\": \"android,ios\", \"locale_ids\": \"fff565db236400772368235db2c6117e,abcd1234cdef1234abcd1234cdef1234\", \"format_options\": \"{xml:{enclose_in_cdata:'1'}}\", \"fallback_to_non_regional_locale\":true, \"fallback_to_default_locale\":true, \"use_last_reviewed_version\":true}' \\\n--access_token " + "source": "phrase distributions update \\\n --account_id \\\n --id \\\n --data '{ \"name\": \"My Android Distribution\", \"project_id\": \"abcd1234abcd1234abcd1234\", \"platforms\": [\"android\",\"ios\"], \"locale_ids\": [\"abcd1234cdef1234abcd1234cdef1234\",\"fff565db236400772368235db2c6117e\"], \"format_options\": {\"enclose_in_cdata\":\"1\"}, \"fallback_locales_enabled\": true, \"fallback_to_non_regional_locale\": true, \"fallback_to_default_locale\": true, \"use_last_reviewed_version\": true }' \\\n --access_token " } ], "requestBody": { @@ -10531,7 +10582,9 @@ "additionalProperties": { "type": "string" }, - "example": "{xml:{enclose_in_cdata:'1'}}" + "example": { + "enclose_in_cdata": "1" + } }, "fallback_locales_enabled": { "description": "Use fallback locale if there is no translation in the current locale.", @@ -10558,6 +10611,7 @@ } } }, + "x-cli-command": "distributions update", "x-cli-version": "2.5" }, "delete": { @@ -10609,9 +10663,10 @@ }, { "lang": "CLI v2", - "source": "phrase distributions delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase distributions delete \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "distributions delete", "x-cli-version": "2.5" } }, @@ -10695,9 +10750,10 @@ }, { "lang": "CLI v2", - "source": "phrase releases list \\\n--account_id \\\n--distribution_id \\\n--access_token " + "source": "phrase releases list \\\n --account_id \\\n --distribution_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "releases list", "x-cli-version": "2.5" }, "post": { @@ -10767,7 +10823,7 @@ }, { "lang": "CLI v2", - "source": "phrase releases create \\\n--account_id \\\n--distribution_id \\\n--data '{\"description\": \"My first Release\", \"platforms\": [\"android\", \"ios\"], \"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase releases create \\\n --account_id \\\n --distribution_id \\\n --data '{ \"description\": \"My first Release\", \"platforms\": [\"android\",\"ios\"], \"locale_ids\": [\"abcd1234cdef1234abcd1234cdef1234\",\"fff565db236400772368235db2c6117e\"], \"tags\": [\"android\",\"feature1\"], \"app_min_version\": \"2.5.0\", \"app_max_version\": \"3.0.0\", \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -10836,6 +10892,7 @@ } } }, + "x-cli-command": "releases create", "x-cli-version": "2.8" } }, @@ -10907,9 +10964,10 @@ }, { "lang": "CLI v2", - "source": "phrase releases show \\\n--account_id \\\n--distribution_id \\\n--id \\\n--access_token " + "source": "phrase releases show \\\n --account_id \\\n --distribution_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "releases show", "x-cli-version": "2.5" }, "patch": { @@ -10982,7 +11040,7 @@ }, { "lang": "CLI v2", - "source": "phrase releases update \\\n--account_id \\\n--distribution_id \\\n--id \\\n--data '{\"description\": \"My first Release\", \"platforms\": \"android,ios\", \"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase releases update \\\n --account_id \\\n --distribution_id \\\n --id \\\n --data '{ \"description\": \"My first Release\", \"platforms\": [\"android\",\"ios\"], \"app_min_version\": \"2.5.0\", \"app_max_version\": \"3.0.0\", \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -11029,6 +11087,7 @@ } } }, + "x-cli-command": "releases update", "x-cli-version": "2.5" }, "delete": { @@ -11083,9 +11142,10 @@ }, { "lang": "CLI v2", - "source": "phrase releases delete \\\n--account_id \\\n--distribution_id \\\n--id \\\n--access_token " + "source": "phrase releases delete \\\n --account_id \\\n --distribution_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "releases delete", "x-cli-version": "2.5" } }, @@ -11160,9 +11220,10 @@ }, { "lang": "CLI v2", - "source": "phrase releases publish \\\n--account_id \\\n--distribution_id \\\n--id \\\n--access_token " + "source": "phrase releases publish \\\n --account_id \\\n --distribution_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "releases publish", "x-cli-version": "2.5" } }, @@ -11227,9 +11288,10 @@ }, { "lang": "CLI v2", - "source": "phrase release_triggers list \\\n--account_id \\\n--distribution_id \\\n--access_token " + "source": "phrase release_triggers list \\\n --account_id \\\n --distribution_id \\\n --access_token " } ], + "x-cli-command": "release_triggers list", "x-cli-version": "2.28" }, "post": { @@ -11349,9 +11411,10 @@ }, { "lang": "CLI v2", - "source": "phrase release_triggers create \\\n--account_id \\\n--distribution_id \\\n--data '{\"cron_schedule\":\"15 18 * * 1,3\",\"time_zone\":\"Europe/Berlin\",\"locale_ids\":[\"abcd1234cdef1234abcd1234cdef1234\",\"fff565db236400772368235db2c6117e\"],\"tags\":[\"android\",\"feature1\"],\"branch\":\"my-feature-branch\",\"app_min_version\":\"1.0.0\",\"app_max_version\":\"2.0.0\"}' \\\n--access_token " + "source": "phrase release_triggers create \\\n --account_id \\\n --distribution_id \\\n --data '{ \"cron_schedule\": \"15 18 * * 1,3\", \"time_zone\": \"Europe/Berlin\", \"locale_ids\": [\"abcd1234cdef1234abcd1234cdef1234\",\"fff565db236400772368235db2c6117e\"], \"tags\": [\"android\",\"feature1\"], \"branch\": \"my-feature-branch\", \"app_min_version\": \"1.0.0\", \"app_max_version\": \"2.0.0\" }' \\\n --access_token " } ], + "x-cli-command": "release_triggers create", "x-cli-version": "2.28" } }, @@ -11416,9 +11479,10 @@ }, { "lang": "CLI v2", - "source": "phrase release_triggers show \\\n--account_id \\\n--distribution_id \\\n--id \\\n--access_token " + "source": "phrase release_triggers show \\\n --account_id \\\n --distribution_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "release_triggers show", "x-cli-version": "2.28" }, "patch": { @@ -11541,9 +11605,10 @@ }, { "lang": "CLI v2", - "source": "phrase release_triggers update \\\n--account_id \\\n--distribution_id \\\n--id \\\n--data '{\"cron_schedule\":\"15 18 * * 1,3\",\"time_zone\":\"Europe/Berlin\",\"locale_ids\":[\"abcd1234cdef1234abcd1234cdef1234\",\"fff565db236400772368235db2c6117e\"],\"tags\":[\"android\",\"feature1\"],\"branch\":\"my-feature-branch\",\"app_min_version\":\"1.0.0\",\"app_max_version\":\"2.0.0\"}' \\\n--access_token " + "source": "phrase release_triggers update \\\n --account_id \\\n --distribution_id \\\n --id \\\n --data '{ \"cron_schedule\": \"15 18 * * 1,3\", \"time_zone\": \"Europe/Berlin\", \"locale_ids\": [\"abcd1234cdef1234abcd1234cdef1234\",\"fff565db236400772368235db2c6117e\"], \"tags\": [\"android\",\"feature1\"], \"branch\": \"my-feature-branch\", \"app_min_version\": \"1.0.0\", \"app_max_version\": \"2.0.0\" }' \\\n --access_token " } ], + "x-cli-command": "release_triggers update", "x-cli-version": "2.28" }, "delete": { @@ -11588,9 +11653,10 @@ }, { "lang": "CLI v2", - "source": "phrase release_triggers delete \\\n--account_id \\\n--distribution_id \\\n--id \\\n--access_token " + "source": "phrase release_triggers destroy \\\n --account_id \\\n --distribution_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "release_triggers destroy", "x-cli-version": "2.28" } }, @@ -11710,9 +11776,10 @@ }, { "lang": "CLI v2", - "source": "phrase jobs list \\\n--project_id \\\n--branch my-feature-branch \\\n--owned_by abcd1234cdef1234abcd1234cdef1234 \\\n--assigned_to abcd1234cdef1234abcd1234cdef1234 \\\n--state completed \\\n--access_token " + "source": "phrase jobs list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --owned_by \"abcd1234cdef1234abcd1234cdef1234\" \\\n --assigned_to \"abcd1234cdef1234abcd1234cdef1234\" \\\n --state \"completed\" \\\n --states '[\"in_progress\",\"completed\"]' \\\n --key_id \"abcd1234cdef1234abcd1234cdef1234\" \\\n --updated_since \"2013-02-21T00:00:00.000Z\" \\\n --access_token " } ], + "x-cli-command": "jobs list", "x-cli-version": "2.5" }, "post": { @@ -11779,7 +11846,7 @@ }, { "lang": "CLI v2", - "source": "phrase jobs create \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"de\", \"briefing\":\"de-DE\", \"due_date\":\"2017-08-15\", \"ticket_url\":\"https://example.atlassian.net/browse/FOO\", \"tags\": [\"myUploadTag\"], \"translation_key_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"]}' \\\n--access_token " + "source": "phrase jobs create \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"de\", \"source_locale_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"briefing\": \"de-DE\", \"due_date\": \"null\", \"ticket_url\": \"https://example.atlassian.net/browse/FOO\", \"tags\": [\"myUploadTag\"], \"translation_key_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"target_locale_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"job_template_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"autotranslate\": true }' \\\n --access_token " } ], "requestBody": { @@ -11870,6 +11937,7 @@ } } }, + "x-cli-command": "jobs create", "x-cli-version": "2.5" } }, @@ -11962,9 +12030,10 @@ }, { "lang": "CLI v2", - "source": "phrase jobs by_account \\\n--account_id \\\n--owned_by abcd1234cdef1234abcd1234cdef1234 \\\n--assigned_to abcd1234cdef1234abcd1234cdef1234 \\\n--state completed \\\n--access_token " + "source": "phrase jobs by_account \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --owned_by \"abcd1234cdef1234abcd1234cdef1234\" \\\n --assigned_to \"abcd1234cdef1234abcd1234cdef1234\" \\\n --state \"completed\" \\\n --updated_since \"2013-02-21T00:00:00.000Z\" \\\n --access_token " } ], + "x-cli-command": "jobs by_account", "x-cli-version": "2.5" } }, @@ -12042,9 +12111,10 @@ }, { "lang": "CLI v2", - "source": "phrase jobs show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase jobs show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --include_annotations true \\\n --omit_translation_keys true \\\n --access_token " } ], + "x-cli-command": "jobs show", "x-cli-version": "2.5" }, "patch": { @@ -12114,7 +12184,7 @@ }, { "lang": "CLI v2", - "source": "phrase jobs update \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"de\", \"briefing\":\"de-DE\", \"due_date\":\"2017-08-15\", \"ticket_url\":\"https://example.atlassian.net/browse/FOO\"}' \\\n--access_token " + "source": "phrase jobs update \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"de\", \"briefing\": \"de-DE\", \"due_date\": \"null\", \"ticket_url\": \"https://example.atlassian.net/browse/FOO\", \"target_locale_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"autotranslate\": true }' \\\n --access_token " } ], "requestBody": { @@ -12172,6 +12242,7 @@ } } }, + "x-cli-command": "jobs update", "x-cli-version": "2.5" }, "delete": { @@ -12232,9 +12303,10 @@ }, { "lang": "CLI v2", - "source": "phrase jobs delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase jobs delete \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "jobs delete", "x-cli-version": "2.5" } }, @@ -12306,7 +12378,7 @@ }, { "lang": "CLI v2", - "source": "phrase jobs start \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase jobs start \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -12327,6 +12399,7 @@ } } }, + "x-cli-command": "jobs start", "x-cli-version": "2.5" } }, @@ -12398,7 +12471,7 @@ }, { "lang": "CLI v2", - "source": "phrase jobs complete \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase jobs complete \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -12419,6 +12492,7 @@ } } }, + "x-cli-command": "jobs complete", "x-cli-version": "2.5" } }, @@ -12490,7 +12564,7 @@ }, { "lang": "CLI v2", - "source": "phrase jobs reopen \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase jobs reopen \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -12511,6 +12585,7 @@ } } }, + "x-cli-command": "jobs reopen", "x-cli-version": "2.5" } }, @@ -12591,9 +12666,10 @@ }, { "lang": "CLI v2", - "source": "phrase jobs lock \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase jobs lock \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "jobs lock", "x-cli-version": "2.5" } }, @@ -12674,9 +12750,10 @@ }, { "lang": "CLI v2", - "source": "phrase jobs unlock \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase jobs unlock \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "jobs unlock", "x-cli-version": "2.5" } }, @@ -12738,7 +12815,7 @@ }, { "lang": "CLI v2", - "source": "phrase jobs keys_create \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"translation_key_ids\": \"abcd1234cdef1234abcd1234cdef1234\"}' \\\n--access_token " + "source": "phrase jobs keys_create \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"translation_key_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -12769,6 +12846,7 @@ } } }, + "x-cli-command": "jobs keys_create", "x-cli-version": "2.5" }, "delete": { @@ -12810,7 +12888,7 @@ }, { "lang": "CLI v2", - "source": "phrase jobs keys_delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--data '{\"branch\": \"my-feature-branch\", \"translation_key_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"]}' \\\n--access_token " + "source": "phrase jobs keys_delete \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"translation_key_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -12843,7 +12921,8 @@ } } } - } + }, + "x-cli-command": "jobs keys_delete" } }, "/projects/{project_id}/job_templates": { @@ -12932,9 +13011,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_templates list \\\n--project_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_templates list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_templates list", "x-cli-version": "2.5" }, "post": { @@ -13001,7 +13081,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_templates create \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"template\", \"briefing\":\"text\"}' \\\n--access_token " + "source": "phrase job_templates create \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"template\", \"briefing\": \"text\", \"autotranslate\": true, \"source_locale_id\": \"abcd1234cdef1234abcd1234cdef1234\" }' \\\n --access_token " } ], "requestBody": { @@ -13045,6 +13125,7 @@ } } }, + "x-cli-command": "job_templates create", "x-cli-version": "2.5" } }, @@ -13122,9 +13203,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_templates show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_templates show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_templates show", "x-cli-version": "2.5" }, "patch": { @@ -13194,7 +13276,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_templates update \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"template\", \"briefing\":\"text\"}' \\\n--access_token " + "source": "phrase job_templates update \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"template\", \"briefing\": \"text\", \"autotranslate\": true, \"source_locale_id\": \"abcd1234cdef1234abcd1234cdef1234\" }' \\\n --access_token " } ], "requestBody": { @@ -13238,6 +13320,7 @@ } } }, + "x-cli-command": "job_templates update", "x-cli-version": "2.5" }, "delete": { @@ -13298,9 +13381,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_templates delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_templates delete \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_templates delete", "x-cli-version": "2.5" } }, @@ -13381,9 +13465,10 @@ }, { "lang": "CLI v2", - "source": "phrase glossaries list \\\n--account_id \\\n--access_token " + "source": "phrase glossaries list \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "glossaries list", "x-cli-version": "2.5" }, "post": { @@ -13450,7 +13535,7 @@ }, { "lang": "CLI v2", - "source": "phrase glossaries create \\\n--account_id \\\n--data '{\"name\":\"My term base\", \"project_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"space_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\"}' \\\n--access_token " + "source": "phrase glossaries create \\\n --account_id \\\n --data '{ \"name\": \"My glossary\", \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"space_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"] }' \\\n --access_token " } ], "requestBody": { @@ -13490,6 +13575,7 @@ } } }, + "x-cli-command": "glossaries create", "x-cli-version": "2.5" } }, @@ -13558,9 +13644,10 @@ }, { "lang": "CLI v2", - "source": "phrase glossaries show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase glossaries show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "glossaries show", "x-cli-version": "2.5" }, "patch": { @@ -13630,7 +13717,7 @@ }, { "lang": "CLI v2", - "source": "phrase glossaries update \\\n--account_id \\\n--id \\\n--data '{\"name\": \"My glossary\", \"project_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"space_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\"}' \\\n--access_token " + "source": "phrase glossaries update \\\n --account_id \\\n --id \\\n --data '{ \"name\": \"My glossary\", \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"space_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"] }' \\\n --access_token " } ], "requestBody": { @@ -13667,6 +13754,7 @@ } } }, + "x-cli-command": "glossaries update", "x-cli-version": "2.5" }, "delete": { @@ -13718,9 +13806,10 @@ }, { "lang": "CLI v2", - "source": "phrase glossaries delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase glossaries delete \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "glossaries delete", "x-cli-version": "2.5" } }, @@ -13798,9 +13887,10 @@ }, { "lang": "CLI v2", - "source": "phrase authorizations list" + "source": "phrase authorizations list \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "authorizations list", "x-cli-version": "2.5" }, "post": { @@ -13864,7 +13954,7 @@ }, { "lang": "CLI v2", - "source": "phrase authorizations create \\\n--data '{\"note\": \"My Deploy Script\", \"scopes\": \"read,write\", \"expires_at\": \"2015-03-30T09:52:53Z\"}'" + "source": "phrase authorizations create \\\n --data '{ \"note\": \"My Deploy Script\", \"scopes\": [\"read\",\"write\"], \"expires_at\": \"2015-03-30T09:52:53Z\" }' \\\n --access_token " } ], "requestBody": { @@ -13911,6 +14001,7 @@ } } }, + "x-cli-command": "authorizations create", "x-cli-version": "2.5" } }, @@ -13976,9 +14067,10 @@ }, { "lang": "CLI v2", - "source": "phrase authorizations show \\\n--id " + "source": "phrase authorizations show \\\n --id \\\n --access_token " } ], + "x-cli-command": "authorizations show", "x-cli-version": "2.5" }, "patch": { @@ -14045,7 +14137,7 @@ }, { "lang": "CLI v2", - "source": "phrase authorizations update \\\n--id \\\n--data '{\"note\": \"My Deploy Script\", \"scopes\": \"read,write\", \"expires_at\": \"2015-03-30T09:52:53Z\"}'" + "source": "phrase authorizations update \\\n --id \\\n --data '{ \"note\": \"My Deploy Script\", \"scopes\": [\"read\",\"write\"], \"expires_at\": \"2015-03-30T09:52:53Z\" }' \\\n --access_token " } ], "requestBody": { @@ -14089,6 +14181,7 @@ } } }, + "x-cli-command": "authorizations update", "x-cli-version": "2.5" }, "delete": { @@ -14137,9 +14230,10 @@ }, { "lang": "CLI v2", - "source": "phrase authorizations delete \\\n--id " + "source": "phrase authorizations delete \\\n --id \\\n --access_token " } ], + "x-cli-command": "authorizations delete", "x-cli-version": "2.5" } }, @@ -14287,9 +14381,10 @@ }, { "lang": "CLI v2", - "source": "phrase comments list \\\n--project_id \\\n--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 " + "source": "phrase comments list \\\n --project_id \\\n --key_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --query \"Some comment content\" \\\n --locale_ids '[\"someId\"]' \\\n --filters '[\"read\",\"unread\"]' \\\n --order \"desc\" \\\n --access_token " } ], + "x-cli-command": "comments list", "x-cli-version": "2.5" }, "post": { @@ -14359,7 +14454,7 @@ }, { "lang": "CLI v2", - "source": "phrase comments create \\\n--project_id \\\n--key_id \\\n--data '{\"branch\":\"my-feature-branch\", \"message\": \"Some message...\", \"locale_ids\": [\"someId\"]}' \\\n--access_token " + "source": "phrase comments create \\\n --project_id \\\n --key_id \\\n --data '{ \"message\": \"Some message...\", \"branch\": \"my-feature-branch\", \"locale_ids\": [\"someId\",\"someOtherId\"] }' \\\n --access_token " } ], "requestBody": { @@ -14399,6 +14494,7 @@ } } }, + "x-cli-command": "comments create", "x-cli-version": "2.5" } }, @@ -14479,9 +14575,10 @@ }, { "lang": "CLI v2", - "source": "phrase comments show \\\n--project_id \\\n--key_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase comments show \\\n --project_id \\\n --key_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comments show", "x-cli-version": "2.5" }, "patch": { @@ -14554,7 +14651,7 @@ }, { "lang": "CLI v2", - "source": "phrase comments update \\\n--project_id \\\n--key_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"message\": \"Some message...\"}' \\\n--access_token " + "source": "phrase comments update \\\n --project_id \\\n --key_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"message\": \"Some message...\" }' \\\n --access_token " } ], "requestBody": { @@ -14580,6 +14677,7 @@ } } }, + "x-cli-command": "comments update", "x-cli-version": "2.5" }, "delete": { @@ -14643,9 +14741,10 @@ }, { "lang": "CLI v2", - "source": "phrase comments delete \\\n--project_id \\\n--key_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase comments delete \\\n --project_id \\\n --key_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comments delete", "x-cli-version": "2.5" } }, @@ -14702,7 +14801,7 @@ }, { "lang": "CLI v2", - "source": "phrase comments mark \\\n--project_id \\\n--key_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase comments mark_read \\\n --project_id \\\n --key_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -14723,6 +14822,7 @@ } } }, + "x-cli-command": "comments mark_read", "x-cli-version": "2.5" }, "delete": { @@ -14786,9 +14886,10 @@ }, { "lang": "CLI v2", - "source": "phrase comments mark \\\n--project_id \\\n--key_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase comments mark_unread \\\n --project_id \\\n --key_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comments mark_unread", "x-cli-version": "2.5" }, "get": { @@ -14849,9 +14950,10 @@ }, { "lang": "CLI v2", - "source": "phrase comments mark \\\n--project_id \\\n--key_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase comments mark_check \\\n --project_id \\\n --key_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comments mark_check", "x-cli-version": "2.5" } }, @@ -14943,9 +15045,10 @@ }, { "lang": "CLI v2", - "source": "phrase reactions list \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase comment_reactions list \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comment_reactions list", "x-cli-version": "2.9" }, "post": { @@ -15029,9 +15132,10 @@ }, { "lang": "CLI v2", - "source": "phrase reactions create \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--data '{\"branch\":\"my-feature-branch\", \"emoji\": \"👍\"]}' \\\n--access_token " + "source": "phrase comment_reactions create \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --branch \"my-feature-branch\" \\\n --emoji \"👍\" \\\n --access_token " } ], + "x-cli-command": "comment_reactions create", "x-cli-version": "2.9" } }, @@ -15111,9 +15215,10 @@ }, { "lang": "CLI v2", - "source": "phrase reactions show \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase comment_reactions show \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comment_reactions show", "x-cli-version": "2.9" }, "delete": { @@ -15173,9 +15278,10 @@ }, { "lang": "CLI v2", - "source": "phrase reactions delete \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase comment_reactions delete \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comment_reactions delete", "x-cli-version": "2.9" } }, @@ -15300,9 +15406,10 @@ }, { "lang": "CLI v2", - "source": "phrase replies list \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--branch \"my-feature-branch\" \\\n--filters unread \\\n--order desc \\\n--query \"Some comment content\" \\\n--access_token " + "source": "phrase comment_replies list \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --query \"Some comment content\" \\\n --filters '[\"read\",\"unread\"]' \\\n --order \"desc\" \\\n --access_token " } ], + "x-cli-command": "comment_replies list", "x-cli-version": "2.10" }, "post": { @@ -15394,9 +15501,10 @@ }, { "lang": "CLI v2", - "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 " + "source": "phrase comment_replies create \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --data '{ \"message\": \"Some message...\", \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], + "x-cli-command": "comment_replies create", "x-cli-version": "2.10" } }, @@ -15476,9 +15584,10 @@ }, { "lang": "CLI v2", - "source": "phrase replies show \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"]}' \\\n--access_token " + "source": "phrase comment_replies show \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comment_replies show", "x-cli-version": "2.10" }, "delete": { @@ -15538,9 +15647,10 @@ }, { "lang": "CLI v2", - "source": "phrase replies delete \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"]}' \\\n--access_token " + "source": "phrase comment_replies delete \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comment_replies delete", "x-cli-version": "2.10" } }, @@ -15602,9 +15712,10 @@ }, { "lang": "CLI v2", - "source": "phrase replies mark_as_read \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"]}' \\\n--access_token " + "source": "phrase comment_replies mark_as_read \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comment_replies mark_as_read", "x-cli-version": "2.10" } }, @@ -15666,9 +15777,10 @@ }, { "lang": "CLI v2", - "source": "phrase replies mark_as_unread \\\n--project_id \\\n--key_id \\\n--comment_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"]}' \\\n--access_token " + "source": "phrase comment_replies mark_as_unread \\\n --project_id \\\n --key_id \\\n --comment_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "comment_replies mark_as_unread", "x-cli-version": "2.10" } }, @@ -15749,9 +15861,10 @@ }, { "lang": "CLI v2", - "source": "phrase webhooks list \\\n--project_id \\\n--access_token " + "source": "phrase webhooks list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "webhooks list", "x-cli-version": "2.5" }, "post": { @@ -15818,7 +15931,7 @@ }, { "lang": "CLI v2", - "source": "phrase webhooks create \\\n--project_id \\\n--data '{\"callback_url\": \"http://example.com/hooks/phraseapp-notifications\", \"description\": \"My webhook for chat notifications\", \"events\": \"locales:create,translations:update\"}' \\\n--access_token " + "source": "phrase webhooks create \\\n --project_id \\\n --data '{ \"callback_url\": \"http://example.com/hooks/phraseapp-notifications\", \"secret\": \"secr3t\", \"description\": \"My webhook for chat notifications\", \"events\": \"locales:create,translations:update\", \"active\": null, \"include_branches\": null }' \\\n --access_token " } ], "requestBody": { @@ -15867,6 +15980,7 @@ } } }, + "x-cli-command": "webhooks create", "x-cli-version": "2.5" } }, @@ -15935,9 +16049,10 @@ }, { "lang": "CLI v2", - "source": "phrase webhooks show \\\n--project_id \\\n--id \\\n--access_token " + "source": "phrase webhooks show \\\n --project_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "webhooks show", "x-cli-version": "2.5" }, "patch": { @@ -16007,7 +16122,7 @@ }, { "lang": "CLI v2", - "source": "phrase webhooks update \\\n--project_id \\\n--id \\\n--data '{\"callback_url\": \"http://example.com/hooks/phraseapp-notifications\", \"description\": \"My webhook for chat notifications\", \"events\": \"locales:create,translations:update\"}' \\\n--access_token " + "source": "phrase webhooks update \\\n --project_id \\\n --id \\\n --data '{ \"callback_url\": \"http://example.com/hooks/phraseapp-notifications\", \"secret\": \"secr3t\", \"description\": \"My webhook for chat notifications\", \"events\": \"locales:create,translations:update\", \"active\": null, \"include_branches\": null }' \\\n --access_token " } ], "requestBody": { @@ -16053,6 +16168,7 @@ } } }, + "x-cli-command": "webhooks update", "x-cli-version": "2.5" }, "delete": { @@ -16104,9 +16220,10 @@ }, { "lang": "CLI v2", - "source": "phrase webhooks delete \\\n--project_id \\\n--id \\\n--access_token " + "source": "phrase webhooks delete \\\n --project_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "webhooks delete", "x-cli-version": "2.5" } }, @@ -16178,9 +16295,10 @@ }, { "lang": "CLI v2", - "source": "phrase webhooks test \\\n--project_id \\\n--id \\\n--access_token " + "source": "phrase webhooks test \\\n --project_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "webhooks test", "x-cli-version": "2.5" } }, @@ -16249,7 +16367,7 @@ }, { "lang": "CLI v2", - "source": "phrase uploads create \\\n--project_id \\\n--branch my-feature-branch \\\n--file /path/to/my/file.json \\\n--file_format json \\\n--locale_id abcd1234cdef1234abcd1234cdef1234 \\\n--tags awesome-feature,needs-proofreading \\\n--locale_mapping '{\"en\": \"2\"}' \\\n--format_options '{\"foo\": \"bar\"}' \\\n--access_token " + "source": "phrase uploads create \\\n --project_id \\\n --file \\\n --file_format \"fileFormat_example\" \\\n --locale_id \"localeId_example\" \\\n --branch \"branch_example\" \\\n --tags \"tags_example\" \\\n --update_translations true \\\n --update_custom_metadata true \\\n --update_translation_keys true \\\n --update_translations_on_source_match true \\\n --source_locale_id \"sourceLocaleId_example\" \\\n --update_descriptions true \\\n --convert_emoji true \\\n --skip_upload_tags true \\\n --skip_unverification true \\\n --file_encoding \"fileEncoding_example\" \\\n --locale_mapping '{ }' \\\n --format_options '{ }' \\\n --autotranslate true \\\n --verify_mentioned_translations true \\\n --mark_reviewed true \\\n --tag_only_affected_keys true \\\n --translation_key_prefix \"translationKeyPrefix_example\" \\\n --skip_automated_job_creation true \\\n --access_token " } ], "requestBody": { @@ -16395,6 +16513,7 @@ } } }, + "x-cli-command": "uploads create", "x-cli-version": "2.12" }, "get": { @@ -16482,9 +16601,10 @@ }, { "lang": "CLI v2", - "source": "phrase uploads list \\\n--project_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase uploads list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "uploads list", "x-cli-version": "2.5" } }, @@ -16562,9 +16682,10 @@ }, { "lang": "CLI v2", - "source": "phrase uploads show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase uploads show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "uploads show", "x-cli-version": "2.5" } }, @@ -16712,9 +16833,10 @@ }, { "lang": "CLI v2", - "source": "phrase upload_batches create --project-id :project_id \\\n--data '{\n \"branch\": \"my-feature-branch\",\n \"delete_unmentioned_keys\": true,\n \"upload_ids\": [\n \"abcd1234cdef1234abcd1234cdef1234\",\n \"bcde2345defg2345bcde2345defg2345\"\n ]\n}' \\\n--access_token " + "source": "phrase upload_batches create \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"delete_unmentioned_keys\": true, \"upload_ids\": [\"abcd1234cdef1234abcd1234cdef1234\",\"bcde2345defg2345bcde2345defg2345\"] }' \\\n --access_token " } - ] + ], + "x-cli-command": "upload_batches create" } }, "/projects/{project_id}/translations/{translation_id}/versions": { @@ -16816,9 +16938,10 @@ }, { "lang": "CLI v2", - "source": "phrase versions list \\\n--project_id \\\n--translation_id \\\n--branch my-feature-branch \\\n--only_content_updates true \\\n--access_token " + "source": "phrase versions_history list \\\n --project_id \\\n --translation_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --only_content_updates true \\\n --access_token " } ], + "x-cli-command": "versions_history list", "x-cli-version": "2.5" } }, @@ -16899,9 +17022,10 @@ }, { "lang": "CLI v2", - "source": "phrase versions show \\\n--project_id \\\n--translation_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase versions_history show \\\n --project_id \\\n --translation_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "versions_history show", "x-cli-version": "2.5" } }, @@ -16976,7 +17100,7 @@ }, { "lang": "CLI v2", - "source": "phrase glossary_term_translations create \\\n--account_id \\\n--glossary_id \\\n--term_id \\\n--data '{\"locale_code\":\"en-US\", \"content\": \"My translated term\"}' \\\n--access_token " + "source": "phrase glossary_term_translations create \\\n --account_id \\\n --glossary_id \\\n --term_id \\\n --data '{ \"locale_code\": \"en-US\", \"content\": \"My translated term\" }' \\\n --access_token " } ], "requestBody": { @@ -17006,6 +17130,7 @@ } } }, + "x-cli-command": "glossary_term_translations create", "x-cli-version": "2.5" } }, @@ -17083,7 +17208,7 @@ }, { "lang": "CLI v2", - "source": "phrase glossary_term_translations update \\\n--account_id \\\n--glossary_id \\\n--term_id \\\n--id \\\n--data '{\"locale_code\":\"en-US\", \"content\": \"My translated term\"}' \\\n--access_token " + "source": "phrase glossary_term_translations update \\\n --account_id \\\n --glossary_id \\\n --term_id \\\n --id \\\n --data '{ \"locale_code\": \"en-US\", \"content\": \"My translated term\" }' \\\n --access_token " } ], "requestBody": { @@ -17109,6 +17234,7 @@ } } }, + "x-cli-command": "glossary_term_translations update", "x-cli-version": "2.5" }, "delete": { @@ -17166,9 +17292,10 @@ }, { "lang": "CLI v2", - "source": "phrase glossary_term_translations delete \\\n--account_id \\\n--glossary_id \\\n--term_id \\\n--id \\\n--access_token " + "source": "phrase glossary_term_translations delete \\\n --account_id \\\n --glossary_id \\\n --term_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "glossary_term_translations delete", "x-cli-version": "2.5" } }, @@ -17289,9 +17416,10 @@ }, { "lang": "CLI v2", - "source": "phrase projects list \\\n--access_token " + "source": "phrase projects list \\\n --page \"1\" \\\n --per_page \"25\" \\\n --account_id \"accountId_example\" \\\n --sort_by \"sortBy_example\" \\\n --filters 'favorites' \\\n --q \"name:android\" \\\n --access_token " } ], + "x-cli-command": "projects list", "x-cli-version": "2.5" }, "post": { @@ -17355,7 +17483,7 @@ }, { "lang": "CLI v2", - "source": "phrase projects create \\\n--data '{\"name\": \"My Android Project\", \"main_format\":\"yml\", \"shares_translation_memory\":true}' \\\n--access_token " + "source": "phrase projects create \\\n --data '{ \"name\": \"My Android Project\", \"main_format\": \"yml\", \"media\": \"Python\", \"shares_translation_memory\": true, \"project_image\": \"\", \"remove_project_image\": null, \"account_id\": \"abcd1234\", \"point_of_contact\": \"abcd1234\", \"source_project_id\": \"abcd1234\", \"workflow\": \"review\", \"machine_translation_enabled\": true, \"enable_branching\": true, \"protect_master_branch\": true, \"enable_all_data_type_translation_keys_for_translators\": true, \"enable_icu_message_format\": true, \"zero_plural_form_enabled\": true, \"autotranslate_enabled\": true, \"autotranslate_check_new_translation_keys\": true, \"autotranslate_check_new_uploads\": true, \"autotranslate_check_new_locales\": true, \"autotranslate_mark_as_unverified\": true, \"autotranslate_use_machine_translation\": true, \"autotranslate_use_translation_memory\": true, \"autotranslate_overwrite_unverified_translations\": true, \"autocomplete_job_enabled\": false, \"job_locking_enabled\": false, \"smart_suggest_enabled\": true, \"smart_suggest_use_glossary\": true, \"smart_suggest_use_machine_translation\": true, \"translation_keys_sort_collation\": \"unicode_ci\", \"default_encoding\": \"UTF-8\", \"cldr_version\": \"cldr48\", \"placeholder_styles\": [\"angular\",\"iOS\"] }' \\\n --access_token " } ], "requestBody": { @@ -17553,6 +17681,7 @@ } } }, + "x-cli-command": "projects create", "x-cli-version": "2.6.3" } }, @@ -17618,9 +17747,10 @@ }, { "lang": "CLI v2", - "source": "phrase projects show \\\n--id \\\n--access_token " + "source": "phrase projects show \\\n --id \\\n --access_token " } ], + "x-cli-command": "projects show", "x-cli-version": "2.5" }, "patch": { @@ -17687,7 +17817,7 @@ }, { "lang": "CLI v2", - "source": "phrase projects update \\\n--id \\\n--data '{\"name\": \"My Android Project\", \"main_format\":\"yml\", \"shares_translation_memory\":true}' \\\n--access_token " + "source": "phrase projects update \\\n --id \\\n --data '{ \"account_id\": \"abcd1234\", \"name\": \"My Android Project\", \"point_of_contact\": \"abcd1234\", \"main_format\": \"yml\", \"media\": \"Python\", \"shares_translation_memory\": true, \"project_image\": \"\", \"remove_project_image\": false, \"workflow\": \"review\", \"machine_translation_enabled\": true, \"enable_branching\": true, \"protect_master_branch\": true, \"enable_all_data_type_translation_keys_for_translators\": true, \"enable_icu_message_format\": true, \"zero_plural_form_enabled\": true, \"autotranslate_enabled\": true, \"autotranslate_check_new_translation_keys\": true, \"autotranslate_check_new_uploads\": true, \"autotranslate_check_new_locales\": true, \"autotranslate_mark_as_unverified\": true, \"autotranslate_use_machine_translation\": true, \"autotranslate_use_translation_memory\": true, \"autotranslate_overwrite_unverified_translations\": true, \"default_encoding\": \"UTF-8\", \"placeholder_styles\": [\"angular\",\"iOS\"], \"autocomplete_job_enabled\": false, \"job_locking_enabled\": false, \"smart_suggest_enabled\": true, \"smart_suggest_use_glossary\": true, \"smart_suggest_use_machine_translation\": true, \"translation_keys_sort_collation\": \"unicode_ci\", \"cldr_version\": \"legacy\" }' \\\n --access_token " } ], "requestBody": { @@ -17877,6 +18007,7 @@ } } }, + "x-cli-command": "projects update", "x-cli-version": "2.6.3" }, "delete": { @@ -17925,9 +18056,10 @@ }, { "lang": "CLI v2", - "source": "phrase projects delete \\\n--id \\\n--access_token " + "source": "phrase projects delete \\\n --id \\\n --access_token " } ], + "x-cli-command": "projects delete", "x-cli-version": "2.5" } }, @@ -18010,9 +18142,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_locales list \\\n--project_id \\\n--job_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_locales list \\\n --project_id \\\n --job_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --include_annotations true \\\n --access_token " } ], + "x-cli-command": "job_locales list", "x-cli-version": "2.5" }, "post": { @@ -18072,7 +18205,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_locales create \\\n--project_id \\\n--job_id \\\n--data '{\"branch\":\"my-feature-branch\", \"locale_id\":\"abcd1234cdef1234abcd1234cdef1234\", \"user_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"translator_team_ids\": \"abcd1234cdef1234abcd1234cdef1234\"}' \\\n--access_token " + "source": "phrase job_locales create \\\n --project_id \\\n --job_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"locale_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"user_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"translator_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -18141,6 +18274,7 @@ } } }, + "x-cli-command": "job_locales create", "x-cli-version": "2.6.8" } }, @@ -18211,9 +18345,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_locales show \\\n--project_id \\\n--job_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_locales show \\\n --project_id \\\n --job_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --include_annotations true \\\n --access_token " } ], + "x-cli-command": "job_locales show", "x-cli-version": "2.9.0" }, "patch": { @@ -18276,7 +18411,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_locales update \\\n--project_id \\\n--job_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"locale_id\":\"abcd1234cdef1234abcd1234cdef1234\", \"user_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"team_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"translator_team_ids\": \"abcd1234cdef1234abcd1234cdef1234\"}' \\\n--access_token " + "source": "phrase job_locales update \\\n --project_id \\\n --job_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"locale_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"user_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"translator_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -18342,6 +18477,7 @@ } } }, + "x-cli-command": "job_locales update", "x-cli-version": "2.6.8" }, "delete": { @@ -18389,9 +18525,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_locales delete \\\n--project_id \\\n--job_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_locales delete \\\n --project_id \\\n --job_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_locales delete", "x-cli-version": "2.5" } }, @@ -18456,7 +18593,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_locales complete \\\n--project_id \\\n--job_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase job_locales complete \\\n --project_id \\\n --job_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -18477,6 +18614,7 @@ } } }, + "x-cli-command": "job_locales complete", "x-cli-version": "2.5" } }, @@ -18541,7 +18679,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_locales complete \\\n--project_id \\\n--job_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase job_locales complete_review \\\n --project_id \\\n --job_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -18562,6 +18700,7 @@ } } }, + "x-cli-command": "job_locales complete_review", "x-cli-version": "2.5" } }, @@ -18626,7 +18765,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_locales reopen \\\n--project_id \\\n--job_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase job_locales reopen \\\n --project_id \\\n --job_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -18647,6 +18786,7 @@ } } }, + "x-cli-command": "job_locales reopen", "x-cli-version": "2.5" } }, @@ -18732,9 +18872,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_template_locales list \\\n--project_id \\\n--job_template_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_template_locales list \\\n --project_id \\\n --job_template_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_template_locales list", "x-cli-version": "2.5" }, "post": { @@ -18794,7 +18935,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_template_locales create \\\n--project_id \\\n--job_template_id \\\n--data '{\"branch\":\"my-feature-branch\", \"locale_id\":\"abcd1234cdef1234abcd1234cdef1234\", \"user_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"reviewer_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"translator_team_ids\":\"abcd1234cdef1234abcd1234cdef1234\"}' \\\n--access_token " + "source": "phrase job_template_locales create \\\n --project_id \\\n --job_template_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"locale_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"user_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"translator_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -18863,6 +19004,7 @@ } } }, + "x-cli-command": "job_template_locales create", "x-cli-version": "2.6.8" } }, @@ -18936,9 +19078,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_template_locales show \\\n--project_id \\\n--job_template_id \\\n--job_template_locale_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_template_locales show \\\n --project_id \\\n --job_template_id \\\n --job_template_locale_id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_template_locales show", "x-cli-version": "2.6.8" }, "patch": { @@ -19001,7 +19144,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_template_locales update \\\n--project_id \\\n--job_template_id \\\n--job_template_locale_id \\\n--data '{\"branch\":\"my-feature-branch\", \"locale_id\":\"abcd1234cdef1234abcd1234cdef1234\", \"user_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"reviewer_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"translator_team_ids\": \"abcd1234cdef1234abcd1234cdef1234\"}' \\\n--access_token " + "source": "phrase job_template_locales update \\\n --project_id \\\n --job_template_id \\\n --job_template_locale_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"locale_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"user_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"translator_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -19067,6 +19210,7 @@ } } }, + "x-cli-command": "job_template_locales update", "x-cli-version": "2.6.8" }, "delete": { @@ -19120,9 +19264,10 @@ }, { "lang": "CLI v2", - "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 " + "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 " } ], + "x-cli-command": "job_template_locales delete", "x-cli-version": "2.5" } }, @@ -19181,9 +19326,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_annotations list \\\n--project_id \\\n--job_id \\\n--access_token " + "source": "phrase job_annotations list \\\n --project_id \\\n --job_id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_annotations list", "x-cli-version": "2.43" } }, @@ -19254,7 +19400,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_annotations update \\\n--project_id \\\n--job_id \\\n--id \\\n--data '{\"value\": \"Some value...\"}' \\\n--access_token " + "source": "phrase job_annotations update \\\n --project_id \\\n --job_id \\\n --id \\\n --data '{ \"value\": \"Some value...\", \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -19280,6 +19426,7 @@ } } }, + "x-cli-command": "job_annotations update", "x-cli-version": "2.43" }, "delete": { @@ -19344,9 +19491,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_annotations delete \\\n--project_id \\\n--job_id \\\n--id \\\n--access_token " + "source": "phrase job_annotations delete \\\n --project_id \\\n --job_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_annotations delete", "x-cli-version": "2.43" } }, @@ -19408,9 +19556,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_locale_annotations list \\\n--project_id \\\n--job_id \\\n--job_locale_id \\\n--access_token " + "source": "phrase job_annotations list \\\n --project_id \\\n --job_id \\\n --job_locale_id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_annotations list", "x-cli-version": "2.43" } }, @@ -19484,7 +19633,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_locale_annotations update \\\n--project_id \\\n--job_id \\\n--job_locale_id \\\n--id \\\n--data '{\"value\": \"Some value...\"}' \\\n--access_token " + "source": "phrase job_annotations update \\\n --project_id \\\n --job_id \\\n --job_locale_id \\\n --id \\\n --data '{ \"value\": \"Some value...\", \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -19510,6 +19659,7 @@ } } }, + "x-cli-command": "job_annotations update", "x-cli-version": "2.43" }, "delete": { @@ -19577,9 +19727,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_locale_annotations delete \\\n--project_id \\\n--job_id \\\n--job_locale_id \\\n--id \\\n--access_token " + "source": "phrase job_annotations delete \\\n --project_id \\\n --job_id \\\n --job_locale_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_annotations delete", "x-cli-version": "2.43" } }, @@ -19660,9 +19811,10 @@ }, { "lang": "CLI v2", - "source": "phrase variables list \\\n--project_id \\\n--access_token " + "source": "phrase variables list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "variables list", "x-cli-version": "2.5" }, "post": { @@ -19729,7 +19881,7 @@ }, { "lang": "CLI v2", - "source": "phrase variables create \\\n--project_id \\\n--data '{\"name\":\"MY_VARIABLE\", \"value\":\"Hello World\"}' \\\n--access_token " + "source": "phrase variables create \\\n --project_id \\\n --data '{ \"name\": \"MY_VARIABLE\", \"value\": \"Hello World\" }' \\\n --access_token " } ], "requestBody": { @@ -19758,6 +19910,7 @@ } } }, + "x-cli-command": "variables create", "x-cli-version": "2.5" } }, @@ -19826,9 +19979,10 @@ }, { "lang": "CLI v2", - "source": "phrase variables show \\\n--project_id \\\n--name \\\n--access_token " + "source": "phrase variables show \\\n --project_id \\\n --name \\\n --access_token " } ], + "x-cli-command": "variables show", "x-cli-version": "2.5" }, "patch": { @@ -19898,7 +20052,7 @@ }, { "lang": "CLI v2", - "source": "phrase variables update \\\n--project_id \\\n--name \\\n--data '{\"name\":\"MY_VARIABLE\",\"value\":\"Hello World\"}' \\\n--access_token " + "source": "phrase variables update \\\n --project_id \\\n --name \\\n --data '{ \"name\": \"MY_VARIABLE\", \"value\": \"Hello World\" }' \\\n --access_token " } ], "requestBody": { @@ -19924,6 +20078,7 @@ } } }, + "x-cli-command": "variables update", "x-cli-version": "2.5" }, "delete": { @@ -19975,9 +20130,10 @@ }, { "lang": "CLI v2", - "source": "phrase variables delete \\\n--project_id \\\n--name \\\n--access_token " + "source": "phrase variables delete \\\n --project_id \\\n --name \\\n --access_token " } ], + "x-cli-command": "variables delete", "x-cli-version": "2.5" } }, @@ -20058,9 +20214,10 @@ }, { "lang": "CLI v2", - "source": "phrase branches list \\\n--project_id \\\n--access_token " + "source": "phrase branches list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "branches list", "x-cli-version": "2.5" }, "post": { @@ -20127,7 +20284,7 @@ }, { "lang": "CLI v2", - "source": "phrase branches create \\\n--project_id \\\n--data '{\"name\":\"my-branch\"}' \\\n--access_token " + "source": "phrase branches create \\\n --project_id \\\n --data '{ \"name\": \"my-branch\", \"base\": \"parent-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -20156,6 +20313,7 @@ } } }, + "x-cli-command": "branches create", "x-cli-version": "2.5" } }, @@ -20224,9 +20382,10 @@ }, { "lang": "CLI v2", - "source": "phrase branches show \\\n--project_id \\\n--name \\\n--access_token " + "source": "phrase branches show \\\n --project_id \\\n --name \\\n --access_token " } ], + "x-cli-command": "branches show", "x-cli-version": "2.5" }, "patch": { @@ -20296,7 +20455,7 @@ }, { "lang": "CLI v2", - "source": "phrase branches update \\\n--project_id \\\n--name \\\n--data '{\"name\":\"my-branch\"}' \\\n--access_token " + "source": "phrase branches update \\\n --project_id \\\n --name \\\n --data '{ \"name\": \"my-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -20317,6 +20476,7 @@ } } }, + "x-cli-command": "branches update", "x-cli-version": "2.5" }, "delete": { @@ -20372,9 +20532,10 @@ }, { "lang": "CLI v2", - "source": "phrase branches delete \\\n--project_id \\\n--name \\\n--access_token " + "source": "phrase branches delete \\\n --project_id \\\n --name \\\n --access_token " } ], + "x-cli-command": "branches delete", "x-cli-version": "2.5" } }, @@ -20443,7 +20604,7 @@ }, { "lang": "CLI v2", - "source": "phrase branches merge \\\n--project_id \\\n--name \\\n--data '{\"strategy\":\"use_main\"}' \\\n--access_token " + "source": "phrase branches merge \\\n --project_id \\\n --name \\\n --data '{ \"strategy\": \"use_main\" }' \\\n --access_token " } ], "requestBody": { @@ -20467,7 +20628,8 @@ } } } - } + }, + "x-cli-command": "branches merge" } }, "/projects/{project_id}/branches/{name}/sync": { @@ -20531,7 +20693,7 @@ }, { "lang": "CLI v2", - "source": "phrase branches sync \\\n--project_id \\\n--name \\\n--data '{\"strategy\":\"use_main\"}' \\\n--access_token " + "source": "phrase branches sync \\\n --project_id \\\n --name \\\n --data '{ \"strategy\": \"use_main\" }' \\\n --access_token " } ], "requestBody": { @@ -20555,7 +20717,8 @@ } } } - } + }, + "x-cli-command": "branches sync" } }, "/projects/{project_id}/branches/{name}/compare": { @@ -20629,9 +20792,10 @@ }, { "lang": "CLI v2", - "source": "phrase branches compare \\\n--project_id \\\n--name \\\n--name my-branch \\\n--access_token " + "source": "phrase branches compare \\\n --project_id \\\n --name \\\n --access_token " } ], + "x-cli-command": "branches compare", "x-cli-version": "2.5" }, "post": { @@ -20677,7 +20841,7 @@ }, { "lang": "CLI v2", - "source": "phrase branches create_comparison \\\n--project_id \\\n--name \\\n--access_token " + "source": "phrase branches comparison_create \\\n --project_id \\\n --name \\\n --data '{ \"direction\": \"merge\" }' \\\n --access_token " } ], "requestBody": { @@ -20698,7 +20862,8 @@ } } } - } + }, + "x-cli-command": "branches comparison_create" } }, "/accounts": { @@ -20775,9 +20940,10 @@ }, { "lang": "CLI v2", - "source": "phrase accounts list \\\n--access_token " + "source": "phrase accounts list \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "accounts list", "x-cli-version": "2.5" } }, @@ -20843,9 +21009,10 @@ }, { "lang": "CLI v2", - "source": "phrase accounts show \\\n--id \\\n--access_token " + "source": "phrase accounts show \\\n --id \\\n --access_token " } ], + "x-cli-command": "accounts show", "x-cli-version": "2.5" } }, @@ -20908,9 +21075,10 @@ }, { "lang": "CLI v2", - "source": "phrase shows user \\\n--access_token " + "source": "phrase users user \\\n --access_token " } ], + "x-cli-command": "users user", "x-cli-version": "2.5" } }, @@ -20990,9 +21158,10 @@ }, { "lang": "CLI v2", - "source": "phrase members list \\\n--account_id \\\n--access_token " + "source": "phrase members list \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "members list", "x-cli-version": "2.5" } }, @@ -21060,9 +21229,10 @@ }, { "lang": "CLI v2", - "source": "phrase members show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase members show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "members show", "x-cli-version": "2.5" }, "patch": { @@ -21131,7 +21301,7 @@ }, { "lang": "CLI v2", - "source": "phrase members update \\\n--account_id \\\n--id \\\n--data '{\"role\":\"Developer\", \"strategy\":\"set\", \"project_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"locale_ids\":\"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"default_locale_codes\":[\"de\",\"en\"], \"space_ids\":[\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"], \"permissions\":\"{\"create_upload\"=>true, \"review_translations\"=>true}\"}' \\\n--access_token " + "source": "phrase members update \\\n --account_id \\\n --id \\\n --data '{ \"strategy\": \"set\", \"role\": \"Developer\", \"project_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"locale_ids\": \"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235\", \"default_locale_codes\": [\"en\",\"fi\"], \"space_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"], \"permissions\": {\"create_upload\":true,\"review_translations\":true} }' \\\n --access_token " } ], "requestBody": { @@ -21200,6 +21370,7 @@ } } }, + "x-cli-command": "members update", "x-cli-version": "2.5" }, "delete": { @@ -21250,9 +21421,10 @@ }, { "lang": "CLI v2", - "source": "phrase members delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase members delete \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "members delete", "x-cli-version": "2.5" } }, @@ -21323,7 +21495,7 @@ }, { "lang": "CLI v2", - "source": "phrase members update_settings \\\n--project_id \\\n--id \\\n--data '{\"project_role\":\"Developer\",\"locale_ids\":[\"fff565db236400772368235db2c6117e\",\"fff565db236400772368235db2c6117f\"]}' \\\n--access_token " + "source": "phrase members update_settings \\\n --project_id \\\n --id \\\n --data '{ \"project_role\": \"Developer\", \"locale_ids\": [\"abcd1234abcd1234abcd1234\",\"abcd1234abcd1234abcd1235\"] }' \\\n --access_token " } ], "requestBody": { @@ -21355,6 +21527,7 @@ } } }, + "x-cli-command": "members update_settings", "x-cli-version": "2.5" } }, @@ -21453,9 +21626,10 @@ }, { "lang": "CLI v2", - "source": "phrase screenshots list \\\n--project_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase screenshots list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --key_id \"abcd1234cdef1234abcd1234cdef1234\" \\\n --access_token " } ], + "x-cli-command": "screenshots list", "x-cli-version": "2.5" }, "post": { @@ -21530,7 +21704,7 @@ }, { "lang": "CLI v2", - "source": "phrase screenshots create \\\n --project_id \\\n --branch \"my-feature-branch\" \\\n --name \"home_screen\" \\\n --description \"Main landing page hero section\" \\\n --filename \"/path/to/home_screen.png\" \\\n --access_token " + "source": "phrase screenshots create \\\n --project_id \\\n --filename \\\n --branch \"branch_example\" \\\n --name \"name_example\" \\\n --description \"description_example\" \\\n --access_token " } ], "requestBody": { @@ -21576,6 +21750,7 @@ } } }, + "x-cli-command": "screenshots create", "x-cli-version": "2.5" } }, @@ -21653,9 +21828,10 @@ }, { "lang": "CLI v2", - "source": "phrase screenshots show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase screenshots show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "screenshots show", "x-cli-version": "2.5" }, "patch": { @@ -21725,7 +21901,7 @@ }, { "lang": "CLI v2", - "source": "phrase screenshots update \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\": \"A screenshot name\", \"description\": \"A screenshot description\", \"filename\":\"/path/to/my/screenshot.png\"}' \\\n--access_token " + "source": "phrase screenshots update \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"A screenshot name\", \"description\": \"A screenshot description\", \"filename\": \"\" }' \\\n --access_token " } ], "requestBody": { @@ -21762,6 +21938,7 @@ } } }, + "x-cli-command": "screenshots update", "x-cli-version": "2.5" }, "delete": { @@ -21822,9 +21999,10 @@ }, { "lang": "CLI v2", - "source": "phrase screenshots delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase screenshots delete \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "screenshots delete", "x-cli-version": "2.5" } }, @@ -21908,9 +22086,10 @@ }, { "lang": "CLI v2", - "source": "phrase glossary_terms list \\\n--account_id \\\n--glossary_id \\\n--access_token " + "source": "phrase glossary_terms list \\\n --account_id \\\n --glossary_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "glossary_terms list", "x-cli-version": "2.5" }, "post": { @@ -21980,7 +22159,7 @@ }, { "lang": "CLI v2", - "source": "phrase glossary_terms create \\\n--account_id \\\n--glossary_id \\\n--data '{\"term\":\"MyCompany\", \"description\": \"Use this when refering to our company\", \"translatable\":true, \"case_sensitive\":true}' \\\n--access_token " + "source": "phrase glossary_terms create \\\n --account_id \\\n --glossary_id \\\n --data '{ \"term\": \"MyCompany\", \"description\": \"Use this when refering to our company\", \"translatable\": true, \"case_sensitive\": true }' \\\n --access_token " } ], "requestBody": { @@ -22019,6 +22198,7 @@ } } }, + "x-cli-command": "glossary_terms create", "x-cli-version": "2.5" } }, @@ -22090,9 +22270,10 @@ }, { "lang": "CLI v2", - "source": "phrase glossary_terms show \\\n--account_id \\\n--glossary_id \\\n--id \\\n--access_token " + "source": "phrase glossary_terms show \\\n --account_id \\\n --glossary_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "glossary_terms show", "x-cli-version": "2.5" }, "patch": { @@ -22165,7 +22346,7 @@ }, { "lang": "CLI v2", - "source": "phrase glossary_terms update \\\n--account_id \\\n--glossary_id \\\n--id \\\n--data '{\"term\":\"MyCompany\", \"description\": \"Use this when refering to our company\", \"translatable\":true, \"case_sensitive\":true}' \\\n--access_token " + "source": "phrase glossary_terms update \\\n --account_id \\\n --glossary_id \\\n --id \\\n --data '{ \"term\": \"MyCompany\", \"description\": \"Use this when refering to our company\", \"translatable\": true, \"case_sensitive\": true }' \\\n --access_token " } ], "requestBody": { @@ -22201,6 +22382,7 @@ } } }, + "x-cli-command": "glossary_terms update", "x-cli-version": "2.5" }, "delete": { @@ -22255,9 +22437,10 @@ }, { "lang": "CLI v2", - "source": "phrase glossary_terms delete \\\n--account_id \\\n--glossary_id \\\n--id \\\n--access_token " + "source": "phrase glossary_terms delete \\\n --account_id \\\n --glossary_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "glossary_terms delete", "x-cli-version": "2.5" } }, @@ -22374,9 +22557,10 @@ }, { "lang": "CLI v2", - "source": "phrase tags list \\\n--project_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase tags list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --exclude_system_tags true \\\n --only_system_tags false \\\n --branch \"my-feature-branch\" \\\n --q \"feature\" \\\n --access_token " } ], + "x-cli-command": "tags list", "x-cli-version": "2.5" }, "post": { @@ -22443,7 +22627,7 @@ }, { "lang": "CLI v2", - "source": "phrase tags create \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"my-feature\"}' \\\n--access_token " + "source": "phrase tags create \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"my-feature\" }' \\\n --access_token " } ], "requestBody": { @@ -22472,6 +22656,7 @@ } } }, + "x-cli-command": "tags create", "x-cli-version": "2.5" } }, @@ -22558,9 +22743,10 @@ }, { "lang": "CLI v2", - "source": "phrase tags show \\\n--project_id \\\n--name \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase tags show \\\n --project_id \\\n --name \\\n --omit_statistics true \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "tags show", "x-cli-version": "2.5" }, "delete": { @@ -22621,9 +22807,10 @@ }, { "lang": "CLI v2", - "source": "phrase tags delete \\\n--project_id \\\n--name \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase tags delete \\\n --project_id \\\n --name \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "tags delete", "x-cli-version": "2.5" } }, @@ -22713,9 +22900,10 @@ }, { "lang": "CLI v2", - "source": "phrase blacklisted_keys list \\\n--project_id \\\n--access_token " + "source": "phrase blacklisted_keys list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "blacklisted_keys list", "x-cli-version": "2.5" }, "post": { @@ -22782,7 +22970,7 @@ }, { "lang": "CLI v2", - "source": "phrase blacklisted_keys create \\\n--project_id \\\n--data '{\"name\":\"'date.formats.*'\"}' \\\n--access_token " + "source": "phrase blacklisted_keys create \\\n --project_id \\\n --data '{ \"name\": \"date.formats.*\" }' \\\n --access_token " } ], "requestBody": { @@ -22806,6 +22994,7 @@ } } }, + "x-cli-command": "blacklisted_keys create", "x-cli-version": "2.5" } }, @@ -22874,9 +23063,10 @@ }, { "lang": "CLI v2", - "source": "phrase blacklisted_keys show \\\n--project_id \\\n--id \\\n--access_token " + "source": "phrase blacklisted_keys show \\\n --project_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "blacklisted_keys show", "x-cli-version": "2.5" }, "patch": { @@ -22946,7 +23136,7 @@ }, { "lang": "CLI v2", - "source": "phrase blacklisted_keys update \\\n--project_id \\\n--id \\\n--data '{\"name\":\"'date.formats.*'\"}' \\\n--access_token " + "source": "phrase blacklisted_keys update \\\n --project_id \\\n --id \\\n --data '{ \"name\": \"date.formats.*\" }' \\\n --access_token " } ], "requestBody": { @@ -22967,6 +23157,7 @@ } } }, + "x-cli-command": "blacklisted_keys update", "x-cli-version": "2.5" }, "delete": { @@ -23018,9 +23209,10 @@ }, { "lang": "CLI v2", - "source": "phrase blacklisted_keys delete \\\n--project_id \\\n--id \\\n--access_token " + "source": "phrase blacklisted_keys delete \\\n --project_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "blacklisted_keys delete", "x-cli-version": "2.5" } }, @@ -23140,9 +23332,10 @@ }, { "lang": "CLI v2", - "source": "phrase keys list \\\n--project_id \\\n--branch my-feature-branch \\\n--sort updated_at \\\n--order desc \\\n--query 'mykey* translated:true' \\\n--locale_id abcd1234abcd1234abcd1234abcd1234 \\\n--access_token " + "source": "phrase keys list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --sort \"updated_at\" \\\n --order \"desc\" \\\n --q \"mykey* translated:true\" \\\n --locale_id \"abcd1234abcd1234abcd1234abcd1234\" \\\n --access_token " } ], + "x-cli-command": "keys list", "x-cli-version": "2.5" }, "post": { @@ -23209,7 +23402,7 @@ }, { "lang": "CLI v2", - "source": "phrase keys create \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"home.index.headline\", \"description\": \"Some description worth knowing...\", \"name_plural\":\"home.index.headlines\", \"data_type\":\"number\", \"tags\":\"awesome-feature,needs-proofreading\", \"max_characters_allowed\":\"140\", \"screenshot\":\"/path/to/my/screenshot.png\", \"custom_metadata\": {\"property\" => \"value\"}}' \\\n--access_token " + "source": "phrase keys create \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"home.index.headline\", \"description\": \"Some description worth knowing...\", \"plural\": null, \"use_ordinal_rules\": null, \"name_plural\": \"home.index.headlines\", \"data_type\": \"number\", \"tags\": \"awesome-feature,needs-proofreading\", \"max_characters_allowed\": 140, \"screenshot\": \"\", \"remove_screenshot\": null, \"unformatted\": null, \"default_translation_content\": \"Default translation content\", \"autotranslate\": null, \"xml_space_preserve\": null, \"original_file\": \"null\", \"localized_format_string\": \"null\", \"localized_format_key\": \"null\", \"custom_metadata\": {\"fruit\":\"Apple\",\"vegetable\":\"Tomato\"}, \"excluded_in_locales\": [\"de\",\"fr\"], \"format_value_type\": \"string\" }' \\\n --access_token " } ], "requestBody": { @@ -23345,6 +23538,7 @@ } } }, + "x-cli-command": "keys create", "x-cli-version": "2.5" }, "delete": { @@ -23429,9 +23623,10 @@ }, { "lang": "CLI v2", - "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 " + "source": "phrase keys delete-collection \\\n --project_id \\\n --branch \"my-feature-branch\" \\\n --q \"mykey* translated:true\" \\\n --locale_id \"abcd1234abcd1234abcd1234abcd1234\" \\\n --access_token " } ], + "x-cli-command": "keys delete-collection", "x-cli-version": "2.5" } }, @@ -23509,7 +23704,7 @@ }, { "lang": "CLI v2", - "source": "phrase keys search \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"sort\":\"updated_at\", \"order\":\"desc\", \"q\":\"'mykey* translated:true'\", \"locale_id\":\"abcd1234abcd1234abcd1234abcd1234\"}' \\\n--access_token " + "source": "phrase keys search \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --data '{ \"branch\": \"my-feature-branch\", \"sort\": \"updated_at\", \"order\": \"desc\", \"q\": \"mykey* translated:true\", \"locale_id\": \"abcd1234abcd1234abcd1234abcd1234\" }' \\\n --access_token " } ], "requestBody": { @@ -23550,6 +23745,7 @@ } } }, + "x-cli-command": "keys search", "x-cli-version": "2.5" } }, @@ -23627,9 +23823,10 @@ }, { "lang": "CLI v2", - "source": "phrase keys show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase keys show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "keys show", "x-cli-version": "2.5" }, "patch": { @@ -23699,7 +23896,7 @@ }, { "lang": "CLI v2", - "source": "phrase keys update \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"home.index.headline\", \"description\": \"Some description worth knowing...\", \"name_plural\":\"home.index.headlines\", \"data_type\":\"number\", \"tags\":\"awesome-feature,needs-proofreading\", \"max_characters_allowed\":\"140\", \"screenshot\":\"/path/to/my/screenshot.png\", \"custom_metadata\": {\"property\" => \"value\"}}' \\\n--access_token " + "source": "phrase keys update \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"home.index.headline\", \"description\": \"Some description worth knowing...\", \"plural\": null, \"use_ordinal_rules\": null, \"name_plural\": \"home.index.headlines\", \"data_type\": \"number\", \"tags\": \"awesome-feature,needs-proofreading\", \"max_characters_allowed\": 140, \"screenshot\": \"\", \"remove_screenshot\": null, \"unformatted\": null, \"xml_space_preserve\": null, \"original_file\": \"null\", \"localized_format_string\": \"null\", \"localized_format_key\": \"null\", \"custom_metadata\": {\"fruit\":\"Apple\",\"vegetable\":\"Tomato\"}, \"excluded_in_locales\": [\"de\",\"fr\"], \"format_value_type\": \"string\" }' \\\n --access_token " } ], "requestBody": { @@ -23822,6 +24019,7 @@ } } }, + "x-cli-command": "keys update", "x-cli-version": "2.5" }, "delete": { @@ -23882,9 +24080,10 @@ }, { "lang": "CLI v2", - "source": "phrase keys delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase keys delete \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "keys delete", "x-cli-version": "2.5" } }, @@ -23953,7 +24152,7 @@ }, { "lang": "CLI v2", - "source": "phrase keys tag \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'mykey* translated:true'\", \"locale_id\":\"abcd1234abcd1234abcd1234abcd1234\", \"tags\":\"landing-page,release-1.2\"}' \\\n--access_token " + "source": "phrase keys tag \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"mykey* translated:true\", \"locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"tags\": \"landing-page,release-1.2\" }' \\\n --access_token " } ], "requestBody": { @@ -23989,6 +24188,7 @@ } } }, + "x-cli-command": "keys tag", "x-cli-version": "2.5" } }, @@ -24054,7 +24254,7 @@ }, { "lang": "CLI v2", - "source": "phrase keys untag \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'mykey* translated:true'\", \"locale_id\":\"abcd1234abcd1234abcd1234abcd1234\", \"tags\":\"landing-page,release-1.2\"}' \\\n--access_token " + "source": "phrase keys untag \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"mykey* translated:true\", \"locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"tags\": \"landing-page,release-1.2\" }' \\\n --access_token " } ], "requestBody": { @@ -24090,6 +24290,7 @@ } } }, + "x-cli-command": "keys untag", "x-cli-version": "2.5" } }, @@ -24155,7 +24356,7 @@ }, { "lang": "CLI v2", - "source": "phrase keys exclude \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'mykey* translated:true'\", \"target_locale_id\":\"abcd1234abcd1234abcd1234abcd1234\", \"tags\":\"landing-page,release-1.2\"}' \\\n--access_token " + "source": "phrase keys exclude \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"mykey* translated:true\", \"target_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"tags\": \"landing-page,release-1.2\" }' \\\n --access_token " } ], "requestBody": { @@ -24191,6 +24392,7 @@ } } }, + "x-cli-command": "keys exclude", "x-cli-version": "2.5" } }, @@ -24256,7 +24458,7 @@ }, { "lang": "CLI v2", - "source": "phrase keys include \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'mykey* translated:true'\", \"target_locale_id\":\"abcd1234abcd1234abcd1234abcd1234\", \"tags\":\"landing-page,release-1.2\"}' \\\n--access_token " + "source": "phrase keys include \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"mykey* translated:true\", \"target_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"tags\": \"landing-page,release-1.2\" }' \\\n --access_token " } ], "requestBody": { @@ -24292,6 +24494,7 @@ } } }, + "x-cli-command": "keys include", "x-cli-version": "2.5" } }, @@ -24390,9 +24593,10 @@ }, { "lang": "CLI v2", - "source": "phrase orders list \\\n--project_id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase orders list \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --translation_id \"abcd1234cdef1234abcd1234cdef1234\" \\\n --access_token " } ], + "x-cli-command": "orders list", "x-cli-version": "2.5" }, "post": { @@ -24459,7 +24663,7 @@ }, { "lang": "CLI v2", - "source": "phrase orders create \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"name\":\"Welcome message translations\", \"lsp\":\"textmaster\", \"source_locale_id\":\"abcd1234abcd1234abcd1234abcd1234\", \"target_locale_ids\": \"1234abcd1234abcd1234abcd1234abcd,abcd1234abcd1234abcd1234abcd1234\", \"translation_type\":\"premium\", \"tag\":\"my-awesome-feature\", \"message\": \"Please make everything sound really nice :)\", \"styleguide_id\":\"1234abcd1234abcd1234abcd1234abcd\", \"category\":\"C021\"}' \\\n--access_token " + "source": "phrase orders create \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"name\": \"Welcome message translations\", \"lsp\": \"textmaster\", \"source_locale_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"target_locale_ids\": [\"1234abcd1234abcd1234abcd1234abcd\",\"abcd1234abcd1234abcd1234abcd1234\"], \"translation_type\": \"premium\", \"tag\": \"my-awesome-feature\", \"message\": \"Please make everything sound really nice :)\", \"styleguide_id\": \"1234abcd1234abcd1234abcd1234abcd\", \"unverify_translations_upon_delivery\": null, \"include_untranslated_keys\": null, \"include_unverified_translations\": null, \"category\": \"C021\", \"quality\": null, \"priority\": null }' \\\n --access_token " } ], "requestBody": { @@ -24560,6 +24764,7 @@ } } }, + "x-cli-command": "orders create", "x-cli-version": "2.5" } }, @@ -24637,9 +24842,10 @@ }, { "lang": "CLI v2", - "source": "phrase orders show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase orders show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "orders show", "x-cli-version": "2.5" }, "delete": { @@ -24700,9 +24906,10 @@ }, { "lang": "CLI v2", - "source": "phrase orders delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase orders delete \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "orders delete", "x-cli-version": "2.5" } }, @@ -24774,7 +24981,7 @@ }, { "lang": "CLI v2", - "source": "phrase orders confirm \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase orders confirm \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -24795,6 +25002,7 @@ } } }, + "x-cli-command": "orders confirm", "x-cli-version": "2.5" } }, @@ -24947,7 +25155,7 @@ }, { "lang": "CLI v2", - "source": "phrase quality_performance_score list \\\n--project_id \\\n--data '{\"translation_ids\":[\"translation_id_1\", \"translation_id_2\"]}' \\\n--access_token " + "source": "phrase quality_performance_score list \\\n --project_id \\\n --data '{ \"translation_ids\": null }' \\\n --access_token " } ], "requestBody": { @@ -24970,6 +25178,7 @@ } } }, + "x-cli-command": "quality_performance_score list", "x-cli-version": "2.20" } }, @@ -25044,9 +25253,10 @@ }, { "lang": "CLI v2", - "source": "phrase repo_syncs list \\\n--account_id abcd1234 \\\n--access_token " + "source": "phrase repo_syncs list \\\n --account_id \\\n --access_token " } ], + "x-cli-command": "repo_syncs list", "x-cli-version": "2.24" }, "post": { @@ -25113,7 +25323,7 @@ }, { "lang": "CLI v2", - "source": "phrase repo_syncs create \\\n--account_id abcd1234 \\\n--data '{\"project_id\":\"abcd1234abcd1234abcd1234abcd1234\",\"git_provider\":\"github\",\"connection_type\":\"github_app\",\"repo_name\":\"my-org/my-repo\",\"base_branch\":\"main\"}' \\\n--access_token " + "source": "phrase repo_syncs create \\\n --account_id \\\n --data '{ \"project_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"name\": \"null\", \"git_provider\": \"github\", \"connection_type\": \"github_app\", \"repo_name\": \"my-org/my-repo\", \"base_branch\": \"main\", \"pr_branch\": \"phrase-translations\", \"auto_import\": false, \"access_token\": \"ghp_xxxxxxxxxxxxxxxxxxxx\", \"custom_api_endpoint\": \"https://git.example.com/api/v4\" }' \\\n --access_token " } ], "requestBody": { @@ -25196,6 +25406,7 @@ } } }, + "x-cli-command": "repo_syncs create", "x-cli-version": "2.60" } }, @@ -25264,9 +25475,10 @@ }, { "lang": "CLI v2", - "source": "phrase repo_syncs show \\\n--id \\\n--account_id abcd1234 \\\n--access_token " + "source": "phrase repo_syncs show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "repo_syncs show", "x-cli-version": "2.24" } }, @@ -25361,9 +25573,10 @@ }, { "lang": "CLI v2", - "source": "phrase repo_syncs export \\\n--id \\\n--data '{\"pr_branch\":\"my-feature-branch\", \"branch\":\"my-strings-branch\"}' \\\n--access_token " + "source": "phrase repo_syncs export \\\n --account_id \\\n --id \\\n --data '{ \"pr_branch\": \"my-feature-branch\", \"branch\": \"my-strings-branch\" }' \\\n --access_token " } - ] + ], + "x-cli-command": "repo_syncs export" } }, "/accounts/{account_id}/repo_syncs/{id}/import": { @@ -25457,9 +25670,10 @@ }, { "lang": "CLI v2", - "source": "phrase repo_syncs import \\\n--id \\\n--data '{\"repository_branch\":\"my-feature-branch\", \"branch\":\"my-strings-branch\"}' \\\n--access_token " + "source": "phrase repo_syncs import \\\n --account_id \\\n --id \\\n --data '{ \"repository_branch\": \"my-feature-branch\", \"branch\": \"my-strings-branch\" }' \\\n --access_token " } - ] + ], + "x-cli-command": "repo_syncs import" } }, "/accounts/{account_id}/repo_syncs/{id}/events": { @@ -25529,9 +25743,10 @@ }, { "lang": "CLI v2", - "source": "phrase repo_sync_events list \\\n--id \\\n--account_id abcd1234 \\\n--access_token " + "source": "phrase repo_sync_events list \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "repo_sync_events list", "x-cli-version": "2.24" } }, @@ -25596,9 +25811,10 @@ }, { "lang": "CLI v2", - "source": "phrase repo_sync_events show \\\n--id \\\n--repo_sync_id \\\n--account_id abcd1234 \\\n--access_token " + "source": "phrase repo_sync_events show \\\n --account_id \\\n --repo_sync_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "repo_sync_events show", "x-cli-version": "2.24" } }, @@ -25670,9 +25886,10 @@ }, { "lang": "CLI v2", - "source": "phrase repo_syncs deactivate \\\n--id \\\n--access_token " + "source": "phrase repo_syncs deactivate \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "repo_syncs deactivate", "x-cli-version": "2.24" } }, @@ -25744,9 +25961,10 @@ }, { "lang": "CLI v2", - "source": "phrase repo_syncs activate \\\n--id \\\n--access_token " + "source": "phrase repo_syncs activate \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "repo_syncs activate", "x-cli-version": "2.24" } }, @@ -25820,9 +26038,10 @@ }, { "lang": "CLI v2", - "source": "phrase spaces list \\\n--account_id \\\n--access_token " + "source": "phrase spaces list \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "spaces list", "x-cli-version": "2.5" }, "post": { @@ -25879,7 +26098,7 @@ }, { "lang": "CLI v2", - "source": "phrase spaces create \\\n--account_id \\\n--data '{\"name\": \"My Android Projects\"}' \\\n--access_token " + "source": "phrase spaces create \\\n --account_id \\\n --data '{ \"name\": \"My Android Projects\" }' \\\n --access_token " } ], "requestBody": { @@ -25903,6 +26122,7 @@ } } }, + "x-cli-command": "spaces create", "x-cli-version": "2.5" } }, @@ -25964,9 +26184,10 @@ }, { "lang": "CLI v2", - "source": "phrase spaces show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase spaces show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "spaces show", "x-cli-version": "2.5" }, "patch": { @@ -26026,7 +26247,7 @@ }, { "lang": "CLI v2", - "source": "phrase spaces update \\\n--account_id \\\n--id \\\n--data '{\"name\": \"My Android Projects\"}' \\\n--access_token " + "source": "phrase spaces update \\\n --account_id \\\n --id \\\n --data '{ \"name\": \"My Android Projects\" }' \\\n --access_token " } ], "requestBody": { @@ -26047,6 +26268,7 @@ } } }, + "x-cli-command": "spaces update", "x-cli-version": "2.5" }, "delete": { @@ -26088,9 +26310,10 @@ }, { "lang": "CLI v2", - "source": "phrase spaces delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase spaces delete \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "spaces delete", "x-cli-version": "2.5" } }, @@ -26167,9 +26390,10 @@ }, { "lang": "CLI v2", - "source": "phrase spaces projects_list \\\n--account_id \\\n--space_id \\\n--access_token " + "source": "phrase spaces projects_list \\\n --account_id \\\n --space_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "spaces projects_list", "x-cli-version": "2.5" }, "post": { @@ -26222,7 +26446,7 @@ }, { "lang": "CLI v2", - "source": "phrase spaces projects_create \\\n--account_id \\\n--space_id \\\n--data '{\"id\":\"a4b3c2d1\"}' \\\n--access_token " + "source": "phrase spaces projects_create \\\n --account_id \\\n --space_id \\\n --data '{ \"id\": \"a4b3c2d1\" }' \\\n --access_token " } ], "requestBody": { @@ -26246,6 +26470,7 @@ } } }, + "x-cli-command": "spaces projects_create", "x-cli-version": "2.5" } }, @@ -26292,9 +26517,10 @@ }, { "lang": "CLI v2", - "source": "phrase spaces projects_delete \\\n--account_id \\\n--space_id \\\n--id \\\n--access_token " + "source": "phrase spaces projects_delete \\\n --account_id \\\n --space_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "spaces projects_delete", "x-cli-version": "2.5" } }, @@ -26368,9 +26594,10 @@ }, { "lang": "CLI v2", - "source": "phrase teams list \\\n--account_id \\\n--access_token " + "source": "phrase teams list \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "teams list", "x-cli-version": "2.5" }, "post": { @@ -26427,7 +26654,7 @@ }, { "lang": "CLI v2", - "source": "phrase teams create \\\n--account_id \\\n--data '{\"name\": \"German Translators\"}' \\\n--access_token " + "source": "phrase teams create \\\n --account_id \\\n --data '{ \"name\": \"German Translators\" }' \\\n --access_token " } ], "requestBody": { @@ -26451,6 +26678,7 @@ } } }, + "x-cli-command": "teams create", "x-cli-version": "2.5" } }, @@ -26512,9 +26740,10 @@ }, { "lang": "CLI v2", - "source": "phrase teams show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase teams show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "teams show", "x-cli-version": "2.5" }, "patch": { @@ -26574,7 +26803,7 @@ }, { "lang": "CLI v2", - "source": "phrase teams update \\\n--account_id \\\n--id \\\n--data '{\"name\": \"German Translators\"}' \\\n--access_token " + "source": "phrase teams update \\\n --account_id \\\n --id \\\n --data '{ \"name\": \"German Translators\" }' \\\n --access_token " } ], "requestBody": { @@ -26595,6 +26824,7 @@ } } }, + "x-cli-command": "teams update", "x-cli-version": "2.5" }, "delete": { @@ -26636,9 +26866,10 @@ }, { "lang": "CLI v2", - "source": "phrase teams delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase teams delete \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "teams delete", "x-cli-version": "2.5" } }, @@ -26693,7 +26924,7 @@ }, { "lang": "CLI v2", - "source": "phrase teams projects_create \\\n--account_id \\\n--team_id \\\n--data '{\"id\":\"a4b3c2d1\"}' \\\n--access_token " + "source": "phrase teams projects_create \\\n --account_id \\\n --team_id \\\n --data '{ \"id\": \"a4b3c2d1\" }' \\\n --access_token " } ], "requestBody": { @@ -26717,6 +26948,7 @@ } } }, + "x-cli-command": "teams projects_create", "x-cli-version": "2.5" } }, @@ -26763,9 +26995,10 @@ }, { "lang": "CLI v2", - "source": "phrase teams projects_delete \\\n--account_id \\\n--team_id \\\n--id \\\n--access_token " + "source": "phrase teams projects_delete \\\n --account_id \\\n --team_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "teams projects_delete", "x-cli-version": "2.5" } }, @@ -26820,7 +27053,7 @@ }, { "lang": "CLI v2", - "source": "phrase teams spaces_create \\\n--account_id \\\n--team_id \\\n--data '{\"id\":\"a4b3c2d1\"}' \\\n--access_token " + "source": "phrase teams spaces_create \\\n --account_id \\\n --team_id \\\n --data '{ \"id\": \"a4b3c2d1\" }' \\\n --access_token " } ], "requestBody": { @@ -26844,6 +27077,7 @@ } } }, + "x-cli-command": "teams spaces_create", "x-cli-version": "2.5" } }, @@ -26890,9 +27124,10 @@ }, { "lang": "CLI v2", - "source": "phrase teams spaces_delete \\\n--account_id \\\n--team_id \\\n--id \\\n--access_token " + "source": "phrase teams spaces_delete \\\n --account_id \\\n --team_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "teams spaces_delete", "x-cli-version": "2.5" } }, @@ -26947,7 +27182,7 @@ }, { "lang": "CLI v2", - "source": "phrase teams users_create \\\n--account_id \\\n--team_id \\\n--data '{\"id\":\"a4b3c2d1\"}' \\\n--access_token " + "source": "phrase teams users_create \\\n --account_id \\\n --team_id \\\n --data '{ \"id\": \"a4b3c2d1\" }' \\\n --access_token " } ], "requestBody": { @@ -26971,6 +27206,7 @@ } } }, + "x-cli-command": "teams users_create", "x-cli-version": "2.5" } }, @@ -27017,9 +27253,10 @@ }, { "lang": "CLI v2", - "source": "phrase teams users_delete \\\n--account_id \\\n--team_id \\\n--id \\\n--access_token " + "source": "phrase teams users_delete \\\n --account_id \\\n --team_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "teams users_delete", "x-cli-version": "2.5" } }, @@ -27160,9 +27397,10 @@ }, { "lang": "CLI v2", - "source": "phrase translations list \\\n--project_id \\\n--branch my-feature-branch \\\n--sort updated_at \\\n--order desc \\\n--query 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' \\\n--access_token " + "source": "phrase translations list \\\n --project_id \\\n --if_modified_since \"2024-03-15T09:00:00Z\" \\\n --if_none_match \"W/\\\"123456789\\\"\" \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --key_id \"abcd1234cdef1234abcd1234cdef1234\" \\\n --locale_id \"abcd1234cdef1234abcd1234cdef1234\" \\\n --sort \"updated_at\" \\\n --order \"desc\" \\\n --q \"PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center\" \\\n --access_token " } ], + "x-cli-command": "translations list", "x-cli-version": "2.6.4" }, "post": { @@ -27229,7 +27467,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations create \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"locale_id\":\"abcd1234cdef1234abcd1234cdef1234\", \"key_id\":\"abcd1234cdef1234abcd1234cdef1234\", \"content\": \"My translation\"}' \\\n--access_token " + "source": "phrase translations create \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"locale_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"key_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"content\": \"My translation\", \"plural_suffix\": \"null\", \"unverified\": null, \"excluded\": null, \"autotranslate\": null, \"minor_change\": false, \"reviewed\": false }' \\\n --access_token " } ], "requestBody": { @@ -27295,6 +27533,7 @@ } } }, + "x-cli-command": "translations create", "x-cli-version": "2.5" } }, @@ -27414,9 +27653,10 @@ }, { "lang": "CLI v2", - "source": "phrase translations by_locale \\\n--project_id \\\n--locale_id \\\n--branch my-feature-branch \\\n--sort updated_at \\\n--order desc \\\n--query 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' \\\n--access_token " + "source": "phrase translations by_locale \\\n --project_id \\\n --locale_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --sort \"updated_at\" \\\n --order \"desc\" \\\n --q \"PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center\" \\\n --access_token " } ], + "x-cli-command": "translations by_locale", "x-cli-version": "2.5" } }, @@ -27536,9 +27776,10 @@ }, { "lang": "CLI v2", - "source": "phrase translations by_key \\\n--project_id \\\n--key_id \\\n--branch my-feature-branch \\\n--sort updated_at \\\n--order desc \\\n--query 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' \\\n--access_token " + "source": "phrase translations by_key \\\n --project_id \\\n --key_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --branch \"my-feature-branch\" \\\n --sort \"updated_at\" \\\n --order \"desc\" \\\n --q \"PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center\" \\\n --access_token " } ], + "x-cli-command": "translations by_key", "x-cli-version": "2.5" } }, @@ -27616,7 +27857,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations search \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"sort\":\"updated_at\", \"order\":\"desc\", \"q\":\"'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center'\"}' \\\n--access_token " + "source": "phrase translations search \\\n --project_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --data '{ \"branch\": \"my-feature-branch\", \"sort\": \"updated_at\", \"order\": \"desc\", \"q\": \"PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center\" }' \\\n --access_token " } ], "requestBody": { @@ -27652,6 +27893,7 @@ } } }, + "x-cli-command": "translations search", "x-cli-version": "2.5" } }, @@ -27729,9 +27971,10 @@ }, { "lang": "CLI v2", - "source": "phrase translations show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase translations show \\\n --project_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "translations show", "x-cli-version": "2.5" }, "patch": { @@ -27801,7 +28044,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations update \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\", \"content\": \"My translation\"}' \\\n--access_token " + "source": "phrase translations update \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\", \"content\": \"My translation\", \"plural_suffix\": \"null\", \"unverified\": null, \"excluded\": null, \"autotranslate\": null, \"reviewed\": true, \"minor_change\": false }' \\\n --access_token " } ], "requestBody": { @@ -27857,6 +28100,7 @@ } } }, + "x-cli-command": "translations update", "x-cli-version": "2.5" } }, @@ -27928,7 +28172,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations verify \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase translations verify \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -27949,6 +28193,7 @@ } } }, + "x-cli-command": "translations verify", "x-cli-version": "2.5" } }, @@ -28020,7 +28265,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations unverify \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase translations unverify \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -28041,6 +28286,7 @@ } } }, + "x-cli-command": "translations unverify", "x-cli-version": "2.5" } }, @@ -28112,7 +28358,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations review \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase translations review \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -28133,6 +28379,7 @@ } } }, + "x-cli-command": "translations review", "x-cli-version": "2.5" } }, @@ -28204,7 +28451,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations unreview \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase translations unreview \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -28225,6 +28472,7 @@ } } }, + "x-cli-command": "translations unreview", "x-cli-version": "2.41" } }, @@ -28296,7 +28544,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations exclude \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase translations exclude \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -28317,6 +28565,7 @@ } } }, + "x-cli-command": "translations exclude", "x-cli-version": "2.5" } }, @@ -28388,7 +28637,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations include \\\n--project_id \\\n--id \\\n--data '{\"branch\":\"my-feature-branch\"}' \\\n--access_token " + "source": "phrase translations include \\\n --project_id \\\n --id \\\n --data '{ \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -28409,6 +28658,7 @@ } } }, + "x-cli-command": "translations include", "x-cli-version": "2.5" } }, @@ -28477,7 +28727,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations verify-collection \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'PhraseApp*%20unverified:true%20tags:feature,center'\"}' \\\n--access_token " + "source": "phrase translations verify-collection \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"locale_id\": \"fc2f11dd6a658fa9652f6f0a9ebee688\", \"q\": \"PhraseApp*%20unverified:true%20tags:feature,center\" }' \\\n --access_token " } ], "requestBody": { @@ -28508,6 +28758,7 @@ } } }, + "x-cli-command": "translations verify-collection", "x-cli-version": "2.5" } }, @@ -28576,7 +28827,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations unverify-collection \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'PhraseApp*%20verified:true%20tags:feature,center'\", \"sort\":\"updated_at\", \"order\":\"desc\"}' \\\n--access_token " + "source": "phrase translations unverify-collection \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"PhraseApp*%20verified:true%20tags:feature,center\", \"sort\": \"updated_at\", \"order\": \"desc\" }' \\\n --access_token " } ], "requestBody": { @@ -28612,6 +28863,7 @@ } } }, + "x-cli-command": "translations unverify-collection", "x-cli-version": "2.5" } }, @@ -28680,7 +28932,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations review-collection \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'PhraseApp*%reviewed:false%20tags:feature,center'\"}' \\\n--access_token " + "source": "phrase translations review-collection \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"PhraseApp*%reviewed:false%20tags:feature,center\" }' \\\n --access_token " } ], "requestBody": { @@ -28706,6 +28958,7 @@ } } }, + "x-cli-command": "translations review-collection", "x-cli-version": "2.5" } }, @@ -28774,7 +29027,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations unreview-collection \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'PhraseApp*%reviewed:false%20tags:feature,center'\"}' \\\n--access_token " + "source": "phrase translations unreview-collection \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"PhraseApp*%reviewed:true%20tags:feature,center\" }' \\\n --access_token " } ], "requestBody": { @@ -28800,6 +29053,7 @@ } } }, + "x-cli-command": "translations unreview-collection", "x-cli-version": "2.41" } }, @@ -28865,7 +29119,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations exclude-collection \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'PhraseApp*%20verified:true%20tags:feature,center'\", \"sort\":\"updated_at\", \"order\":\"desc\"}' \\\n--access_token " + "source": "phrase translations exclude-collection \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"PhraseApp*%20verified:true%20tags:feature,center\", \"sort\": \"updated_at\", \"order\": \"desc\" }' \\\n --access_token " } ], "requestBody": { @@ -28901,6 +29155,7 @@ } } }, + "x-cli-command": "translations exclude-collection", "x-cli-version": "2.5" } }, @@ -28966,7 +29221,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations include-collection \\\n--project_id \\\n--data '{\"branch\":\"my-feature-branch\", \"q\":\"'PhraseApp*%20verified:true%20tags:feature,center'\", \"sort\":\"updated_at\", \"order\":\"desc\"}' \\\n--access_token " + "source": "phrase translations include-collection \\\n --project_id \\\n --data '{ \"branch\": \"my-feature-branch\", \"q\": \"PhraseApp*%20verified:true%20tags:feature,center\", \"sort\": \"updated_at\", \"order\": \"desc\" }' \\\n --access_token " } ], "requestBody": { @@ -29002,6 +29257,7 @@ } } }, + "x-cli-command": "translations include-collection", "x-cli-version": "2.5" } }, @@ -29097,9 +29353,10 @@ }, { "lang": "CLI v2", - "source": "phrase notifications list \\\n--access_token " + "source": "phrase notifications list \\\n --page \"1\" \\\n --per_page \"25\" \\\n --unseen true \\\n --last_days \"7\" \\\n --access_token " } ], + "x-cli-command": "notifications list", "x-cli-version": "2.5" } }, @@ -29165,9 +29422,10 @@ }, { "lang": "CLI v2", - "source": "phrase notifications mark_all_as_read \\\n--access_token " + "source": "phrase notifications mark_all_as_read \\\n --access_token " } ], + "x-cli-command": "notifications mark_all_as_read", "x-cli-version": "2.5" } }, @@ -29232,9 +29490,10 @@ }, { "lang": "CLI v2", - "source": "phrase notifications show \\\n--id \\\n--access_token " + "source": "phrase notifications show \\\n --id \\\n --access_token " } ], + "x-cli-command": "notifications show", "x-cli-version": "2.5" } }, @@ -29312,9 +29571,10 @@ }, { "lang": "CLI v2", - "source": "phrase notification_groups list \\\n--access_token " + "source": "phrase notification_groups list \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "notification_groups list", "x-cli-version": "2.5" } }, @@ -29380,9 +29640,10 @@ }, { "lang": "CLI v2", - "source": "phrase notification_groups mark_all_as_read \\\n--access_token " + "source": "phrase notification_groups mark_all_as_read \\\n --access_token " } ], + "x-cli-command": "notification_groups mark_all_as_read", "x-cli-version": "2.5" } }, @@ -29448,9 +29709,10 @@ }, { "lang": "CLI v2", - "source": "phrase notification_groups mark_as_read \\\n--id \\\n--access_token " + "source": "phrase notification_groups mark_as_read \\\n --id \\\n --access_token " } ], + "x-cli-command": "notification_groups mark_as_read", "x-cli-version": "2.5" } }, @@ -29645,7 +29907,7 @@ }, { "lang": "CLI v2", - "source": "phrase search in_account \\\n--account_id \\\n--data '{\"q\":\"keyword\",\"locale_code\": \"de\",\"page\": 1,\"per_page\": 25}' \\\n--access_token " + "source": "phrase search in_account \\\n --account_id \\\n --data '{ \"query\": \"keyword\", \"locale_code\": \"de_DE\", \"page\": 1, \"per_page\": 25, \"project_ids\": [\"abcd1234abcd1234abcd1234abcd1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -29691,6 +29953,7 @@ } } }, + "x-cli-command": "search in_account", "x-cli-version": "2.5" } }, @@ -29758,9 +30021,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_comments show \\\n--project_id \\\n--job_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_comments show \\\n --project_id \\\n --job_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_comments show", "x-cli-version": "2.5" }, "patch": { @@ -29823,7 +30087,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_comments update \\\n--project_id \\\n--job_id \\\n--id \\\n--data '{\"message\": \"Some message...\"}' \\\n--access_token " + "source": "phrase job_comments update \\\n --project_id \\\n --key_id \\\n --id \\\n --data '{ \"message\": \"Some message...\", \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -29849,6 +30113,7 @@ } } }, + "x-cli-command": "job_comments update", "x-cli-version": "2.5" }, "delete": { @@ -29896,9 +30161,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_comments delete \\\n--project_id \\\n--job_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " + "source": "phrase job_comments delete \\\n --project_id \\\n --job_id \\\n --id \\\n --branch \"my-feature-branch\" \\\n --access_token " } ], + "x-cli-command": "job_comments delete", "x-cli-version": "2.5" } }, @@ -29981,9 +30247,10 @@ }, { "lang": "CLI v2", - "source": "phrase job_comments list \\\n--project_id \\\n--job_id \\\n--branch my-feature-branch \\\n--order desc \\\n--access_token " + "source": "phrase job_comments list \\\n --project_id \\\n --job_id \\\n --branch \"my-feature-branch\" \\\n --order \"desc\" \\\n --access_token " } ], + "x-cli-command": "job_comments list", "x-cli-version": "2.5" }, "post": { @@ -30043,7 +30310,7 @@ }, { "lang": "CLI v2", - "source": "phrase job_comments create \\\n--project_id \\\n--job_id \\\n--data '{\"message\": \"Some message...\"}' \\\n--access_token " + "source": "phrase job_comments create \\\n --project_id \\\n --job_id \\\n --data '{ \"message\": \"Some message...\", \"branch\": \"my-feature-branch\" }' \\\n --access_token " } ], "requestBody": { @@ -30069,6 +30336,7 @@ } } }, + "x-cli-command": "job_comments create", "x-cli-version": "2.5" } }, @@ -30142,9 +30410,10 @@ }, { "lang": "CLI v2", - "source": "phrase webhooks list \\\n--project_id \\\n--webhook_id \\\n--access_token " + "source": "phrase webhook_deliveries list \\\n --project_id \\\n --webhook_id \\\n --response_status_codes \"responseStatusCodes_example\" \\\n --access_token " } ], + "x-cli-command": "webhook_deliveries list", "x-cli-version": "2.5" } }, @@ -30212,9 +30481,10 @@ }, { "lang": "CLI v2", - "source": "phrase webhook deliveries show \\\n--project_id \\\n--webhook_id \\\n--id \\\n--access_token " + "source": "phrase webhook_deliveries show \\\n --project_id \\\n --webhook_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "webhook_deliveries show", "x-cli-version": "2.5" } }, @@ -30285,9 +30555,10 @@ }, { "lang": "CLI v2", - "source": "phrase webhook deliveries show \\\n--project_id \\\n--webhook_id \\\n--id \\\n--access_token " + "source": "phrase webhook_deliveries redeliver \\\n --project_id \\\n --webhook_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "webhook_deliveries redeliver", "x-cli-version": "2.5" } }, @@ -30368,9 +30639,10 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_templates list \\\n--account_id \\\n--access_token " + "source": "phrase organization_job_templates list \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "organization_job_templates list", "x-cli-version": "2.7.0" }, "post": { @@ -30437,7 +30709,7 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_templates create \\\n--account_id \\\n--data '{\"name\":\"template\", \"briefing\":\"text\"}' \\\n--access_token " + "source": "phrase organization_job_templates create \\\n --account_id \\\n --data '{ \"name\": \"template\", \"briefing\": \"text\", \"autotranslate\": true }' \\\n --access_token " } ], "requestBody": { @@ -30471,6 +30743,7 @@ } } }, + "x-cli-command": "organization_job_templates create", "x-cli-version": "2.7.0" } }, @@ -30539,9 +30812,10 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_templates show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase organization_job_templates show \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "organization_job_templates show", "x-cli-version": "2.7.0" }, "patch": { @@ -30611,7 +30885,7 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_templates update \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase organization_job_templates update \\\n --account_id \\\n --id \\\n --data '{ \"name\": \"template\", \"briefing\": \"text\", \"autotranslate\": true }' \\\n --access_token " } ], "requestBody": { @@ -30645,6 +30919,7 @@ } } }, + "x-cli-command": "organization_job_templates update", "x-cli-version": "2.7.0" }, "delete": { @@ -30696,9 +30971,10 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_templates delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase organization_job_templates delete \\\n --account_id \\\n --id \\\n --access_token " } ], + "x-cli-command": "organization_job_templates delete", "x-cli-version": "2.7.0" } }, @@ -30775,9 +31051,10 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_template_locales list \\\n--account_id \\\n--job_template_id \\\n--access_token " + "source": "phrase organization_job_template_locales list \\\n --account_id \\\n --job_template_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } ], + "x-cli-command": "organization_job_template_locales list", "x-cli-version": "2.7.0" }, "post": { @@ -30837,7 +31114,7 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_template_locales create \\\n--account_id \\\n--job_template_id \\\n--data '{\"locale_name\": \"de-1\", \"locale_code: \"de-DE\", \"user_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"reviewer_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"translator_team_ids\": \"abcd1234cdef1234abcd1234cdef1234\"}' \\\n--access_token " + "source": "phrase organization_job_template_locales create \\\n --account_id \\\n --job_template_id \\\n --data '{ \"locale_name\": \"de-1\", \"locale_code\": \"de-DE\", \"user_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"translator_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -30907,6 +31184,7 @@ } } }, + "x-cli-command": "organization_job_template_locales create", "x-cli-version": "2.7.0" } }, @@ -30971,9 +31249,10 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_template_locales show \\\n--account_id \\\n--job_template_id \\\n--job_template_locale_id \\\n--access_token " + "source": "phrase organization_job_template_locales show \\\n --account_id \\\n --job_template_id \\\n --job_template_locale_id \\\n --access_token " } ], + "x-cli-command": "organization_job_template_locales show", "x-cli-version": "2.7.0" }, "patch": { @@ -31036,7 +31315,7 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_template_locales update \\\n--account_id \\\n--job_template_id \\\n--job_template_locale_id \\\n--data '{\"locale_name\": \"de-1\", \"locale_code: \"de-DE\", \"user_ids\": \"abcd1234cdef1234abcd1234cdef1234\", \"reviewer_ids\": \"abcd1234cdef1234abcd1234cdef1234\",\"translator_team_ids\": \"abcd1234cdef1234abcd1234cdef1234\"}' \\\n--access_token " + "source": "phrase organization_job_template_locales update \\\n --account_id \\\n --job_template_id \\\n --job_template_locale_id \\\n --data '{ \"locale_name\": \"de-1\", \"locale_code\": \"de-DE\", \"user_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"translator_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"reviewer_team_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"] }' \\\n --access_token " } ], "requestBody": { @@ -31102,6 +31381,7 @@ } } }, + "x-cli-command": "organization_job_template_locales update", "x-cli-version": "2.7.0" }, "delete": { @@ -31146,9 +31426,10 @@ }, { "lang": "CLI v2", - "source": "phrase organization_job_template_locales delete \\\n--account_id \\\n--job_template_id \\\n--job_template_locale_id \\\n--access_token " + "source": "phrase organization_job_template_locales delete \\\n --account_id \\\n --job_template_id \\\n --job_template_locale_id \\\n --access_token " } ], + "x-cli-command": "organization_job_template_locales delete", "x-cli-version": "2.7.0" } }, @@ -31247,8 +31528,13 @@ { "lang": "Curl", "source": "curl \"https://api.phrase.com/v2/projects/:project_id/keys/:id/key_links\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X DELETE \\\n -H \"Content-Type: application/json\" \\\n -d '{\"child_key_ids\": [\"feature.subtitle\", \"nav.home\"], \"strategy\": \"keep_content\"}'" + }, + { + "lang": "CLI v2", + "source": "phrase linked_keys batch_destroy \\\n --project_id \\\n --id \\\n --data '{ \"child_key_ids\": [\"feature.subtitle\",\"nav.home\"], \"unlink_parent\": null, \"strategy\": \"null\" }' \\\n --access_token " } - ] + ], + "x-cli-command": "linked_keys batch_destroy" }, "get": { "summary": "List child keys of a parent key", @@ -31310,7 +31596,14 @@ "429": { "$ref": "#/components/responses/429" } - } + }, + "x-cli-command": "linked_keys index", + "x-code-samples": [ + { + "lang": "CLI v2", + "source": "phrase linked_keys index \\\n --project_id \\\n --id \\\n --access_token " + } + ] }, "post": { "summary": "Link child keys to a parent key", @@ -31397,8 +31690,13 @@ { "lang": "Curl", "source": "curl -X POST \"https://api.phrase.com/v2/projects/:project_id/keys/:id/key_links\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -H \"Content-Type: application/json\" \\\n -d '{\"child_key_ids\": [\"ijkl9012mnop3456ijkl9012mnop3456\", \"abcd1234efgh5678abcd1234efgh5678\"]}'" + }, + { + "lang": "CLI v2", + "source": "phrase linked_keys create \\\n --project_id \\\n --id \\\n --data '{ \"child_key_ids\": [\"ijkl9012mnop3456ijkl9012mnop3456\",\"abcd1234efgh5678abcd1234efgh5678\"] }' \\\n --access_token " } - ] + ], + "x-cli-command": "linked_keys create" } }, "/projects/{project_id}/keys/{id}/key_links/{child_key_id}": { @@ -31469,8 +31767,13 @@ { "lang": "Curl", "source": "curl -i \"https://api.phrase.com/v2/projects/:project_id/keys/:id/key_links/1234abcd1234cdef1234abcd1234cdef\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X DELETE" + }, + { + "lang": "CLI v2", + "source": "phrase linked_keys destroy \\\n --project_id \\\n --id \\\n --child_key_id \\\n --access_token " } - ] + ], + "x-cli-command": "linked_keys destroy" } }, "/accounts/{account_id}/automations": { @@ -31550,9 +31853,10 @@ }, { "lang": "CLI v2", - "source": "phrase automations list \\\n--account_id \\\n--page 1 \\\n--per_page 10 \\\n--access_token " + "source": "phrase automations list \\\n --account_id \\\n --page \"1\" \\\n --per_page \"25\" \\\n --access_token " } - ] + ], + "x-cli-command": "automations list" }, "post": { "summary": "Create an automation", @@ -31706,9 +32010,10 @@ }, { "lang": "CLI v2", - "source": "phrase automations create \\\n--account_id \\\n--data '{\"name\":\"Schedule Automation - Hourly\",\"trigger\":\"schedule\",\"project_ids\":[\"1\"],\"job_template_id\":\"2\",\"status_filters\":[\"untranslated\"],\"tag_ids\":[\"3\",\"4\"],\"cron_schedule\":\"00 13 * * 1,2\",\"time_zone\":\"GMT\"}' \\\n--access_token " + "source": "phrase automations create \\\n --account_id \\\n --data '{ \"name\": \"Scheduled Job Automation - Hourly\", \"trigger\": \"null\", \"project_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"job_template_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"status_filters\": null, \"tags\": [\"myTag\"], \"cron_schedule\": \"00 13 * * 1,2\", \"time_zone\": \"GMT\", \"job_owner_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"include_only_updated_locales\": false }' \\\n --access_token " } - ] + ], + "x-cli-command": "automations create" } }, "/accounts/{account_id}/automations/{automation_id}": { @@ -31776,9 +32081,10 @@ }, { "lang": "CLI v2", - "source": "phrase automations show \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase automations show \\\n --account_id \\\n --id \\\n --access_token " } - ] + ], + "x-cli-command": "automations show" }, "patch": { "summary": "Update an automation", @@ -31935,9 +32241,10 @@ }, { "lang": "CLI v2", - "source": "phrase automations update \\\n--account_id \\\n--id \\\n--data '{\"name\":\"Schedule Automation - Weekly\",\"tag_ids\":[\"5\",\"6\"],time_zone:\"UTC\"}' \\\n--access_token " + "source": "phrase automations update \\\n --account_id \\\n --id \\\n --data '{ \"name\": \"Scheduled Job Automation - Hourly\", \"trigger\": \"null\", \"project_ids\": [\"abcd1234cdef1234abcd1234cdef1234\"], \"job_template_id\": \"abcd1234cdef1234abcd1234cdef1234\", \"status_filters\": null, \"tags\": [\"myTag\"], \"cron_schedule\": \"00 13 * * 1,2\", \"time_zone\": \"GMT\", \"job_owner_id\": \"abcd1234abcd1234abcd1234abcd1234\", \"include_only_updated_locales\": false }' \\\n --access_token " } - ] + ], + "x-cli-command": "automations update" }, "delete": { "summary": "Destroy automation", @@ -31985,9 +32292,10 @@ }, { "lang": "CLI v2", - "source": "phrase automations delete \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase automations delete \\\n --account_id \\\n --id \\\n --access_token " } - ] + ], + "x-cli-command": "automations delete" } }, "/accounts/{account_id}/automations/{automation_id}/activate": { @@ -32058,9 +32366,10 @@ }, { "lang": "CLI v2", - "source": "phrase automations activate \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase automations activate \\\n --account_id \\\n --id \\\n --access_token " } - ] + ], + "x-cli-command": "automations activate" } }, "/accounts/{account_id}/automations/{automation_id}/deactivate": { @@ -32131,9 +32440,10 @@ }, { "lang": "CLI v2", - "source": "phrase automations deactivate \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase automations deactivate \\\n --account_id \\\n --id \\\n --access_token " } - ] + ], + "x-cli-command": "automations deactivate" } }, "/accounts/{account_id}/automations/{automation_id}/trigger": { @@ -32186,11 +32496,11 @@ }, { "lang": "CLI v2", - "source": "phrase automations trigger \\\n--account_id \\\n--id \\\n--access_token " + "source": "phrase automations trigger \\\n --account_id \\\n --id \\\n --access_token " } - ] + ], + "x-cli-command": "automations trigger" } } } } - diff --git a/examples/cli.yaml b/examples/cli.yaml new file mode 100644 index 00000000..79a01560 --- /dev/null +++ b/examples/cli.yaml @@ -0,0 +1,2385 @@ +account/show: + lang: CLI v2 + source: |- + phrase accounts show \ + --id \ + --access_token +accounts/list: + lang: CLI v2 + source: |- + phrase accounts list \ + --page "1" \ + --per_page "25" \ + --access_token +authorization/create: + lang: CLI v2 + source: |- + phrase authorizations create \ + --data '{ "note": "My Deploy Script", "scopes": ["read","write"], "expires_at": "2015-03-30T09:52:53Z" }' \ + --access_token +authorization/delete: + lang: CLI v2 + source: |- + phrase authorizations delete \ + --id \ + --access_token +authorization/show: + lang: CLI v2 + source: |- + phrase authorizations show \ + --id \ + --access_token +authorization/update: + lang: CLI v2 + source: |- + phrase authorizations update \ + --id \ + --data '{ "note": "My Deploy Script", "scopes": ["read","write"], "expires_at": "2015-03-30T09:52:53Z" }' \ + --access_token +authorizations/list: + lang: CLI v2 + source: |- + phrase authorizations list \ + --page "1" \ + --per_page "25" \ + --access_token +automation/activate: + lang: CLI v2 + source: |- + phrase automations activate \ + --account_id \ + --id \ + --access_token +automation/create: + lang: CLI v2 + source: |- + phrase automations create \ + --account_id \ + --data '{ "name": "Scheduled Job Automation - Hourly", "trigger": "null", "project_ids": ["abcd1234cdef1234abcd1234cdef1234"], "job_template_id": "abcd1234cdef1234abcd1234cdef1234", "status_filters": null, "tags": ["myTag"], "cron_schedule": "00 13 * * 1,2", "time_zone": "GMT", "job_owner_id": "abcd1234abcd1234abcd1234abcd1234", "include_only_updated_locales": false }' \ + --access_token +automation/deactivate: + lang: CLI v2 + source: |- + phrase automations deactivate \ + --account_id \ + --id \ + --access_token +automation/delete: + lang: CLI v2 + source: |- + phrase automations delete \ + --account_id \ + --id \ + --access_token +automation/show: + lang: CLI v2 + source: |- + phrase automations show \ + --account_id \ + --id \ + --access_token +automation/trigger: + lang: CLI v2 + source: |- + phrase automations trigger \ + --account_id \ + --id \ + --access_token +automation/update: + lang: CLI v2 + source: |- + phrase automations update \ + --account_id \ + --id \ + --data '{ "name": "Scheduled Job Automation - Hourly", "trigger": "null", "project_ids": ["abcd1234cdef1234abcd1234cdef1234"], "job_template_id": "abcd1234cdef1234abcd1234cdef1234", "status_filters": null, "tags": ["myTag"], "cron_schedule": "00 13 * * 1,2", "time_zone": "GMT", "job_owner_id": "abcd1234abcd1234abcd1234abcd1234", "include_only_updated_locales": false }' \ + --access_token +automations/list: + lang: CLI v2 + source: |- + phrase automations list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +blacklisted_key/create: + lang: CLI v2 + source: |- + phrase blacklisted_keys create \ + --project_id \ + --data '{ "name": "date.formats.*" }' \ + --access_token +blacklisted_key/delete: + lang: CLI v2 + source: |- + phrase blacklisted_keys delete \ + --project_id \ + --id \ + --access_token +blacklisted_key/show: + lang: CLI v2 + source: |- + phrase blacklisted_keys show \ + --project_id \ + --id \ + --access_token +blacklisted_key/update: + lang: CLI v2 + source: |- + phrase blacklisted_keys update \ + --project_id \ + --id \ + --data '{ "name": "date.formats.*" }' \ + --access_token +blacklisted_keys/list: + lang: CLI v2 + source: |- + phrase blacklisted_keys list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +branch/compare: + lang: CLI v2 + source: |- + phrase branches compare \ + --project_id \ + --name \ + --access_token +branch/comparison/create: + lang: CLI v2 + source: |- + phrase branches comparison_create \ + --project_id \ + --name \ + --data '{ "direction": "merge" }' \ + --access_token +branch/create: + lang: CLI v2 + source: |- + phrase branches create \ + --project_id \ + --data '{ "name": "my-branch", "base": "parent-branch" }' \ + --access_token +branch/delete: + lang: CLI v2 + source: |- + phrase branches delete \ + --project_id \ + --name \ + --access_token +branch/merge: + lang: CLI v2 + source: |- + phrase branches merge \ + --project_id \ + --name \ + --data '{ "strategy": "use_main" }' \ + --access_token +branch/show: + lang: CLI v2 + source: |- + phrase branches show \ + --project_id \ + --name \ + --access_token +branch/sync: + lang: CLI v2 + source: |- + phrase branches sync \ + --project_id \ + --name \ + --data '{ "strategy": "use_main" }' \ + --access_token +branch/update: + lang: CLI v2 + source: |- + phrase branches update \ + --project_id \ + --name \ + --data '{ "name": "my-branch" }' \ + --access_token +branches/list: + lang: CLI v2 + source: |- + phrase branches list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --access_token +reaction/create: + lang: CLI v2 + source: |- + phrase comment_reactions create \ + --project_id \ + --key_id \ + --comment_id \ + --branch "my-feature-branch" \ + --emoji "👍" \ + --access_token +reaction/delete: + lang: CLI v2 + source: |- + phrase comment_reactions delete \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +reaction/show: + lang: CLI v2 + source: |- + phrase comment_reactions show \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +reactions/list: + lang: CLI v2 + source: |- + phrase comment_reactions list \ + --project_id \ + --key_id \ + --comment_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +replies/list: + lang: CLI v2 + source: |- + phrase comment_replies list \ + --project_id \ + --key_id \ + --comment_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --query "Some comment content" \ + --filters '["read","unread"]' \ + --order "desc" \ + --access_token +reply/create: + lang: CLI v2 + source: |- + phrase comment_replies create \ + --project_id \ + --key_id \ + --comment_id \ + --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ + --access_token +reply/delete: + lang: CLI v2 + source: |- + phrase comment_replies delete \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +reply/mark_as_read: + lang: CLI v2 + source: |- + phrase comment_replies mark_as_read \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +reply/mark_as_unread: + lang: CLI v2 + source: |- + phrase comment_replies mark_as_unread \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +reply/show: + lang: CLI v2 + source: |- + phrase comment_replies show \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +comment/create: + lang: CLI v2 + source: |- + phrase comments create \ + --project_id \ + --key_id \ + --data '{ "message": "Some message...", "branch": "my-feature-branch", "locale_ids": ["someId","someOtherId"] }' \ + --access_token +comment/delete: + lang: CLI v2 + source: |- + phrase comments delete \ + --project_id \ + --key_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +comment/mark/check: + lang: CLI v2 + source: |- + phrase comments mark_check \ + --project_id \ + --key_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +comment/mark/read: + lang: CLI v2 + source: |- + phrase comments mark_read \ + --project_id \ + --key_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +comment/mark/unread: + lang: CLI v2 + source: |- + phrase comments mark_unread \ + --project_id \ + --key_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +comment/show: + lang: CLI v2 + source: |- + phrase comments show \ + --project_id \ + --key_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +comment/update: + lang: CLI v2 + source: |- + phrase comments update \ + --project_id \ + --key_id \ + --id \ + --data '{ "branch": "my-feature-branch", "message": "Some message..." }' \ + --access_token +comments/list: + lang: CLI v2 + source: |- + phrase comments list \ + --project_id \ + --key_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --query "Some comment content" \ + --locale_ids '["someId"]' \ + --filters '["read","unread"]' \ + --order "desc" \ + --access_token +custom_metadata_properties/delete: + lang: CLI v2 + source: |- + phrase custom_metadata delete \ + --account_id \ + --id \ + --access_token +custom_metadata_properties/list: + lang: CLI v2 + source: |- + phrase custom_metadata list \ + --account_id \ + --data_type "boolean" \ + --project_id "abcd1234cdef1234abcd1234cdef1234" \ + --page "1" \ + --per_page "25" \ + --q "character_name" \ + --sort "updated_at" \ + --order "desc" \ + --access_token +custom_metadata_property/create: + lang: CLI v2 + source: |- + phrase custom_metadata create \ + --account_id \ + --data '{ "name": "Fruit", "data_type": "null", "project_ids": ["abcd1234cdef1234abcd1234cdef1234","abcd1234cdef1234abcd1234cdef4321"], "description": "A healthy snack for all ages", "value_options": ["Apple","Banana","Coconut"] }' \ + --access_token +custom_metadata_property/show: + lang: CLI v2 + source: |- + phrase custom_metadata show \ + --account_id \ + --id \ + --access_token +custom_metadata_property/update: + lang: CLI v2 + source: |- + phrase custom_metadata update \ + --account_id \ + --id \ + --data '{ "name": "Fruit", "project_ids": ["abcd1234cdef1234abcd1234cdef1234","abcd1234cdef1234abcd1234cdef4321"], "description": "A healthy snack for all ages", "value_options": ["Apple","Banana","Coconut"] }' \ + --access_token +distribution/create: + lang: CLI v2 + source: |- + phrase distributions create \ + --account_id \ + --data '{ "name": "My Android Distribution", "project_id": "abcd1234abcd1234abcd1234", "platforms": ["android","ios"], "locale_ids": ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"], "format_options": {"enclose_in_cdata":"1"}, "fallback_locales_enabled": true, "fallback_to_non_regional_locale": true, "fallback_to_default_locale": true, "use_last_reviewed_version": true }' \ + --access_token +distribution/delete: + lang: CLI v2 + source: |- + phrase distributions delete \ + --account_id \ + --id \ + --access_token +distribution/show: + lang: CLI v2 + source: |- + phrase distributions show \ + --account_id \ + --id \ + --access_token +distribution/update: + lang: CLI v2 + source: |- + phrase distributions update \ + --account_id \ + --id \ + --data '{ "name": "My Android Distribution", "project_id": "abcd1234abcd1234abcd1234", "platforms": ["android","ios"], "locale_ids": ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"], "format_options": {"enclose_in_cdata":"1"}, "fallback_locales_enabled": true, "fallback_to_non_regional_locale": true, "fallback_to_default_locale": true, "use_last_reviewed_version": true }' \ + --access_token +distributions/list: + lang: CLI v2 + source: |- + phrase distributions list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +document/delete: + lang: CLI v2 + source: |- + phrase documents delete \ + --project_id \ + --id \ + --access_token +documents/list: + lang: CLI v2 + source: |- + phrase documents list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --q "invoice" \ + --access_token +figma_attachment/create: + lang: CLI v2 + source: |- + phrase figma_attachments create \ + --project_id \ + --branch "my-feature-branch" \ + --data '{ "branch": "my-feature-branch", "url": "https://figma.com/file/xxxxx/sample" }' \ + --access_token +figma_attachment/delete: + lang: CLI v2 + source: |- + phrase figma_attachments delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +figma_attachment/show: + lang: CLI v2 + source: |- + phrase figma_attachments show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +figma_attachment/update: + lang: CLI v2 + source: |- + phrase figma_attachments update \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --data '{ "branch": "my-feature-branch", "url": "https://figma.com/file/xxxxx/sample" }' \ + --access_token +figma_attachments/list: + lang: CLI v2 + source: |- + phrase figma_attachments list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +formats/list: + lang: CLI v2 + source: |- + phrase formats list \ + --access_token +glossaries/list: + lang: CLI v2 + source: |- + phrase glossaries list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +glossary/create: + lang: CLI v2 + source: |- + phrase glossaries create \ + --account_id \ + --data '{ "name": "My glossary", "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ + --access_token +glossary/delete: + lang: CLI v2 + source: |- + phrase glossaries delete \ + --account_id \ + --id \ + --access_token +glossary/show: + lang: CLI v2 + source: |- + phrase glossaries show \ + --account_id \ + --id \ + --access_token +glossary/update: + lang: CLI v2 + source: |- + phrase glossaries update \ + --account_id \ + --id \ + --data '{ "name": "My glossary", "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ + --access_token +glossary_term_translation/create: + lang: CLI v2 + source: |- + phrase glossary_term_translations create \ + --account_id \ + --glossary_id \ + --term_id \ + --data '{ "locale_code": "en-US", "content": "My translated term" }' \ + --access_token +glossary_term_translation/delete: + lang: CLI v2 + source: |- + phrase glossary_term_translations delete \ + --account_id \ + --glossary_id \ + --term_id \ + --id \ + --access_token +glossary_term_translation/update: + lang: CLI v2 + source: |- + phrase glossary_term_translations update \ + --account_id \ + --glossary_id \ + --term_id \ + --id \ + --data '{ "locale_code": "en-US", "content": "My translated term" }' \ + --access_token +glossary_term/create: + lang: CLI v2 + source: |- + phrase glossary_terms create \ + --account_id \ + --glossary_id \ + --data '{ "term": "MyCompany", "description": "Use this when refering to our company", "translatable": true, "case_sensitive": true }' \ + --access_token +glossary_term/delete: + lang: CLI v2 + source: |- + phrase glossary_terms delete \ + --account_id \ + --glossary_id \ + --id \ + --access_token +glossary_term/show: + lang: CLI v2 + source: |- + phrase glossary_terms show \ + --account_id \ + --glossary_id \ + --id \ + --access_token +glossary_term/update: + lang: CLI v2 + source: |- + phrase glossary_terms update \ + --account_id \ + --glossary_id \ + --id \ + --data '{ "term": "MyCompany", "description": "Use this when refering to our company", "translatable": true, "case_sensitive": true }' \ + --access_token +glossary_terms/list: + lang: CLI v2 + source: |- + phrase glossary_terms list \ + --account_id \ + --glossary_id \ + --page "1" \ + --per_page "25" \ + --access_token +icu/skeleton: + lang: CLI v2 + source: |- + phrase icu skeleton \ + --data '{ "content": "{number, plural, one {One} other {%{n}}}", "id": "abcd1234abcd1234abcd1234abcd1234", "locale_codes": ["en"], "keep_content": null, "zero_form_enabled": null, "cldr_version": "cldr_41" }' \ + --access_token +invitation/create: + lang: CLI v2 + source: |- + phrase invitations create \ + --account_id \ + --data '{ "email": "example@mail.com", "role": "Developer", "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "locale_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"], "team_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"], "default_locale_codes": ["en","de"], "permissions": {"create_upload":true,"review_translations":true} }' \ + --access_token +invitation/delete: + lang: CLI v2 + source: |- + phrase invitations delete \ + --account_id \ + --id \ + --access_token +invitation/resend: + lang: CLI v2 + source: |- + phrase invitations resend \ + --account_id \ + --id \ + --access_token +invitation/show: + lang: CLI v2 + source: |- + phrase invitations show \ + --account_id \ + --id \ + --access_token +invitation/update: + lang: CLI v2 + source: |- + phrase invitations update \ + --account_id \ + --id \ + --data '{ "role": "Invitiation role", "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "locale_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"], "team_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"], "default_locale_codes": ["en","de"], "permissions": {"create_upload":true} }' \ + --access_token +invitation/update_settings: + lang: CLI v2 + source: |- + phrase invitations update_settings \ + --project_id \ + --id \ + --data '{ "project_role": "Developer", "locale_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ + --access_token +invitations/list: + lang: CLI v2 + source: |- + phrase invitations list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +job_annotation/delete: + lang: CLI v2 + source: |- + phrase job_annotations delete \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job_annotation/update: + lang: CLI v2 + source: |- + phrase job_annotations update \ + --project_id \ + --job_id \ + --id \ + --data '{ "value": "Some value...", "branch": "my-feature-branch" }' \ + --access_token +job_annotations/list: + lang: CLI v2 + source: |- + phrase job_annotations list \ + --project_id \ + --job_id \ + --branch "my-feature-branch" \ + --access_token +job_locale_annotation/delete: + lang: CLI v2 + source: |- + phrase job_annotations delete \ + --project_id \ + --job_id \ + --job_locale_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job_locale_annotation/update: + lang: CLI v2 + source: |- + phrase job_annotations update \ + --project_id \ + --job_id \ + --job_locale_id \ + --id \ + --data '{ "value": "Some value...", "branch": "my-feature-branch" }' \ + --access_token +job_locale_annotations/list: + lang: CLI v2 + source: |- + phrase job_annotations list \ + --project_id \ + --job_id \ + --job_locale_id \ + --branch "my-feature-branch" \ + --access_token +job_comment/create: + lang: CLI v2 + source: |- + phrase job_comments create \ + --project_id \ + --job_id \ + --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ + --access_token +job_comment/delete: + lang: CLI v2 + source: |- + phrase job_comments delete \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job_comment/show: + lang: CLI v2 + source: |- + phrase job_comments show \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job_comment/update: + lang: CLI v2 + source: |- + phrase job_comments update \ + --project_id \ + --key_id \ + --id \ + --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ + --access_token +job_comments/list: + lang: CLI v2 + source: |- + phrase job_comments list \ + --project_id \ + --job_id \ + --branch "my-feature-branch" \ + --order "desc" \ + --access_token +job_locale/complete: + lang: CLI v2 + source: |- + phrase job_locales complete \ + --project_id \ + --job_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +job_locale/complete_review: + lang: CLI v2 + source: |- + phrase job_locales complete_review \ + --project_id \ + --job_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +job_locale/delete: + lang: CLI v2 + source: |- + phrase job_locales delete \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job_locale/reopen: + lang: CLI v2 + source: |- + phrase job_locales reopen \ + --project_id \ + --job_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +job_locale/show: + lang: CLI v2 + source: |- + phrase job_locales show \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --include_annotations true \ + --access_token +job_locale/update: + lang: CLI v2 + source: |- + phrase job_locales update \ + --project_id \ + --job_id \ + --id \ + --data '{ "branch": "my-feature-branch", "locale_id": "abcd1234cdef1234abcd1234cdef1234", "user_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_ids": ["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_team_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +job_locales/create: + lang: CLI v2 + source: |- + phrase job_locales create \ + --project_id \ + --job_id \ + --data '{ "branch": "my-feature-branch", "locale_id": "abcd1234cdef1234abcd1234cdef1234", "user_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_ids": ["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_team_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +job_locales/list: + lang: CLI v2 + source: |- + phrase job_locales list \ + --project_id \ + --job_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --include_annotations true \ + --access_token +job_template_locale/delete: + lang: CLI v2 + source: |- + phrase job_template_locales delete \ + --project_id \ + --job_template_id \ + --job_template_locale_id \ + --branch "my-feature-branch" \ + --access_token +job_template_locale/show: + lang: CLI v2 + source: |- + phrase job_template_locales show \ + --project_id \ + --job_template_id \ + --job_template_locale_id \ + --branch "my-feature-branch" \ + --access_token +job_template_locale/update: + lang: CLI v2 + source: |- + phrase job_template_locales update \ + --project_id \ + --job_template_id \ + --job_template_locale_id \ + --data '{ "branch": "my-feature-branch", "locale_id": "abcd1234cdef1234abcd1234cdef1234", "user_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_ids": ["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_team_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +job_template_locales/create: + lang: CLI v2 + source: |- + phrase job_template_locales create \ + --project_id \ + --job_template_id \ + --data '{ "branch": "my-feature-branch", "locale_id": "abcd1234cdef1234abcd1234cdef1234", "user_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_ids": ["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_team_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +job_template_locales/list: + lang: CLI v2 + source: |- + phrase job_template_locales list \ + --project_id \ + --job_template_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +job_template/create: + lang: CLI v2 + source: |- + phrase job_templates create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "name": "template", "briefing": "text", "autotranslate": true, "source_locale_id": "abcd1234cdef1234abcd1234cdef1234" }' \ + --access_token +job_template/delete: + lang: CLI v2 + source: |- + phrase job_templates delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job_template/update: + lang: CLI v2 + source: |- + phrase job_templates update \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "name": "template", "briefing": "text", "autotranslate": true, "source_locale_id": "abcd1234cdef1234abcd1234cdef1234" }' \ + --access_token +job_templates/list: + lang: CLI v2 + source: |- + phrase job_templates list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +job_templates/show: + lang: CLI v2 + source: |- + phrase job_templates show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job/complete: + lang: CLI v2 + source: |- + phrase jobs complete \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +job/create: + lang: CLI v2 + source: |- + phrase jobs create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "name": "de", "source_locale_id": "abcd1234cdef1234abcd1234cdef1234", "briefing": "de-DE", "due_date": "null", "ticket_url": "https://example.atlassian.net/browse/FOO", "tags": ["myUploadTag"], "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"], "target_locale_ids": ["abcd1234cdef1234abcd1234cdef1234"], "job_template_id": "abcd1234cdef1234abcd1234cdef1234", "autotranslate": true }' \ + --access_token +job/delete: + lang: CLI v2 + source: |- + phrase jobs delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job/keys/create: + lang: CLI v2 + source: |- + phrase jobs keys_create \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +job/keys/delete: + lang: CLI v2 + source: |- + phrase jobs keys_delete \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +job/lock: + lang: CLI v2 + source: |- + phrase jobs lock \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job/reopen: + lang: CLI v2 + source: |- + phrase jobs reopen \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +job/show: + lang: CLI v2 + source: |- + phrase jobs show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --include_annotations true \ + --omit_translation_keys true \ + --access_token +job/start: + lang: CLI v2 + source: |- + phrase jobs start \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +job/unlock: + lang: CLI v2 + source: |- + phrase jobs unlock \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +job/update: + lang: CLI v2 + source: |- + phrase jobs update \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "name": "de", "briefing": "de-DE", "due_date": "null", "ticket_url": "https://example.atlassian.net/browse/FOO", "target_locale_ids": ["abcd1234cdef1234abcd1234cdef1234"], "autotranslate": true }' \ + --access_token +jobs/by_account: + lang: CLI v2 + source: |- + phrase jobs by_account \ + --account_id \ + --page "1" \ + --per_page "25" \ + --owned_by "abcd1234cdef1234abcd1234cdef1234" \ + --assigned_to "abcd1234cdef1234abcd1234cdef1234" \ + --state "completed" \ + --updated_since "2013-02-21T00:00:00.000Z" \ + --access_token +jobs/list: + lang: CLI v2 + source: |- + phrase jobs list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --owned_by "abcd1234cdef1234abcd1234cdef1234" \ + --assigned_to "abcd1234cdef1234abcd1234cdef1234" \ + --state "completed" \ + --states '["in_progress","completed"]' \ + --key_id "abcd1234cdef1234abcd1234cdef1234" \ + --updated_since "2013-02-21T00:00:00.000Z" \ + --access_token +key/create: + lang: CLI v2 + source: |- + phrase keys create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "name": "home.index.headline", "description": "Some description worth knowing...", "plural": null, "use_ordinal_rules": null, "name_plural": "home.index.headlines", "data_type": "number", "tags": "awesome-feature,needs-proofreading", "max_characters_allowed": 140, "screenshot": "", "remove_screenshot": null, "unformatted": null, "default_translation_content": "Default translation content", "autotranslate": null, "xml_space_preserve": null, "original_file": "null", "localized_format_string": "null", "localized_format_key": "null", "custom_metadata": {"fruit":"Apple","vegetable":"Tomato"}, "excluded_in_locales": ["de","fr"], "format_value_type": "string" }' \ + --access_token +key/delete: + lang: CLI v2 + source: |- + phrase keys delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +key/show: + lang: CLI v2 + source: |- + phrase keys show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +key/update: + lang: CLI v2 + source: |- + phrase keys update \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "name": "home.index.headline", "description": "Some description worth knowing...", "plural": null, "use_ordinal_rules": null, "name_plural": "home.index.headlines", "data_type": "number", "tags": "awesome-feature,needs-proofreading", "max_characters_allowed": 140, "screenshot": "", "remove_screenshot": null, "unformatted": null, "xml_space_preserve": null, "original_file": "null", "localized_format_string": "null", "localized_format_key": "null", "custom_metadata": {"fruit":"Apple","vegetable":"Tomato"}, "excluded_in_locales": ["de","fr"], "format_value_type": "string" }' \ + --access_token +keys/delete-collection: + lang: CLI v2 + source: |- + phrase keys delete-collection \ + --project_id \ + --branch "my-feature-branch" \ + --q "mykey* translated:true" \ + --locale_id "abcd1234abcd1234abcd1234abcd1234" \ + --access_token +keys/exclude: + lang: CLI v2 + source: |- + phrase keys exclude \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "mykey* translated:true", "target_locale_id": "abcd1234abcd1234abcd1234abcd1234", "tags": "landing-page,release-1.2" }' \ + --access_token +keys/include: + lang: CLI v2 + source: |- + phrase keys include \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "mykey* translated:true", "target_locale_id": "abcd1234abcd1234abcd1234abcd1234", "tags": "landing-page,release-1.2" }' \ + --access_token +keys/list: + lang: CLI v2 + source: |- + phrase keys list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --sort "updated_at" \ + --order "desc" \ + --q "mykey* translated:true" \ + --locale_id "abcd1234abcd1234abcd1234abcd1234" \ + --access_token +keys/search: + lang: CLI v2 + source: |- + phrase keys search \ + --project_id \ + --page "1" \ + --per_page "25" \ + --data '{ "branch": "my-feature-branch", "sort": "updated_at", "order": "desc", "q": "mykey* translated:true", "locale_id": "abcd1234abcd1234abcd1234abcd1234" }' \ + --access_token +keys/tag: + lang: CLI v2 + source: |- + phrase keys tag \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "mykey* translated:true", "locale_id": "abcd1234abcd1234abcd1234abcd1234", "tags": "landing-page,release-1.2" }' \ + --access_token +keys/untag: + lang: CLI v2 + source: |- + phrase keys untag \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "mykey* translated:true", "locale_id": "abcd1234abcd1234abcd1234abcd1234", "tags": "landing-page,release-1.2" }' \ + --access_token +figma_attachment/attach_to_key: + lang: CLI v2 + source: |- + phrase keys_figma_attachments attach_to_key \ + --project_id \ + --figma_attachment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +figma_attachment/detach_from_key: + lang: CLI v2 + source: |- + phrase keys_figma_attachments detach_from_key \ + --project_id \ + --figma_attachment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +key_links/batch_destroy: + lang: CLI v2 + source: |- + phrase linked_keys batch_destroy \ + --project_id \ + --id \ + --data '{ "child_key_ids": ["feature.subtitle","nav.home"], "unlink_parent": null, "strategy": "null" }' \ + --access_token +key_links/create: + lang: CLI v2 + source: |- + phrase linked_keys create \ + --project_id \ + --id \ + --data '{ "child_key_ids": ["ijkl9012mnop3456ijkl9012mnop3456","abcd1234efgh5678abcd1234efgh5678"] }' \ + --access_token +key_links/destroy: + lang: CLI v2 + source: |- + phrase linked_keys destroy \ + --project_id \ + --id \ + --child_key_id \ + --access_token +key_links/index: + lang: CLI v2 + source: |- + phrase linked_keys index \ + --project_id \ + --id \ + --access_token +locale_download/create: + lang: CLI v2 + source: |- + phrase locale_downloads create \ + --project_id \ + --locale_id \ + --if_modified_since "2024-03-15T09:00:00Z" \ + --if_none_match "W/\"123456789\"" \ + --data '{ "file_format": "yml", "branch": "my-feature-branch", "tags": "feature1,feature2", "include_empty_translations": true, "exclude_empty_zero_forms": true, "include_translated_keys": true, "keep_notranslate_tags": true, "format_options": {"format_options":{"foo":"bar"}}, "encoding": "UTF-8", "include_unverified_translations": true, "use_last_reviewed_version": null, "locale_ids": ["de","en"], "fallback_locale_id": "abcd1234abcd1234abcd1234abcd1234", "use_locale_fallback": false, "fallback_for_unverified_translations": false, "source_locale_id": "abcd1234abcd1234abcd1234abcd1234", "custom_metadata_filters": null, "translation_key_prefix": "prefix_", "filter_by_prefix": null, "updated_since": "2023-01-01T00:00:00Z" }' \ + --access_token +locale_download/show: + lang: CLI v2 + source: |- + phrase locale_downloads show \ + --project_id \ + --locale_id \ + --id \ + --if_modified_since "2024-03-15T09:00:00Z" \ + --if_none_match "W/\"123456789\"" \ + --access_token +account/locales: + lang: CLI v2 + source: |- + phrase locales locales \ + --id \ + --page "1" \ + --per_page "25" \ + --access_token +locale/create: + lang: CLI v2 + source: |- + phrase locales create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "name": "de", "code": "de-DE", "default": null, "main": null, "rtl": null, "source_locale_id": "abcd1234abcd1234abcd1234abcd1234", "fallback_locale_id": "abcd1234abcd1234abcd1234abcd1234", "unverify_new_translations": null, "unverify_updated_translations": null, "autotranslate": null, "language_ai_profile": "abcd1234abcd1234abcd1234abcd1234" }' \ + --access_token +locale/delete: + lang: CLI v2 + source: |- + phrase locales delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +locale/download: + lang: CLI v2 + source: |- + phrase locales download \ + --project_id \ + --id \ + --if_modified_since "2024-03-15T09:00:00Z" \ + --if_none_match "W/\"123456789\"" \ + --branch "my-feature-branch" \ + --file_format "yml" \ + --tags "feature1,feature2" \ + --tag "feature" \ + --include_empty_translations true \ + --exclude_empty_zero_forms true \ + --include_translated_keys true \ + --keep_notranslate_tags true \ + --convert_emoji true \ + --format_options '{ }' \ + --encoding "encoding_example" \ + --skip_unverified_translations true \ + --include_unverified_translations true \ + --use_last_reviewed_version true \ + --fallback_locale_id "fallbackLocaleId_example" \ + --use_locale_fallback true \ + --fallback_for_unverified_translations true \ + --source_locale_id "sourceLocaleId_example" \ + --translation_key_prefix "prefix_" \ + --filter_by_prefix true \ + --custom_metadata_filters '{ }' \ + --locale_ids '["de","en"]' \ + --updated_since "2023-01-01T00:00:00Z" \ + --access_token +locale/show: + lang: CLI v2 + source: |- + phrase locales show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +locale/update: + lang: CLI v2 + source: |- + phrase locales update \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "name": "de", "code": "de-DE", "default": null, "main": null, "rtl": null, "source_locale_id": "abcd1234abcd1234abcd1234abcd1234", "fallback_locale_id": "abcd1234abcd1234abcd1234abcd1234", "unverify_new_translations": null, "unverify_updated_translations": null, "autotranslate": null, "language_ai_profile": "abcd1234abcd1234abcd1234abcd1234" }' \ + --access_token +locales/list: + lang: CLI v2 + source: |- + phrase locales list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --sort_by "sortBy_example" \ + --branch "my-feature-branch" \ + --q "name:en" \ + --access_token +member/delete: + lang: CLI v2 + source: |- + phrase members delete \ + --account_id \ + --id \ + --access_token +member/show: + lang: CLI v2 + source: |- + phrase members show \ + --account_id \ + --id \ + --access_token +member/update: + lang: CLI v2 + source: |- + phrase members update \ + --account_id \ + --id \ + --data '{ "strategy": "set", "role": "Developer", "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "locale_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "default_locale_codes": ["en","fi"], "space_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"], "permissions": {"create_upload":true,"review_translations":true} }' \ + --access_token +member/update_settings: + lang: CLI v2 + source: |- + phrase members update_settings \ + --project_id \ + --id \ + --data '{ "project_role": "Developer", "locale_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ + --access_token +members/list: + lang: CLI v2 + source: |- + phrase members list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +notification_groups/list: + lang: CLI v2 + source: |- + phrase notification_groups list \ + --page "1" \ + --per_page "25" \ + --access_token +notification_groups/mark_all_as_read: + lang: CLI v2 + source: |- + phrase notification_groups mark_all_as_read \ + --access_token +notification_groups/mark_as_read: + lang: CLI v2 + source: |- + phrase notification_groups mark_as_read \ + --id \ + --access_token +notifications/list: + lang: CLI v2 + source: |- + phrase notifications list \ + --page "1" \ + --per_page "25" \ + --unseen true \ + --last_days "7" \ + --access_token +notifications/mark_all_as_read: + lang: CLI v2 + source: |- + phrase notifications mark_all_as_read \ + --access_token +notifications/show: + lang: CLI v2 + source: |- + phrase notifications show \ + --id \ + --access_token +order/confirm: + lang: CLI v2 + source: |- + phrase orders confirm \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +order/create: + lang: CLI v2 + source: |- + phrase orders create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "name": "Welcome message translations", "lsp": "textmaster", "source_locale_id": "abcd1234abcd1234abcd1234abcd1234", "target_locale_ids": ["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"], "translation_type": "premium", "tag": "my-awesome-feature", "message": "Please make everything sound really nice :)", "styleguide_id": "1234abcd1234abcd1234abcd1234abcd", "unverify_translations_upon_delivery": null, "include_untranslated_keys": null, "include_unverified_translations": null, "category": "C021", "quality": null, "priority": null }' \ + --access_token +order/delete: + lang: CLI v2 + source: |- + phrase orders delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +order/show: + lang: CLI v2 + source: |- + phrase orders show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +orders/list: + lang: CLI v2 + source: |- + phrase orders list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --translation_id "abcd1234cdef1234abcd1234cdef1234" \ + --access_token +organization_job_template_locale/delete: + lang: CLI v2 + source: |- + phrase organization_job_template_locales delete \ + --account_id \ + --job_template_id \ + --job_template_locale_id \ + --access_token +organization_job_template_locale/show: + lang: CLI v2 + source: |- + phrase organization_job_template_locales show \ + --account_id \ + --job_template_id \ + --job_template_locale_id \ + --access_token +organization_job_template_locale/update: + lang: CLI v2 + source: |- + phrase organization_job_template_locales update \ + --account_id \ + --job_template_id \ + --job_template_locale_id \ + --data '{ "locale_name": "de-1", "locale_code": "de-DE", "user_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_ids": ["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_team_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +organization_job_template_locales/create: + lang: CLI v2 + source: |- + phrase organization_job_template_locales create \ + --account_id \ + --job_template_id \ + --data '{ "locale_name": "de-1", "locale_code": "de-DE", "user_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_ids": ["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids": ["abcd1234cdef1234abcd1234cdef1234"], "reviewer_team_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +organization_job_template_locales/list: + lang: CLI v2 + source: |- + phrase organization_job_template_locales list \ + --account_id \ + --job_template_id \ + --page "1" \ + --per_page "25" \ + --access_token +organization_job_template/create: + lang: CLI v2 + source: |- + phrase organization_job_templates create \ + --account_id \ + --data '{ "name": "template", "briefing": "text", "autotranslate": true }' \ + --access_token +organization_job_template/delete: + lang: CLI v2 + source: |- + phrase organization_job_templates delete \ + --account_id \ + --id \ + --access_token +organization_job_template/update: + lang: CLI v2 + source: |- + phrase organization_job_templates update \ + --account_id \ + --id \ + --data '{ "name": "template", "briefing": "text", "autotranslate": true }' \ + --access_token +organization_job_templates/list: + lang: CLI v2 + source: |- + phrase organization_job_templates list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +organization_job_templates/show: + lang: CLI v2 + source: |- + phrase organization_job_templates show \ + --account_id \ + --id \ + --access_token +project/create: + lang: CLI v2 + source: |- + phrase projects create \ + --data '{ "name": "My Android Project", "main_format": "yml", "media": "Python", "shares_translation_memory": true, "project_image": "", "remove_project_image": null, "account_id": "abcd1234", "point_of_contact": "abcd1234", "source_project_id": "abcd1234", "workflow": "review", "machine_translation_enabled": true, "enable_branching": true, "protect_master_branch": true, "enable_all_data_type_translation_keys_for_translators": true, "enable_icu_message_format": true, "zero_plural_form_enabled": true, "autotranslate_enabled": true, "autotranslate_check_new_translation_keys": true, "autotranslate_check_new_uploads": true, "autotranslate_check_new_locales": true, "autotranslate_mark_as_unverified": true, "autotranslate_use_machine_translation": true, "autotranslate_use_translation_memory": true, "autotranslate_overwrite_unverified_translations": true, "autocomplete_job_enabled": false, "job_locking_enabled": false, "smart_suggest_enabled": true, "smart_suggest_use_glossary": true, "smart_suggest_use_machine_translation": true, "translation_keys_sort_collation": "unicode_ci", "default_encoding": "UTF-8", "cldr_version": "cldr48", "placeholder_styles": ["angular","iOS"] }' \ + --access_token +project/delete: + lang: CLI v2 + source: |- + phrase projects delete \ + --id \ + --access_token +project/show: + lang: CLI v2 + source: |- + phrase projects show \ + --id \ + --access_token +project/update: + lang: CLI v2 + source: |- + phrase projects update \ + --id \ + --data '{ "account_id": "abcd1234", "name": "My Android Project", "point_of_contact": "abcd1234", "main_format": "yml", "media": "Python", "shares_translation_memory": true, "project_image": "", "remove_project_image": false, "workflow": "review", "machine_translation_enabled": true, "enable_branching": true, "protect_master_branch": true, "enable_all_data_type_translation_keys_for_translators": true, "enable_icu_message_format": true, "zero_plural_form_enabled": true, "autotranslate_enabled": true, "autotranslate_check_new_translation_keys": true, "autotranslate_check_new_uploads": true, "autotranslate_check_new_locales": true, "autotranslate_mark_as_unverified": true, "autotranslate_use_machine_translation": true, "autotranslate_use_translation_memory": true, "autotranslate_overwrite_unverified_translations": true, "default_encoding": "UTF-8", "placeholder_styles": ["angular","iOS"], "autocomplete_job_enabled": false, "job_locking_enabled": false, "smart_suggest_enabled": true, "smart_suggest_use_glossary": true, "smart_suggest_use_machine_translation": true, "translation_keys_sort_collation": "unicode_ci", "cldr_version": "legacy" }' \ + --access_token +projects/list: + lang: CLI v2 + source: |- + phrase projects list \ + --page "1" \ + --per_page "25" \ + --account_id "accountId_example" \ + --sort_by "sortBy_example" \ + --filters 'favorites' \ + --q "name:android" \ + --access_token +quality_performance_score/list: + lang: CLI v2 + source: |- + phrase quality_performance_score list \ + --project_id \ + --data '{ "translation_ids": null }' \ + --access_token +release_triggers/create: + lang: CLI v2 + source: |- + phrase release_triggers create \ + --account_id \ + --distribution_id \ + --data '{ "cron_schedule": "15 18 * * 1,3", "time_zone": "Europe/Berlin", "locale_ids": ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"], "tags": ["android","feature1"], "branch": "my-feature-branch", "app_min_version": "1.0.0", "app_max_version": "2.0.0" }' \ + --access_token +release_triggers/destroy: + lang: CLI v2 + source: |- + phrase release_triggers destroy \ + --account_id \ + --distribution_id \ + --id \ + --access_token +release_triggers/list: + lang: CLI v2 + source: |- + phrase release_triggers list \ + --account_id \ + --distribution_id \ + --access_token +release_triggers/show: + lang: CLI v2 + source: |- + phrase release_triggers show \ + --account_id \ + --distribution_id \ + --id \ + --access_token +release_triggers/update: + lang: CLI v2 + source: |- + phrase release_triggers update \ + --account_id \ + --distribution_id \ + --id \ + --data '{ "cron_schedule": "15 18 * * 1,3", "time_zone": "Europe/Berlin", "locale_ids": ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"], "tags": ["android","feature1"], "branch": "my-feature-branch", "app_min_version": "1.0.0", "app_max_version": "2.0.0" }' \ + --access_token +release/create: + lang: CLI v2 + source: |- + phrase releases create \ + --account_id \ + --distribution_id \ + --data '{ "description": "My first Release", "platforms": ["android","ios"], "locale_ids": ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"], "tags": ["android","feature1"], "app_min_version": "2.5.0", "app_max_version": "3.0.0", "branch": "my-feature-branch" }' \ + --access_token +release/delete: + lang: CLI v2 + source: |- + phrase releases delete \ + --account_id \ + --distribution_id \ + --id \ + --access_token +release/publish: + lang: CLI v2 + source: |- + phrase releases publish \ + --account_id \ + --distribution_id \ + --id \ + --access_token +release/show: + lang: CLI v2 + source: |- + phrase releases show \ + --account_id \ + --distribution_id \ + --id \ + --access_token +release/update: + lang: CLI v2 + source: |- + phrase releases update \ + --account_id \ + --distribution_id \ + --id \ + --data '{ "description": "My first Release", "platforms": ["android","ios"], "app_min_version": "2.5.0", "app_max_version": "3.0.0", "branch": "my-feature-branch" }' \ + --access_token +releases/list: + lang: CLI v2 + source: |- + phrase releases list \ + --account_id \ + --distribution_id \ + --page "1" \ + --per_page "25" \ + --access_token +repo_sync_event/list: + lang: CLI v2 + source: |- + phrase repo_sync_events list \ + --account_id \ + --id \ + --access_token +repo_sync_event/show: + lang: CLI v2 + source: |- + phrase repo_sync_events show \ + --account_id \ + --repo_sync_id \ + --id \ + --access_token +repo_sync/activate: + lang: CLI v2 + source: |- + phrase repo_syncs activate \ + --account_id \ + --id \ + --access_token +repo_sync/create: + lang: CLI v2 + source: |- + phrase repo_syncs create \ + --account_id \ + --data '{ "project_id": "abcd1234abcd1234abcd1234abcd1234", "name": "null", "git_provider": "github", "connection_type": "github_app", "repo_name": "my-org/my-repo", "base_branch": "main", "pr_branch": "phrase-translations", "auto_import": false, "access_token": "ghp_xxxxxxxxxxxxxxxxxxxx", "custom_api_endpoint": "https://git.example.com/api/v4" }' \ + --access_token +repo_sync/deactivate: + lang: CLI v2 + source: |- + phrase repo_syncs deactivate \ + --account_id \ + --id \ + --access_token +repo_sync/export: + lang: CLI v2 + source: |- + phrase repo_syncs export \ + --account_id \ + --id \ + --data '{ "pr_branch": "my-feature-branch", "branch": "my-strings-branch" }' \ + --access_token +repo_sync/import: + lang: CLI v2 + source: |- + phrase repo_syncs import \ + --account_id \ + --id \ + --data '{ "repository_branch": "my-feature-branch", "branch": "my-strings-branch" }' \ + --access_token +repo_sync/list: + lang: CLI v2 + source: |- + phrase repo_syncs list \ + --account_id \ + --access_token +repo_sync/show: + lang: CLI v2 + source: |- + phrase repo_syncs show \ + --account_id \ + --id \ + --access_token +report/locales/list: + lang: CLI v2 + source: |- + phrase reports locales_list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --locale_codes "localeCodes_example" \ + --tag "tag_example" \ + --branch "my-feature-branch" \ + --access_token +report/show: + lang: CLI v2 + source: |- + phrase reports show \ + --project_id \ + --branch "my-feature-branch" \ + --access_token +screenshot_marker/create: + lang: CLI v2 + source: |- + phrase screenshot_markers create \ + --project_id \ + --screenshot_id \ + --data '{ "branch": "my-feature-branch", "key_id": "abcd1234abcd1234abcd1234abcd1234", "presentation": "{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }" }' \ + --access_token +screenshot_marker/delete: + lang: CLI v2 + source: |- + phrase screenshot_markers delete \ + --project_id \ + --screenshot_id \ + --branch "my-feature-branch" \ + --access_token +screenshot_marker/show: + lang: CLI v2 + source: |- + phrase screenshot_markers show \ + --project_id \ + --screenshot_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +screenshot_marker/update: + lang: CLI v2 + source: |- + phrase screenshot_markers update \ + --project_id \ + --screenshot_id \ + --data '{ "branch": "my-feature-branch", "key_id": "abcd1234abcd1234abcd1234abcd1234", "presentation": "{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }" }' \ + --access_token +screenshot_markers/list: + lang: CLI v2 + source: |- + phrase screenshot_markers list \ + --project_id \ + --id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +screenshot/create: + lang: CLI v2 + source: |- + phrase screenshots create \ + --project_id \ + --filename \ + --branch "branch_example" \ + --name "name_example" \ + --description "description_example" \ + --access_token +screenshot/delete: + lang: CLI v2 + source: |- + phrase screenshots delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +screenshot/show: + lang: CLI v2 + source: |- + phrase screenshots show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +screenshot/update: + lang: CLI v2 + source: |- + phrase screenshots update \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "name": "A screenshot name", "description": "A screenshot description", "filename": "" }' \ + --access_token +screenshots/list: + lang: CLI v2 + source: |- + phrase screenshots list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --key_id "abcd1234cdef1234abcd1234cdef1234" \ + --access_token +search/in_account: + lang: CLI v2 + source: |- + phrase search in_account \ + --account_id \ + --data '{ "query": "keyword", "locale_code": "de_DE", "page": 1, "per_page": 25, "project_ids": ["abcd1234abcd1234abcd1234abcd1234"] }' \ + --access_token +space/create: + lang: CLI v2 + source: |- + phrase spaces create \ + --account_id \ + --data '{ "name": "My Android Projects" }' \ + --access_token +space/delete: + lang: CLI v2 + source: |- + phrase spaces delete \ + --account_id \ + --id \ + --access_token +space/show: + lang: CLI v2 + source: |- + phrase spaces show \ + --account_id \ + --id \ + --access_token +space/update: + lang: CLI v2 + source: |- + phrase spaces update \ + --account_id \ + --id \ + --data '{ "name": "My Android Projects" }' \ + --access_token +spaces/list: + lang: CLI v2 + source: |- + phrase spaces list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +spaces/projects/create: + lang: CLI v2 + source: |- + phrase spaces projects_create \ + --account_id \ + --space_id \ + --data '{ "id": "a4b3c2d1" }' \ + --access_token +spaces/projects/delete: + lang: CLI v2 + source: |- + phrase spaces projects_delete \ + --account_id \ + --space_id \ + --id \ + --access_token +spaces/projects/list: + lang: CLI v2 + source: |- + phrase spaces projects_list \ + --account_id \ + --space_id \ + --page "1" \ + --per_page "25" \ + --access_token +styleguide/create: + lang: CLI v2 + source: |- + phrase style_guides create \ + --project_id \ + --data '{ "title": "Web application style guide", "audience": "customer-facing", "target_audience": "teenager", "grammatical_person": "first_person_singular", "vocabulary_type": "technical", "business": "We are a travel site that helps customers find the best hotels and flights.", "company_branding": "ACME Inc. should never be translated.", "formatting": "Never use capital letters", "glossary_terms": "Apartment, cabin, loft", "grammar_consistency": "Use informal pronouns and consistent present-tense conjugation", "literal_translation": "Neutral", "overall_tone": "Tone should be fun and light", "samples": "http://www.myexample.com/my/document/path/to/samples.pdf" }' \ + --access_token +styleguide/delete: + lang: CLI v2 + source: |- + phrase style_guides delete \ + --project_id \ + --id \ + --access_token +styleguide/show: + lang: CLI v2 + source: |- + phrase style_guides show \ + --project_id \ + --id \ + --access_token +styleguide/update: + lang: CLI v2 + source: |- + phrase style_guides update \ + --project_id \ + --id \ + --data '{ "title": "Web application style guide", "audience": "customer-facing", "target_audience": "teenager", "grammatical_person": "first_person_singular", "vocabulary_type": "technical", "business": "We are a travel site that helps customers find the best hotels and flights.", "company_branding": "ACME Inc. should never be translated.", "formatting": "Never use capital letters", "glossary_terms": "Apartment, cabin, loft", "grammar_consistency": "Use informal pronouns and consistent present-tense conjugation", "literal_translation": "Neutral", "overall_tone": "Tone should be fun and light", "samples": "http://www.myexample.com/my/document/path/to/samples.pdf" }' \ + --access_token +styleguides/list: + lang: CLI v2 + source: |- + phrase style_guides list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --access_token +tag/create: + lang: CLI v2 + source: |- + phrase tags create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "name": "my-feature" }' \ + --access_token +tag/delete: + lang: CLI v2 + source: |- + phrase tags delete \ + --project_id \ + --name \ + --branch "my-feature-branch" \ + --access_token +tag/show: + lang: CLI v2 + source: |- + phrase tags show \ + --project_id \ + --name \ + --omit_statistics true \ + --branch "my-feature-branch" \ + --access_token +tags/list: + lang: CLI v2 + source: |- + phrase tags list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --exclude_system_tags true \ + --only_system_tags false \ + --branch "my-feature-branch" \ + --q "feature" \ + --access_token +team/create: + lang: CLI v2 + source: |- + phrase teams create \ + --account_id \ + --data '{ "name": "German Translators" }' \ + --access_token +team/delete: + lang: CLI v2 + source: |- + phrase teams delete \ + --account_id \ + --id \ + --access_token +team/show: + lang: CLI v2 + source: |- + phrase teams show \ + --account_id \ + --id \ + --access_token +team/update: + lang: CLI v2 + source: |- + phrase teams update \ + --account_id \ + --id \ + --data '{ "name": "German Translators" }' \ + --access_token +teams/list: + lang: CLI v2 + source: |- + phrase teams list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +teams/projects/create: + lang: CLI v2 + source: |- + phrase teams projects_create \ + --account_id \ + --team_id \ + --data '{ "id": "a4b3c2d1" }' \ + --access_token +teams/projects/delete: + lang: CLI v2 + source: |- + phrase teams projects_delete \ + --account_id \ + --team_id \ + --id \ + --access_token +teams/spaces/create: + lang: CLI v2 + source: |- + phrase teams spaces_create \ + --account_id \ + --team_id \ + --data '{ "id": "a4b3c2d1" }' \ + --access_token +teams/spaces/delete: + lang: CLI v2 + source: |- + phrase teams spaces_delete \ + --account_id \ + --team_id \ + --id \ + --access_token +teams/users/create: + lang: CLI v2 + source: |- + phrase teams users_create \ + --account_id \ + --team_id \ + --data '{ "id": "a4b3c2d1" }' \ + --access_token +teams/users/delete: + lang: CLI v2 + source: |- + phrase teams users_delete \ + --account_id \ + --team_id \ + --id \ + --access_token +translation/create: + lang: CLI v2 + source: |- + phrase translations create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "locale_id": "abcd1234cdef1234abcd1234cdef1234", "key_id": "abcd1234cdef1234abcd1234cdef1234", "content": "My translation", "plural_suffix": "null", "unverified": null, "excluded": null, "autotranslate": null, "minor_change": false, "reviewed": false }' \ + --access_token +translation/exclude: + lang: CLI v2 + source: |- + phrase translations exclude \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +translation/include: + lang: CLI v2 + source: |- + phrase translations include \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +translation/review: + lang: CLI v2 + source: |- + phrase translations review \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +translation/show: + lang: CLI v2 + source: |- + phrase translations show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +translation/unreview: + lang: CLI v2 + source: |- + phrase translations unreview \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +translation/unverify: + lang: CLI v2 + source: |- + phrase translations unverify \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +translation/update: + lang: CLI v2 + source: |- + phrase translations update \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "content": "My translation", "plural_suffix": "null", "unverified": null, "excluded": null, "autotranslate": null, "reviewed": true, "minor_change": false }' \ + --access_token +translation/verify: + lang: CLI v2 + source: |- + phrase translations verify \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +translations/by_key: + lang: CLI v2 + source: |- + phrase translations by_key \ + --project_id \ + --key_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --sort "updated_at" \ + --order "desc" \ + --q "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" \ + --access_token +translations/by_locale: + lang: CLI v2 + source: |- + phrase translations by_locale \ + --project_id \ + --locale_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --sort "updated_at" \ + --order "desc" \ + --q "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" \ + --access_token +translations/exclude-collection: + lang: CLI v2 + source: |- + phrase translations exclude-collection \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "PhraseApp*%20verified:true%20tags:feature,center", "sort": "updated_at", "order": "desc" }' \ + --access_token +translations/include-collection: + lang: CLI v2 + source: |- + phrase translations include-collection \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "PhraseApp*%20verified:true%20tags:feature,center", "sort": "updated_at", "order": "desc" }' \ + --access_token +translations/list: + lang: CLI v2 + source: |- + phrase translations list \ + --project_id \ + --if_modified_since "2024-03-15T09:00:00Z" \ + --if_none_match "W/\"123456789\"" \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --key_id "abcd1234cdef1234abcd1234cdef1234" \ + --locale_id "abcd1234cdef1234abcd1234cdef1234" \ + --sort "updated_at" \ + --order "desc" \ + --q "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" \ + --access_token +translations/review-collection: + lang: CLI v2 + source: |- + phrase translations review-collection \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "PhraseApp*%reviewed:false%20tags:feature,center" }' \ + --access_token +translations/search: + lang: CLI v2 + source: |- + phrase translations search \ + --project_id \ + --page "1" \ + --per_page "25" \ + --data '{ "branch": "my-feature-branch", "sort": "updated_at", "order": "desc", "q": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" }' \ + --access_token +translations/unreview-collection: + lang: CLI v2 + source: |- + phrase translations unreview-collection \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "PhraseApp*%reviewed:true%20tags:feature,center" }' \ + --access_token +translations/unverify-collection: + lang: CLI v2 + source: |- + phrase translations unverify-collection \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "PhraseApp*%20verified:true%20tags:feature,center", "sort": "updated_at", "order": "desc" }' \ + --access_token +translations/verify-collection: + lang: CLI v2 + source: |- + phrase translations verify-collection \ + --project_id \ + --data '{ "branch": "my-feature-branch", "locale_id": "fc2f11dd6a658fa9652f6f0a9ebee688", "q": "PhraseApp*%20unverified:true%20tags:feature,center" }' \ + --access_token +upload_batches/create: + lang: CLI v2 + source: |- + phrase upload_batches create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "delete_unmentioned_keys": true, "upload_ids": ["abcd1234cdef1234abcd1234cdef1234","bcde2345defg2345bcde2345defg2345"] }' \ + --access_token +upload/create: + lang: CLI v2 + source: |- + phrase uploads create \ + --project_id \ + --file \ + --file_format "fileFormat_example" \ + --locale_id "localeId_example" \ + --branch "branch_example" \ + --tags "tags_example" \ + --update_translations true \ + --update_custom_metadata true \ + --update_translation_keys true \ + --update_translations_on_source_match true \ + --source_locale_id "sourceLocaleId_example" \ + --update_descriptions true \ + --convert_emoji true \ + --skip_upload_tags true \ + --skip_unverification true \ + --file_encoding "fileEncoding_example" \ + --locale_mapping '{ }' \ + --format_options '{ }' \ + --autotranslate true \ + --verify_mentioned_translations true \ + --mark_reviewed true \ + --tag_only_affected_keys true \ + --translation_key_prefix "translationKeyPrefix_example" \ + --skip_automated_job_creation true \ + --access_token +upload/show: + lang: CLI v2 + source: |- + phrase uploads show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +uploads/list: + lang: CLI v2 + source: |- + phrase uploads list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +show/user: + lang: CLI v2 + source: |- + phrase users user \ + --access_token +variable/create: + lang: CLI v2 + source: |- + phrase variables create \ + --project_id \ + --data '{ "name": "MY_VARIABLE", "value": "Hello World" }' \ + --access_token +variable/delete: + lang: CLI v2 + source: |- + phrase variables delete \ + --project_id \ + --name \ + --access_token +variable/show: + lang: CLI v2 + source: |- + phrase variables show \ + --project_id \ + --name \ + --access_token +variable/update: + lang: CLI v2 + source: |- + phrase variables update \ + --project_id \ + --name \ + --data '{ "name": "MY_VARIABLE", "value": "Hello World" }' \ + --access_token +variables/list: + lang: CLI v2 + source: |- + phrase variables list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --access_token +version/show: + lang: CLI v2 + source: |- + phrase versions_history show \ + --project_id \ + --translation_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +versions/list: + lang: CLI v2 + source: |- + phrase versions_history list \ + --project_id \ + --translation_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --only_content_updates true \ + --access_token +webhook_deliveries/list: + lang: CLI v2 + source: |- + phrase webhook_deliveries list \ + --project_id \ + --webhook_id \ + --response_status_codes "responseStatusCodes_example" \ + --access_token +webhook_deliveries/redeliver: + lang: CLI v2 + source: |- + phrase webhook_deliveries redeliver \ + --project_id \ + --webhook_id \ + --id \ + --access_token +webhook_deliveries/show: + lang: CLI v2 + source: |- + phrase webhook_deliveries show \ + --project_id \ + --webhook_id \ + --id \ + --access_token +webhook/create: + lang: CLI v2 + source: |- + phrase webhooks create \ + --project_id \ + --data '{ "callback_url": "http://example.com/hooks/phraseapp-notifications", "secret": "secr3t", "description": "My webhook for chat notifications", "events": "locales:create,translations:update", "active": null, "include_branches": null }' \ + --access_token +webhook/delete: + lang: CLI v2 + source: |- + phrase webhooks delete \ + --project_id \ + --id \ + --access_token +webhook/show: + lang: CLI v2 + source: |- + phrase webhooks show \ + --project_id \ + --id \ + --access_token +webhook/test: + lang: CLI v2 + source: |- + phrase webhooks test \ + --project_id \ + --id \ + --access_token +webhook/update: + lang: CLI v2 + source: |- + phrase webhooks update \ + --project_id \ + --id \ + --data '{ "callback_url": "http://example.com/hooks/phraseapp-notifications", "secret": "secr3t", "description": "My webhook for chat notifications", "events": "locales:create,translations:update", "active": null, "include_branches": null }' \ + --access_token +webhooks/list: + lang: CLI v2 + source: |- + phrase webhooks list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --access_token + diff --git a/openapi-generator/cli_examples_lang.yaml b/openapi-generator/cli_examples_lang.yaml new file mode 100644 index 00000000..84853635 --- /dev/null +++ b/openapi-generator/cli_examples_lang.yaml @@ -0,0 +1,11 @@ +'!include': shared.yaml +generatorName: go +outputDir: tmp/cli-examples +packageName: phrase +templateDir: openapi-generator/templates/cli +apiNameSuffix: Api +# Only emit the CLI examples data file; skip the actual client code/docs. +files: + cli_examples.handlebars: + destinationFilename: ../../examples/cli.yaml + templateType: SupportingFiles diff --git a/openapi-generator/templates/TEMPLATING.md b/openapi-generator/templates/TEMPLATING.md new file mode 100644 index 00000000..0a8686d8 --- /dev/null +++ b/openapi-generator/templates/TEMPLATING.md @@ -0,0 +1,213 @@ +# OpenAPI Generator templating notes + +Hard-won knowledge for working with the handlebars/mustache templates in this +directory. Read this before editing templates or trying to generate anything new +from the spec (e.g. per-client code-sample files). + +## The big picture + +Clients are generated by `openapi-generator-cli` (v7.0.1, pinned in +`package.json`). Each `make ` target (see top-level `Makefile`) runs the +generator with: + +- `-i tmp/compiled.yaml` — the bundled spec (produced by `make bundle`) +- `-g ` — the **language generator** (Java code inside the jar) +- `-c openapi-generator/_lang.yaml` — config (`templateDir`, etc.) +- `-e handlebars` — use the handlebars engine (not the default mustache) + +**Crucial fact: there is no separate "CLI" generator.** The CLI client uses +`generatorName: go` (same engine as the Go client), differing only in +`templateDir: openapi-generator/templates/cli` and `apiNameSuffix: Api`. Run +`openapi-generator-cli list` — there is no `cli` generator. + +### Two-stage pipeline (this explains most surprises) + +1. **Language generator (Java, in the jar)** parses the spec into a model of + `CodegenOperation` / `CodegenParameter` objects. This stage is where data is + transformed, dropped, or synthesized — and you cannot change it without a + custom generator. +2. **Templates** render *only what those objects expose*. A template cannot reach + back into the raw spec for anything the generator didn't put on the model. + +## What the `go` generator does to your data (verified) + +- **Parameter examples are synthesized, not taken from the spec — UNLESS the + param has an explicit `example:`.** A param with no example renders as + `_example` (e.g. `projectId_example`); a param *with* `example:` + renders the real value. So `{{example}}` is only trustworthy when the spec + defines one. +- **Path params** almost never have a spec `example:`, so they come through as + `projectId_example`. Use `{{#isPathParam}}` to render a `` instead. +- **JSON request bodies**: the body param exposes `{{#bodyParam}}{{#vars}}`, and + **each var carries its real spec `example:`** (assembled from the schema's + property examples). This is the reliable way to build a `--data '{...}'` payload. + Per-var type flags are available: `isString`, `isArray`, `isNumeric`, + `isBoolean`, `isMap`, `isBinary`. Use them to decide whether to quote the value + in JSON (strings/dates → quoted; arrays/numbers/bools/maps → raw, because the + example is already valid JSON). +- **Multipart/form bodies are flattened into `allParams`** (not `bodyParam`), and + their form-field examples are **lost** (synthesized as `*_example`). There is no + way to recover them in-template. Only 2 endpoints are multipart + (`uploads/create`, `screenshots/create`). The same per-type quoting rules apply + in `allParams` as in body `vars` (see below): booleans render unquoted, and + map/object fields come through with a useless example value of the literal + string `Object` (`isMap`/`isFreeFormObject` true) — render a `'{ }'` placeholder + for those rather than `"Object"`. +- **Binary fields** render as Go artifacts: `BINARY_DATA_HERE` (param) or + `[B@` (JSON body var). Detect with `{{#isBinary}}` and emit a placeholder. +- A handful of spec fields are typed `string` but hold JSON-object examples + (`presentation`, `custom_metadata`). Because `isString` is true, the template + quotes them, producing quoted-string-containing-quotes → invalid JSON. The root + cause is the spec modeling (string type, object example). Options: detect that + the example starts with `{`/`[` and emit it raw, fix the spec to type the field + as `object`, or accept the invalid `--data` for those few fields. + +### Per-type quoting rule for `--data` / form values + +The example value's type determines quoting. Verified flags on body `vars` and +`allParams`: + +| type flag | render as | why | +|----------------|----------------------|--------------------------------------| +| `isBinary` | `""` | example is a Go `[]byte` artifact | +| `isBoolean` | `true` (unquoted) | valid JSON / shell literal | +| `isNumeric` | `123` (unquoted) | valid JSON literal | +| `isArray` | `["a","b"]` (raw) | example is already valid JSON array | +| `isMap` | `{...}` (raw) / `'{ }'` placeholder in form flags | example may be the literal `Object` | +| else (string) | `"value"` (quoted) | default | + +Order the inverted sections carefully — handlebars has no `else if`, so you nest +`{{^isArray}}{{^isNumeric}}...{{/}}{{/}}` chains to reach the string default. + +## Handlebars helper limitations (the recurring wall) + +The handlebars engine here registers only a **literal-string** helper set from +jknack handlebars.java. Confirmed by testing: + +- **Available:** `cut`, `join`, `lower`, `replace` (literal only — no regex!), + `capitalizeFirst`, `substring` (fixed index only), `eq`, `if`, `unless`, + `lookup`, and section/inverted sections (`{{#x}}` / `{{^x}}`). +- **NOT available:** `snakecase`, `underscore`, `split`, `substringAfter`, + `lowercase`, regex in `replace`. (`@first`/`@last` work inside `{{#vars}}` etc.) + +Consequences: + +- **You cannot snake_case in-template.** The CLI's command noun is + `ToSnakeCase(classname)` (e.g. `JobTemplates` → `job_templates`), and `lower` + alone gives `jobtemplates` (wrong — drops underscores). `ToSnakeCase` is a + **Go runtime helper** (`helpers.ToSnakeCase`), not a template helper. +- **You cannot split a string.** The CLI subcommand is "operationId after the + first `/`, slashes→`_`" (`comment/mark/read` → `mark_read`). Templates can't do + this. See `api.handlebars` line ~32: the generator emits *Go source* that does + `strings.Split(...)[1:]` **at CLI runtime**, with the comment "this weird + approach is due to mustache template limitations". That is the same wall you + will hit — the generator never produces these strings in the template, it + produces code that produces them. + +### Working around dashed keys + +Vendor extensions have dashes (`x-cli-command`), which break dotted paths. Access +them with bracket syntax or `lookup`: + +- `{{vendorExtensions.[x-cli-command]}}` +- `{{lookup vendorExtensions "x-cli-command"}}` + +Same for built-in dashed vars: use `{{@first}}`/`{{@last}}` (these work), not +`{{[-last]}}` (unreliable here). + +### HTML escaping + +`{{example}}` HTML-escapes (`"` → `"`). Use **triple-stache `{{{example}}}`** +for any value going into JSON or shell. + +## Pattern: generating a per-client examples/data file + +Used for `examples/cli.yaml` (see `cli/cli_examples.handlebars`). To emit a single +data file that iterates *all* operations across *all* tags: + +1. Write a template that iterates + `{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}...`. +2. Register it as a supporting file via a dedicated generator config's `files:` + key (`openapi-generator/cli_examples_lang.yaml`): + ```yaml + files: + cli_examples.handlebars: + destinationFilename: ../../examples/cli.yaml # relative to outputDir + templateType: SupportingFiles + ``` + `destinationFilename` is relative to the generator's `-o` outputDir. The + `examples` Makefile target uses `-o tmp/cli-examples`, so `../../examples/cli.yaml` + lands at repo root. +3. The generator writes **one file per template invocation** — no per-operation + output. Emit one combined file keyed by **`operationIdOriginal`** (slash form, + e.g. `screenshot/show`), which matches the compiled bundle's `operationId` + (the bundle keeps the slash form, not the PascalCase `nickname`). + +### Getting generated samples into the compiled bundle + +Path files carry only the hand-written Curl entry in `x-code-samples`; the CLI +sample is **not** in the source files. `scripts/inject-cli-examples.js` runs after +bundling, walks the compiled JSON/YAML, and appends each operation's CLI sample +from `examples/cli.yaml`, matched on `operationId`. A missing example is a no-op +(no CLI sample for that op), never an error. + +Build wiring: + +- `make bundle` (Node only): bundle JSON+YAML → inject the **committed** + `examples/cli.yaml` into both. No Java/openapi-generator, so the `lint` and + `compare-output` CI jobs (Node only) work. `compare-output` reproduces + `doc/compiled.json` by running the same inject step, so it must stay in sync with + `make bundle`. +- `make examples` (needs Java): regenerates `examples/cli.yaml` from + `tmp/compiled.yaml`. Invoked by `make cli` (which then re-runs `make bundle` to + inject the refreshed examples), and runnable standalone after param/x-cli-command + changes. Kept out of `bundle` precisely so `bundle`/`lint` stay Node-only. + +The generator ignores `x-code-samples`, so injected samples in `tmp/compiled.yaml` +do not affect a subsequent `make examples`. + +## When the template genuinely can't compute something + +If you need a final string the template can't build (snake_case, split, etc.), +**supply it as data**, not via derivation. For CLI we added +`x-cli-command: ` to each path file, computed once by a script +(noun = `ToSnakeCase(classname)`, looked up from the real generated CLI client +filenames in `clients/cli/cmd/api_.go`, which are ground truth). The +template then just emits `phrase {{{vendorExtensions.[x-cli-command]}}}`. + +Do NOT try to change `operationId` to make derivation easier: `operationId` → +`nickname` → the public method name in **every** client SDK (`ScreenshotCreate`, +`CommentMarkRead`). Changing it is a breaking change across all 7 libraries. + +## Debugging technique + +To inspect what the generator actually exposes on the model, drop a throwaway +template and register it as a supporting file pointed at a scratch dir: + +```yaml +# scratch config +inputSpec: tmp/compiled.yaml +generatorName: go +outputDir: /tmp/scratch_out +templateDir: openapi-generator/templates/cli +files: + _debug.handlebars: + destinationFilename: debug.txt + templateType: SupportingFiles +``` + +```handlebars +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}{{#if (eq operationIdOriginal "screenshot/create")}} +{{#allParams}}{{baseName}}: isPathParam={{isPathParam}} isBinary={{isBinary}} example={{example}} +{{/allParams}}{{/if}}{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} +``` + +Run `openapi-generator-cli generate -c .yaml -e handlebars` and read the +output. Watch the logs for `Unregistered helper name ''` — that tells you a +helper (or a dotted path it misparsed as a helper) doesn't exist. + +Useful fields seen on params/vars: `baseName` (original snake_case spec name), +`paramName` (camelCase), `dataType`, `required`, `isPathParam`, `isQueryParam`, +`isBodyParam`, `isFile`, `isBinary`, `isString/isArray/isNumeric/isBoolean/isMap`, +`example`, `vendorExtensions`. On the operation: `operationId` (PascalCase), +`operationIdOriginal` (slash form), `classname`, `nickname`, `bodyParam.vars`. diff --git a/openapi-generator/templates/cli/cli_examples.handlebars b/openapi-generator/templates/cli/cli_examples.handlebars new file mode 100644 index 00000000..d7294d54 --- /dev/null +++ b/openapi-generator/templates/cli/cli_examples.handlebars @@ -0,0 +1,8 @@ +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}{{operationIdOriginal}}: + lang: CLI v2 + source: |- + phrase {{{vendorExtensions.[x-cli-command]}}}{{#allParams}}{{^isBodyParam}}{{#unless (eq baseName "X-PhraseApp-OTP")}} \ + --{{lower (replace baseName "-" "_")}} {{#isBinary}}<{{lower (replace baseName "-" "_")}}>{{/isBinary}}{{^isBinary}}{{#isPathParam}}<{{lower (replace baseName "-" "_")}}>{{/isPathParam}}{{^isPathParam}}{{#isArray}}'{{{example}}}'{{/isArray}}{{^isArray}}{{#isMap}}'{ }'{{/isMap}}{{^isMap}}{{#isBoolean}}{{{example}}}{{/isBoolean}}{{^isBoolean}}{{#isNumeric}}{{{example}}}{{/isNumeric}}{{^isNumeric}}{{#example}}"{{{replace . '"' '\"'}}}"{{/example}}{{^example}}<{{lower (replace baseName "-" "_")}}>{{/example}}{{/isNumeric}}{{/isBoolean}}{{/isMap}}{{/isArray}}{{/isPathParam}}{{/isBinary}}{{/unless}}{{/isBodyParam}}{{/allParams}}{{#bodyParam}} \ + --data '{ {{#vars}}{{^@first}}, {{/@first}}"{{baseName}}": {{#isBinary}}"<{{baseName}}>"{{/isBinary}}{{^isBinary}}{{#isArray}}{{{example}}}{{/isArray}}{{#isNumeric}}{{{example}}}{{/isNumeric}}{{#isBoolean}}{{{example}}}{{/isBoolean}}{{#isMap}}{{{example}}}{{/isMap}}{{#isFreeFormObject}}{{{example}}}{{/isFreeFormObject}}{{^isArray}}{{^isNumeric}}{{^isBoolean}}{{^isMap}}{{^isFreeFormObject}}"{{{replace example '"' '\"'}}}"{{/isFreeFormObject}}{{/isMap}}{{/isBoolean}}{{/isNumeric}}{{/isArray}}{{/isBinary}}{{/vars}} }'{{/bodyParam}} \ + --access_token +{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} diff --git a/parameters.yaml b/parameters.yaml index c9cf0eed..96ad185e 100644 --- a/parameters.yaml +++ b/parameters.yaml @@ -15,6 +15,7 @@ If-Modified-Since: schema: type: string style: simple + example: '2024-03-15T09:00:00Z' If-None-Match: description: 'ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)' explode: false @@ -24,6 +25,7 @@ If-None-Match: schema: type: string style: simple + example: 'W/"123456789"' account_id: in: path name: account_id diff --git a/paths/accounts/index.yaml b/paths/accounts/index.yaml index a741edeb..0bb0de5b 100644 --- a/paths/accounts/index.yaml +++ b/paths/accounts/index.yaml @@ -44,8 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase accounts list \ - --access_token +x-cli-command: accounts list x-cli-version: '2.5' diff --git a/paths/accounts/locales.yaml b/paths/accounts/locales.yaml index b5366fce..2e290ec5 100644 --- a/paths/accounts/locales.yaml +++ b/paths/accounts/locales.yaml @@ -45,9 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:id/locales" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase accounts locales \ - --id \ - --access_token +x-cli-command: locales locales x-cli-version: '2.5' diff --git a/paths/accounts/show.yaml b/paths/accounts/show.yaml index 2599fcb8..0a43f4ef 100644 --- a/paths/accounts/show.yaml +++ b/paths/accounts/show.yaml @@ -37,9 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase accounts show \ - --id \ - --access_token +x-cli-command: accounts show x-cli-version: '2.5' diff --git a/paths/authorizations/create.yaml b/paths/authorizations/create.yaml index 2f471c0c..a479b76b 100644 --- a/paths/authorizations/create.yaml +++ b/paths/authorizations/create.yaml @@ -41,10 +41,6 @@ x-code-samples: -X POST \ -d '{"note":"My Deploy Script","scopes":["read","write"],"expires_at":"2015-03-30T09:52:53Z"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase authorizations create \ - --data '{"note": "My Deploy Script", "scopes": "read,write", "expires_at": "2015-03-30T09:52:53Z"}' requestBody: required: true content: @@ -77,4 +73,5 @@ requestBody: type: string format: date-time example: '2015-03-30T09:52:53Z' +x-cli-command: authorizations create x-cli-version: '2.5' diff --git a/paths/authorizations/destroy.yaml b/paths/authorizations/destroy.yaml index b2682593..1ea251ec 100644 --- a/paths/authorizations/destroy.yaml +++ b/paths/authorizations/destroy.yaml @@ -29,8 +29,5 @@ x-code-samples: curl "https://api.phrase.com/v2/authorizations/:id" \ -u USERNAME \ -X DELETE -- lang: CLI v2 - source: |- - phrase authorizations delete \ - --id +x-cli-command: authorizations delete x-cli-version: '2.5' diff --git a/paths/authorizations/index.yaml b/paths/authorizations/index.yaml index e4d7092a..01afd3e1 100644 --- a/paths/authorizations/index.yaml +++ b/paths/authorizations/index.yaml @@ -44,6 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/authorizations" \ -u USERNAME -- lang: CLI v2 - source: phrase authorizations list +x-cli-command: authorizations list x-cli-version: '2.5' diff --git a/paths/authorizations/show.yaml b/paths/authorizations/show.yaml index 73a27a99..6ab07b4f 100644 --- a/paths/authorizations/show.yaml +++ b/paths/authorizations/show.yaml @@ -37,8 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/authorizations/:id" \ -u USERNAME -- lang: CLI v2 - source: |- - phrase authorizations show \ - --id +x-cli-command: authorizations show x-cli-version: '2.5' diff --git a/paths/authorizations/update.yaml b/paths/authorizations/update.yaml index 8e859b5b..417d2fff 100644 --- a/paths/authorizations/update.yaml +++ b/paths/authorizations/update.yaml @@ -42,11 +42,6 @@ x-code-samples: -X PATCH \ -d '{"note":"My Deploy Script","scopes":["read","write"],"expires_at":"2015-03-30T09:52:53Z"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase authorizations update \ - --id \ - --data '{"note": "My Deploy Script", "scopes": "read,write", "expires_at": "2015-03-30T09:52:53Z"}' requestBody: required: true content: @@ -77,4 +72,5 @@ requestBody: type: string format: date-time example: '2015-03-30T09:52:53Z' +x-cli-command: authorizations update x-cli-version: '2.5' diff --git a/paths/automations/activate.yaml b/paths/automations/activate.yaml index da942437..85728c58 100644 --- a/paths/automations/activate.yaml +++ b/paths/automations/activate.yaml @@ -45,9 +45,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase automations activate \ - --account_id \ - --id \ - --access_token +x-cli-command: automations activate diff --git a/paths/automations/create.yaml b/paths/automations/create.yaml index c1619eac..293ec062 100644 --- a/paths/automations/create.yaml +++ b/paths/automations/create.yaml @@ -113,9 +113,4 @@ x-code-samples: -X POST \ -d '{"name":"Schedule Automation - Hourly","trigger":"schedule","project_ids":["1"],"job_template_id":"2","status_filters":["untranslated"],"tag_ids":["3","4"],"cron_schedule":"00 13 * * 1,2","time_zone":"GMT"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase automations create \ - --account_id \ - --data '{"name":"Schedule Automation - Hourly","trigger":"schedule","project_ids":["1"],"job_template_id":"2","status_filters":["untranslated"],"tag_ids":["3","4"],"cron_schedule":"00 13 * * 1,2","time_zone":"GMT"}' \ - --access_token +x-cli-command: automations create diff --git a/paths/automations/deactivate.yaml b/paths/automations/deactivate.yaml index 4398e722..1e4de6d1 100644 --- a/paths/automations/deactivate.yaml +++ b/paths/automations/deactivate.yaml @@ -45,9 +45,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase automations deactivate \ - --account_id \ - --id \ - --access_token +x-cli-command: automations deactivate diff --git a/paths/automations/destroy.yaml b/paths/automations/destroy.yaml index 17533dd4..36b39632 100644 --- a/paths/automations/destroy.yaml +++ b/paths/automations/destroy.yaml @@ -32,9 +32,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase automations delete \ - --account_id \ - --id \ - --access_token +x-cli-command: automations delete diff --git a/paths/automations/index.yaml b/paths/automations/index.yaml index ffafbfee..01a0988b 100644 --- a/paths/automations/index.yaml +++ b/paths/automations/index.yaml @@ -48,10 +48,4 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/automations?page=1&per_page=10" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase automations list \ - --account_id \ - --page 1 \ - --per_page 10 \ - --access_token +x-cli-command: automations list diff --git a/paths/automations/show.yaml b/paths/automations/show.yaml index 86b0f856..79535754 100644 --- a/paths/automations/show.yaml +++ b/paths/automations/show.yaml @@ -41,9 +41,4 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/automations/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase automations show \ - --account_id \ - --id \ - --access_token +x-cli-command: automations show diff --git a/paths/automations/trigger.yaml b/paths/automations/trigger.yaml index 1796a644..f61c83f2 100644 --- a/paths/automations/trigger.yaml +++ b/paths/automations/trigger.yaml @@ -32,9 +32,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase automations trigger \ - --account_id \ - --id \ - --access_token +x-cli-command: automations trigger diff --git a/paths/automations/update.yaml b/paths/automations/update.yaml index c3eaa830..6892b18f 100644 --- a/paths/automations/update.yaml +++ b/paths/automations/update.yaml @@ -111,10 +111,4 @@ x-code-samples: -X PATCH \ -d '{"name":"Schedule Automation - Weekly","tag_ids":["5","6"],time_zone:"UTC"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase automations update \ - --account_id \ - --id \ - --data '{"name":"Schedule Automation - Weekly","tag_ids":["5","6"],time_zone:"UTC"}' \ - --access_token +x-cli-command: automations update diff --git a/paths/blacklisted_keys/create.yaml b/paths/blacklisted_keys/create.yaml index d529f808..4c160330 100644 --- a/paths/blacklisted_keys/create.yaml +++ b/paths/blacklisted_keys/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"name":"date.formats.*"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase blacklisted_keys create \ - --project_id \ - --data '{"name":"'date.formats.*'"}' \ - --access_token requestBody: required: true content: @@ -62,4 +56,5 @@ requestBody: description: Blocked key name type: string example: date.formats.* +x-cli-command: blacklisted_keys create x-cli-version: '2.5' diff --git a/paths/blacklisted_keys/destroy.yaml b/paths/blacklisted_keys/destroy.yaml index f247db8b..5b152832 100644 --- a/paths/blacklisted_keys/destroy.yaml +++ b/paths/blacklisted_keys/destroy.yaml @@ -30,10 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/blacklisted_keys/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase blacklisted_keys delete \ - --project_id \ - --id \ - --access_token +x-cli-command: blacklisted_keys delete x-cli-version: '2.5' diff --git a/paths/blacklisted_keys/index.yaml b/paths/blacklisted_keys/index.yaml index a2a4c843..a500df41 100644 --- a/paths/blacklisted_keys/index.yaml +++ b/paths/blacklisted_keys/index.yaml @@ -51,9 +51,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/blacklisted_keys" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase blacklisted_keys list \ - --project_id \ - --access_token +x-cli-command: blacklisted_keys list x-cli-version: '2.5' diff --git a/paths/blacklisted_keys/show.yaml b/paths/blacklisted_keys/show.yaml index 36ac821e..c92a9368 100644 --- a/paths/blacklisted_keys/show.yaml +++ b/paths/blacklisted_keys/show.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/blacklisted_keys/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase blacklisted_keys show \ - --project_id \ - --id \ - --access_token +x-cli-command: blacklisted_keys show x-cli-version: '2.5' diff --git a/paths/blacklisted_keys/update.yaml b/paths/blacklisted_keys/update.yaml index 32d5a586..77237dea 100644 --- a/paths/blacklisted_keys/update.yaml +++ b/paths/blacklisted_keys/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"name":"date.formats.*"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase blacklisted_keys update \ - --project_id \ - --id \ - --data '{"name":"'date.formats.*'"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: Blocked key name type: string example: date.formats.* +x-cli-command: blacklisted_keys update x-cli-version: '2.5' diff --git a/paths/branches/compare.yaml b/paths/branches/compare.yaml index 13a77491..864f1edb 100644 --- a/paths/branches/compare.yaml +++ b/paths/branches/compare.yaml @@ -45,11 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/branches/:name/compare?name=my-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase branches compare \ - --project_id \ - --name \ - --name my-branch \ - --access_token +x-cli-command: branches compare x-cli-version: '2.5' diff --git a/paths/branches/create.yaml b/paths/branches/create.yaml index 95074874..165a1208 100644 --- a/paths/branches/create.yaml +++ b/paths/branches/create.yaml @@ -49,12 +49,6 @@ x-code-samples: -X POST \ -d '{"name":"my-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase branches create \ - --project_id \ - --data '{"name":"my-branch"}' \ - --access_token requestBody: required: true content: @@ -73,4 +67,5 @@ requestBody: description: Name of an existing branch to use as the base for the new branch. type: string example: parent-branch +x-cli-command: branches create x-cli-version: '2.5' diff --git a/paths/branches/create_comparison.yaml b/paths/branches/create_comparison.yaml index e38d6aa1..e587be79 100644 --- a/paths/branches/create_comparison.yaml +++ b/paths/branches/create_comparison.yaml @@ -29,12 +29,6 @@ x-code-samples: -X POST \ -d '{"direction":"merge"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase branches create_comparison \ - --project_id \ - --name \ - --access_token requestBody: required: true content: @@ -48,3 +42,5 @@ requestBody: type: string example: merge default: merge + +x-cli-command: branches comparison_create diff --git a/paths/branches/destroy.yaml b/paths/branches/destroy.yaml index a2d165be..e4ec0352 100644 --- a/paths/branches/destroy.yaml +++ b/paths/branches/destroy.yaml @@ -38,10 +38,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/branches/:name" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase branches delete \ - --project_id \ - --name \ - --access_token +x-cli-command: branches delete x-cli-version: '2.5' diff --git a/paths/branches/index.yaml b/paths/branches/index.yaml index 08836350..02e274ad 100644 --- a/paths/branches/index.yaml +++ b/paths/branches/index.yaml @@ -48,9 +48,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/branches" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase branches list \ - --project_id \ - --access_token +x-cli-command: branches list x-cli-version: '2.5' diff --git a/paths/branches/merge.yaml b/paths/branches/merge.yaml index a09b5be4..82b1b11b 100644 --- a/paths/branches/merge.yaml +++ b/paths/branches/merge.yaml @@ -51,13 +51,6 @@ x-code-samples: -X PATCH \ -d '{"strategy":"use_main"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase branches merge \ - --project_id \ - --name \ - --data '{"strategy":"use_main"}' \ - --access_token requestBody: required: true content: @@ -74,3 +67,5 @@ requestBody: - use_main - use_branch example: use_main + +x-cli-command: branches merge diff --git a/paths/branches/show.yaml b/paths/branches/show.yaml index 06dd80be..0ce4004e 100644 --- a/paths/branches/show.yaml +++ b/paths/branches/show.yaml @@ -41,10 +41,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/branches/:name" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase branches show \ - --project_id \ - --name \ - --access_token +x-cli-command: branches show x-cli-version: '2.5' diff --git a/paths/branches/sync.yaml b/paths/branches/sync.yaml index 9317f0bb..e9611618 100644 --- a/paths/branches/sync.yaml +++ b/paths/branches/sync.yaml @@ -46,13 +46,6 @@ x-code-samples: -X PATCH \ -d '{"strategy":"use_main"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase branches sync \ - --project_id \ - --name \ - --data '{"strategy":"use_main"}' \ - --access_token requestBody: required: true content: @@ -69,3 +62,5 @@ requestBody: - use_main - use_branch example: use_main + +x-cli-command: branches sync diff --git a/paths/branches/update.yaml b/paths/branches/update.yaml index 5e4dd58c..6607674a 100644 --- a/paths/branches/update.yaml +++ b/paths/branches/update.yaml @@ -46,13 +46,6 @@ x-code-samples: -X PATCH \ -d '{"name":"my-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase branches update \ - --project_id \ - --name \ - --data '{"name":"my-branch"}' \ - --access_token requestBody: required: true content: @@ -65,4 +58,5 @@ requestBody: description: Name of the branch type: string example: my-branch +x-cli-command: branches update x-cli-version: '2.5' diff --git a/paths/comment_reactions/create.yaml b/paths/comment_reactions/create.yaml index 8589d711..afec1df5 100644 --- a/paths/comment_reactions/create.yaml +++ b/paths/comment_reactions/create.yaml @@ -51,12 +51,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch", "emoji": "👍"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase reactions create \ - --project_id \ - --key_id \ - --comment_id \ - --data '{"branch":"my-feature-branch", "emoji": "👍"]}' \ - --access_token +x-cli-command: comment_reactions create x-cli-version: '2.9' diff --git a/paths/comment_reactions/destroy.yaml b/paths/comment_reactions/destroy.yaml index bc6fa80f..42e5da00 100644 --- a/paths/comment_reactions/destroy.yaml +++ b/paths/comment_reactions/destroy.yaml @@ -35,13 +35,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase reactions delete \ - --project_id \ - --key_id \ - --comment_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: comment_reactions delete x-cli-version: '2.9' diff --git a/paths/comment_reactions/index.yaml b/paths/comment_reactions/index.yaml index 9faf33b7..30a744b5 100644 --- a/paths/comment_reactions/index.yaml +++ b/paths/comment_reactions/index.yaml @@ -53,12 +53,5 @@ x-code-samples: -X GET \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase reactions list \ - --project_id \ - --key_id \ - --comment_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: comment_reactions list x-cli-version: '2.9' diff --git a/paths/comment_reactions/show.yaml b/paths/comment_reactions/show.yaml index 0a7ab204..e48d2418 100644 --- a/paths/comment_reactions/show.yaml +++ b/paths/comment_reactions/show.yaml @@ -46,13 +46,5 @@ x-code-samples: -X GET \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase reactions show \ - --project_id \ - --key_id \ - --comment_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: comment_reactions show x-cli-version: '2.9' diff --git a/paths/comment_replies/create.yaml b/paths/comment_replies/create.yaml index ff54a5c9..2952d10b 100644 --- a/paths/comment_replies/create.yaml +++ b/paths/comment_replies/create.yaml @@ -57,12 +57,5 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch", "message":"Some message..."}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase replies create \ - --project_id \ - --key_id \ - --comment_id \ - --data '{"branch":"my-feature-branch", "message": "Some message..."]}' \ - --access_token +x-cli-command: comment_replies create x-cli-version: '2.10' diff --git a/paths/comment_replies/destroy.yaml b/paths/comment_replies/destroy.yaml index 764e0264..68a2d08e 100644 --- a/paths/comment_replies/destroy.yaml +++ b/paths/comment_replies/destroy.yaml @@ -35,13 +35,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase replies delete \ - --project_id \ - --key_id \ - --comment_id \ - --id \ - --data '{"branch":"my-feature-branch"]}' \ - --access_token +x-cli-command: comment_replies delete x-cli-version: '2.10' diff --git a/paths/comment_replies/index.yaml b/paths/comment_replies/index.yaml index 86fd706b..7efe0511 100644 --- a/paths/comment_replies/index.yaml +++ b/paths/comment_replies/index.yaml @@ -71,15 +71,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X GET \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase replies list \ - --project_id \ - --key_id \ - --comment_id \ - --branch "my-feature-branch" \ - --filters unread \ - --order desc \ - --query "Some comment content" \ - --access_token +x-cli-command: comment_replies list x-cli-version: '2.10' diff --git a/paths/comment_replies/mark_as_read.yaml b/paths/comment_replies/mark_as_read.yaml index 8ace77bc..cda032a7 100644 --- a/paths/comment_replies/mark_as_read.yaml +++ b/paths/comment_replies/mark_as_read.yaml @@ -35,13 +35,5 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase replies mark_as_read \ - --project_id \ - --key_id \ - --comment_id \ - --id \ - --data '{"branch":"my-feature-branch"]}' \ - --access_token +x-cli-command: comment_replies mark_as_read x-cli-version: '2.10' diff --git a/paths/comment_replies/mark_as_unread.yaml b/paths/comment_replies/mark_as_unread.yaml index f27a73fb..7697f653 100644 --- a/paths/comment_replies/mark_as_unread.yaml +++ b/paths/comment_replies/mark_as_unread.yaml @@ -35,13 +35,5 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase replies mark_as_unread \ - --project_id \ - --key_id \ - --comment_id \ - --id \ - --data '{"branch":"my-feature-branch"]}' \ - --access_token +x-cli-command: comment_replies mark_as_unread x-cli-version: '2.10' diff --git a/paths/comment_replies/show.yaml b/paths/comment_replies/show.yaml index 7383a5b2..998f15d8 100644 --- a/paths/comment_replies/show.yaml +++ b/paths/comment_replies/show.yaml @@ -46,13 +46,5 @@ x-code-samples: -X GET \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase replies show \ - --project_id \ - --key_id \ - --comment_id \ - --id \ - --data '{"branch":"my-feature-branch"]}' \ - --access_token +x-cli-command: comment_replies show x-cli-version: '2.10' diff --git a/paths/comments/check_if_read.yaml b/paths/comments/check_if_read.yaml index 9877deae..26d96c49 100644 --- a/paths/comments/check_if_read.yaml +++ b/paths/comments/check_if_read.yaml @@ -34,12 +34,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:id/read?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase comments mark \ - --project_id \ - --key_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: comments mark_check x-cli-version: '2.5' diff --git a/paths/comments/create.yaml b/paths/comments/create.yaml index 9a33644d..be4a0716 100644 --- a/paths/comments/create.yaml +++ b/paths/comments/create.yaml @@ -43,13 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch", "message":"Some message...", "locale_ids": ["someId"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase comments create \ - --project_id \ - --key_id \ - --data '{"branch":"my-feature-branch", "message": "Some message...", "locale_ids": ["someId"]}' \ - --access_token requestBody: required: true content: @@ -76,4 +69,5 @@ requestBody: example: - someId - someOtherId +x-cli-command: comments create x-cli-version: '2.5' diff --git a/paths/comments/destroy.yaml b/paths/comments/destroy.yaml index c7b720e3..caff317f 100644 --- a/paths/comments/destroy.yaml +++ b/paths/comments/destroy.yaml @@ -39,12 +39,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase comments delete \ - --project_id \ - --key_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: comments delete x-cli-version: '2.5' diff --git a/paths/comments/index.yaml b/paths/comments/index.yaml index aa2240e7..d0c6ba61 100644 --- a/paths/comments/index.yaml +++ b/paths/comments/index.yaml @@ -89,15 +89,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X GET \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase comments list \ - --project_id \ - --key_id \ - --branch "my-feature-branch" \ - --filters unread \ - --order desc \ - --query "Some comment content" \ - --locale_ids someId \ - --access_token +x-cli-command: comments list x-cli-version: '2.5' diff --git a/paths/comments/mark_as_read.yaml b/paths/comments/mark_as_read.yaml index acbc224f..65a6558c 100644 --- a/paths/comments/mark_as_read.yaml +++ b/paths/comments/mark_as_read.yaml @@ -33,14 +33,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase comments mark \ - --project_id \ - --key_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -53,4 +45,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: comments mark_read x-cli-version: '2.5' diff --git a/paths/comments/show.yaml b/paths/comments/show.yaml index 2edf601e..9af23bf2 100644 --- a/paths/comments/show.yaml +++ b/paths/comments/show.yaml @@ -45,12 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase comments show \ - --project_id \ - --key_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: comments show x-cli-version: '2.5' diff --git a/paths/comments/unmark_as_read.yaml b/paths/comments/unmark_as_read.yaml index a65c1713..a42ec859 100644 --- a/paths/comments/unmark_as_read.yaml +++ b/paths/comments/unmark_as_read.yaml @@ -39,12 +39,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase comments mark \ - --project_id \ - --key_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: comments mark_unread x-cli-version: '2.5' diff --git a/paths/comments/update.yaml b/paths/comments/update.yaml index f798a4b0..a80a1d42 100644 --- a/paths/comments/update.yaml +++ b/paths/comments/update.yaml @@ -44,14 +44,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","message":"Some message..."}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase comments update \ - --project_id \ - --key_id \ - --id \ - --data '{"branch":"my-feature-branch", "message": "Some message..."}' \ - --access_token requestBody: required: true content: @@ -68,4 +60,5 @@ requestBody: description: Comment message type: string example: Some message... +x-cli-command: comments update x-cli-version: '2.5' diff --git a/paths/custom_metadata_properties/create.yaml b/paths/custom_metadata_properties/create.yaml index a57a60b2..b28df3da 100644 --- a/paths/custom_metadata_properties/create.yaml +++ b/paths/custom_metadata_properties/create.yaml @@ -77,10 +77,5 @@ x-code-samples: -X POST \ -d '{"name":"Fruit","data_type":"multi_select","description":"A healthy snack for all ages","project_ids":["1","2","3"],"value_options":["apple","banana","coconut"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase custom_metadata_properties create \ - --account_id \ - --data '{"name":"Fruit","data_type":"multi_select","description":"A healthy snack for all ages","project_ids":["1","2","3"],"value_options":["apple","banana","coconut"]}' \ - --access_token +x-cli-command: custom_metadata create x-cli-version: '2.9' diff --git a/paths/custom_metadata_properties/destroy.yaml b/paths/custom_metadata_properties/destroy.yaml index cae292b2..81a735ed 100644 --- a/paths/custom_metadata_properties/destroy.yaml +++ b/paths/custom_metadata_properties/destroy.yaml @@ -27,10 +27,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase custom_metadata_properties delete \ - --account_id \ - --id \ - --access_token +x-cli-command: custom_metadata delete x-cli-version: '2.9' diff --git a/paths/custom_metadata_properties/index.yaml b/paths/custom_metadata_properties/index.yaml index 973029c6..959ec203 100644 --- a/paths/custom_metadata_properties/index.yaml +++ b/paths/custom_metadata_properties/index.yaml @@ -68,15 +68,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/custom_metadata/properties?data_type=boolean&project_id=1&page=1&per_page=10&sort=created_at&order=desc" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase custom_metadata_properties list \ - --account_id \ - --data_type boolean \ - --project_id 1 \ - --page 1 \ - --per_page 10 \ - --sort created_at \ - --order desc \ - --access_token +x-cli-command: custom_metadata list x-cli-version: '2.9' diff --git a/paths/custom_metadata_properties/show.yaml b/paths/custom_metadata_properties/show.yaml index d899d8d0..c6addeb3 100644 --- a/paths/custom_metadata_properties/show.yaml +++ b/paths/custom_metadata_properties/show.yaml @@ -33,10 +33,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/custom_metadata/properties/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase custom_metadata_properties show \ - --account_id \ - --id \ - --access_token +x-cli-command: custom_metadata show x-cli-version: '2.9' diff --git a/paths/custom_metadata_properties/update.yaml b/paths/custom_metadata_properties/update.yaml index 20de8225..0e3017e5 100644 --- a/paths/custom_metadata_properties/update.yaml +++ b/paths/custom_metadata_properties/update.yaml @@ -70,11 +70,5 @@ x-code-samples: -X PATCH \ -d '{"name":"Fruit","description":"A healthy snack for all ages","project_ids":["1","2","3"],"value_options":["apple","banana","coconut"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase custom_metadata_properties update \ - --account_id \ - --id \ - --data '{"name":"Fruit","description":"A healthy snack for all ages","project_ids":["1","2","3"],"value_options":["apple","banana","coconut"]}' \ - --access_token +x-cli-command: custom_metadata update x-cli-version: '2.9' diff --git a/paths/distributions/create.yaml b/paths/distributions/create.yaml index 60e2c8c5..1153316b 100644 --- a/paths/distributions/create.yaml +++ b/paths/distributions/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"name":"My Android Distribution","project_id":"abcd1234abcd1234abcd1234","platforms":["android","ios"],"locale_ids":["fff565db236400772368235db2c6117e,abcd1234cdef1234abcd1234cdef1234"],"format_options":"{xml:{enclose_in_cdata:'1'}}","fallback_to_non_regional_locale":true,"fallback_to_default_locale":true,"use_last_reviewed_version":true}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase distributions create \ - --account_id \ - --data '{"name": "My Android Distribution", "project_id":"abcd1234abcd1234abcd1234", "platforms": "android,ios", "locale_ids":["fff565db236400772368235db2c6117e,abcd1234cdef1234abcd1234cdef1234"], "format_options": "{xml:{enclose_in_cdata:'1'}}", "fallback_to_non_regional_locale":true, "fallback_to_default_locale":true, "use_last_reviewed_version":true}' \ - --access_token requestBody: required: true content: @@ -96,7 +90,8 @@ requestBody: type: object additionalProperties: type: string - example: "{xml:{enclose_in_cdata:'1'}}" + example: + enclose_in_cdata: '1' fallback_locales_enabled: description: Use fallback locale if there is no translation in the current locale. type: boolean @@ -113,4 +108,5 @@ requestBody: description: Use last reviewed instead of latest translation in a project type: boolean example: true +x-cli-command: distributions create x-cli-version: '2.5' diff --git a/paths/distributions/destroy.yaml b/paths/distributions/destroy.yaml index eea00657..1483a970 100644 --- a/paths/distributions/destroy.yaml +++ b/paths/distributions/destroy.yaml @@ -30,10 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase distributions delete \ - --account_id \ - --id \ - --access_token +x-cli-command: distributions delete x-cli-version: '2.5' diff --git a/paths/distributions/index.yaml b/paths/distributions/index.yaml index 08603d00..9d46b74d 100644 --- a/paths/distributions/index.yaml +++ b/paths/distributions/index.yaml @@ -45,9 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase distributions list \ - --account_id \ - --access_token +x-cli-command: distributions list x-cli-version: '2.5' diff --git a/paths/distributions/show.yaml b/paths/distributions/show.yaml index 6040129f..fed1d869 100644 --- a/paths/distributions/show.yaml +++ b/paths/distributions/show.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase distributions show \ - --account_id \ - --id \ - --access_token +x-cli-command: distributions show x-cli-version: '2.5' diff --git a/paths/distributions/update.yaml b/paths/distributions/update.yaml index a533440d..9b34942a 100644 --- a/paths/distributions/update.yaml +++ b/paths/distributions/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"name":"My Android Distribution","project_id":"abcd1234abcd1234abcd1234","platforms":["android","ios"],"locale_ids":["fff565db236400772368235db2c6117e,abcd1234cdef1234abcd1234cdef1234"],"format_options":"{xml:{enclose_in_cdata:'1'}}","fallback_to_non_regional_locale":true,"fallback_to_default_locale":true,"use_last_reviewed_version":true}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase distributions update \ - --account_id \ - --id \ - --data '{"name": "My Android Distribution", "project_id":"abcd1234abcd1234abcd1234", "platforms": "android,ios", "locale_ids": "fff565db236400772368235db2c6117e,abcd1234cdef1234abcd1234cdef1234", "format_options": "{xml:{enclose_in_cdata:'1'}}", "fallback_to_non_regional_locale":true, "fallback_to_default_locale":true, "use_last_reviewed_version":true}' \ - --access_token requestBody: required: true content: @@ -88,7 +81,8 @@ requestBody: type: object additionalProperties: type: string - example: "{xml:{enclose_in_cdata:'1'}}" + example: + enclose_in_cdata: '1' fallback_locales_enabled: description: Use fallback locale if there is no translation in the current locale. type: boolean @@ -105,4 +99,5 @@ requestBody: description: Use last reviewed instead of latest translation in a project type: boolean example: true +x-cli-command: distributions update x-cli-version: '2.5' diff --git a/paths/documents/destroy.yaml b/paths/documents/destroy.yaml index bcae3e6e..ee16d8c5 100644 --- a/paths/documents/destroy.yaml +++ b/paths/documents/destroy.yaml @@ -31,10 +31,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase documents delete \ - --project_id \ - --id \ - --access_token +x-cli-command: documents delete x-cli-version: '2.5' diff --git a/paths/documents/index.yaml b/paths/documents/index.yaml index 718672f5..ef58ca3f 100644 --- a/paths/documents/index.yaml +++ b/paths/documents/index.yaml @@ -52,9 +52,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/documents?project_id=asdf" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase documents list \ - --project_id \ - --access_token +x-cli-command: documents list x-cli-version: '2.5' diff --git a/paths/figma_attachment_keys/create.yaml b/paths/figma_attachment_keys/create.yaml index b2d3e054..ed72a30f 100644 --- a/paths/figma_attachment_keys/create.yaml +++ b/paths/figma_attachment_keys/create.yaml @@ -33,12 +33,5 @@ x-code-samples: -F branch=my-feature-branch \ -F id=key_id \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase figma_attachment attach_to_key \ - --project_id \ - --figma_attachment_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: keys_figma_attachments attach_to_key x-cli-version: "2.13" diff --git a/paths/figma_attachment_keys/destroy.yaml b/paths/figma_attachment_keys/destroy.yaml index 98961b0b..d7534c91 100644 --- a/paths/figma_attachment_keys/destroy.yaml +++ b/paths/figma_attachment_keys/destroy.yaml @@ -32,12 +32,5 @@ x-code-samples: -X DELETE \ -F branch=my-feature-branch \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase figma_attachment detach_from_key \ - --project_id \ - --figma_attachment_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: keys_figma_attachments detach_from_key x-cli-version: "2.13" diff --git a/paths/figma_attachments/create.yaml b/paths/figma_attachments/create.yaml index 1e2ebc72..7645aeea 100644 --- a/paths/figma_attachments/create.yaml +++ b/paths/figma_attachments/create.yaml @@ -48,12 +48,6 @@ x-code-samples: -X POST \ -F branch=my-feature-branch \ -F url=https://figma.com/file/xxxxx/sample \ - - lang: CLI v2 - source: |- - phrase figma_attachment create \ - --project_id \ - --data '{"branch":"my-feature-branch", "url":"https://figma.com/file/xxxxx/sample"}' \ - --access_token requestBody: required: true content: @@ -72,4 +66,5 @@ requestBody: description: Figma file url type: string example: https://figma.com/file/xxxxx/sample +x-cli-command: figma_attachments create x-cli-version: "2.13" diff --git a/paths/figma_attachments/destroy.yaml b/paths/figma_attachments/destroy.yaml index d8e7d5b7..8abd8984 100644 --- a/paths/figma_attachments/destroy.yaml +++ b/paths/figma_attachments/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase figma_attachment delete \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: figma_attachments delete x-cli-version: "2.13" diff --git a/paths/figma_attachments/index.yaml b/paths/figma_attachments/index.yaml index 417beade..d2dff6cd 100644 --- a/paths/figma_attachments/index.yaml +++ b/paths/figma_attachments/index.yaml @@ -52,10 +52,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/figma_attachments?branch=my-feature-branch" \ -X GET \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase figma_attachments list \ - --project_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: figma_attachments list x-cli-version: "2.13" diff --git a/paths/figma_attachments/show.yaml b/paths/figma_attachments/show.yaml index c6918b10..4c67f8fe 100644 --- a/paths/figma_attachments/show.yaml +++ b/paths/figma_attachments/show.yaml @@ -45,11 +45,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/figma_attachments/:id?branch=my-feature-branch" \ -X GET \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase figma_attachment show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: figma_attachments show x-cli-version: "2.13" diff --git a/paths/figma_attachments/update.yaml b/paths/figma_attachments/update.yaml index 34d83121..dbea75b8 100644 --- a/paths/figma_attachments/update.yaml +++ b/paths/figma_attachments/update.yaml @@ -49,13 +49,6 @@ x-code-samples: -X PATCH \ -F branch=my-feature-branch \ -F url=https://figma.com/file/xxxxx/sample \ - - lang: CLI v2 - source: |- - phrase figma_attachment update \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch", "url":"https://figma.com/file/xxxxx/sample" }' \ - --access_token requestBody: required: true content: @@ -72,4 +65,5 @@ requestBody: description: Figma file url type: string example: https://figma.com/file/xxxxx/sample +x-cli-command: figma_attachments update x-cli-version: "2.13" diff --git a/paths/formats/index.yaml b/paths/formats/index.yaml index b8aa4a98..fb829edf 100644 --- a/paths/formats/index.yaml +++ b/paths/formats/index.yaml @@ -55,8 +55,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/formats" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase formats list \ - --access_token +x-cli-command: formats list x-cli-version: '2.5' diff --git a/paths/glossaries/create.yaml b/paths/glossaries/create.yaml index 3c8313d0..6d2e2f3f 100644 --- a/paths/glossaries/create.yaml +++ b/paths/glossaries/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"name":"My term base","project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase glossaries create \ - --account_id \ - --data '{"name":"My term base", "project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235"}' \ - --access_token requestBody: required: true content: @@ -74,4 +68,5 @@ requestBody: example: - abcd1234abcd1234abcd1234 - abcd1234abcd1234abcd1235 +x-cli-command: glossaries create x-cli-version: '2.5' diff --git a/paths/glossaries/destroy.yaml b/paths/glossaries/destroy.yaml index 09c96274..6c3b1d18 100644 --- a/paths/glossaries/destroy.yaml +++ b/paths/glossaries/destroy.yaml @@ -30,10 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase glossaries delete \ - --account_id \ - --id \ - --access_token +x-cli-command: glossaries delete x-cli-version: '2.5' diff --git a/paths/glossaries/index.yaml b/paths/glossaries/index.yaml index 08c237df..6c30c011 100644 --- a/paths/glossaries/index.yaml +++ b/paths/glossaries/index.yaml @@ -45,9 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/glossaries" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase glossaries list \ - --account_id \ - --access_token +x-cli-command: glossaries list x-cli-version: '2.5' diff --git a/paths/glossaries/show.yaml b/paths/glossaries/show.yaml index 6159c2f7..1f477c2e 100644 --- a/paths/glossaries/show.yaml +++ b/paths/glossaries/show.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase glossaries show \ - --account_id \ - --id \ - --access_token +x-cli-command: glossaries show x-cli-version: '2.5' diff --git a/paths/glossaries/update.yaml b/paths/glossaries/update.yaml index 3d52c0e1..3ad8c113 100644 --- a/paths/glossaries/update.yaml +++ b/paths/glossaries/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"name":"My glossary","project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase glossaries update \ - --account_id \ - --id \ - --data '{"name": "My glossary", "project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235"}' \ - --access_token requestBody: required: true content: @@ -74,4 +67,5 @@ requestBody: example: - abcd1234abcd1234abcd1234 - abcd1234abcd1234abcd1235 +x-cli-command: glossaries update x-cli-version: '2.5' diff --git a/paths/glossary_term_translations/create.yaml b/paths/glossary_term_translations/create.yaml index e2604379..f8baf8c0 100644 --- a/paths/glossary_term_translations/create.yaml +++ b/paths/glossary_term_translations/create.yaml @@ -44,14 +44,6 @@ x-code-samples: -X POST \ -d '{"locale_code":"en-US","content":"My translated term"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase glossary_term_translations create \ - --account_id \ - --glossary_id \ - --term_id \ - --data '{"locale_code":"en-US", "content": "My translated term"}' \ - --access_token requestBody: required: true content: @@ -71,4 +63,5 @@ requestBody: description: The content of the translation type: string example: My translated term +x-cli-command: glossary_term_translations create x-cli-version: '2.5' diff --git a/paths/glossary_term_translations/destroy.yaml b/paths/glossary_term_translations/destroy.yaml index ae36216f..73440637 100644 --- a/paths/glossary_term_translations/destroy.yaml +++ b/paths/glossary_term_translations/destroy.yaml @@ -32,12 +32,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase glossary_term_translations delete \ - --account_id \ - --glossary_id \ - --term_id \ - --id \ - --access_token +x-cli-command: glossary_term_translations delete x-cli-version: '2.5' diff --git a/paths/glossary_term_translations/update.yaml b/paths/glossary_term_translations/update.yaml index 2fc36dac..ec17fd19 100644 --- a/paths/glossary_term_translations/update.yaml +++ b/paths/glossary_term_translations/update.yaml @@ -45,15 +45,6 @@ x-code-samples: -X PATCH \ -d '{"locale_code":"en-US","content":"My translated term"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase glossary_term_translations update \ - --account_id \ - --glossary_id \ - --term_id \ - --id \ - --data '{"locale_code":"en-US", "content": "My translated term"}' \ - --access_token requestBody: required: true content: @@ -70,4 +61,5 @@ requestBody: description: The content of the translation type: string example: My translated term +x-cli-command: glossary_term_translations update x-cli-version: '2.5' diff --git a/paths/glossary_terms/create.yaml b/paths/glossary_terms/create.yaml index 9f6966e9..af1162df 100644 --- a/paths/glossary_terms/create.yaml +++ b/paths/glossary_terms/create.yaml @@ -43,13 +43,6 @@ x-code-samples: -X POST \ -d '{"term":"MyCompany","description":"Use this when refering to our company","translatable":true,"case_sensitive":true}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase glossary_terms create \ - --account_id \ - --glossary_id \ - --data '{"term":"MyCompany", "description": "Use this when refering to our company", "translatable":true, "case_sensitive":true}' \ - --access_token requestBody: required: true content: @@ -76,4 +69,5 @@ requestBody: description: Indicates whether the term is case sensitive type: boolean example: true +x-cli-command: glossary_terms create x-cli-version: '2.5' diff --git a/paths/glossary_terms/destroy.yaml b/paths/glossary_terms/destroy.yaml index 50247c45..30952a7d 100644 --- a/paths/glossary_terms/destroy.yaml +++ b/paths/glossary_terms/destroy.yaml @@ -31,11 +31,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:glossary_id/terms/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase glossary_terms delete \ - --account_id \ - --glossary_id \ - --id \ - --access_token +x-cli-command: glossary_terms delete x-cli-version: '2.5' diff --git a/paths/glossary_terms/index.yaml b/paths/glossary_terms/index.yaml index a7907012..49aeac17 100644 --- a/paths/glossary_terms/index.yaml +++ b/paths/glossary_terms/index.yaml @@ -46,10 +46,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:glossary_id/terms" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase glossary_terms list \ - --account_id \ - --glossary_id \ - --access_token +x-cli-command: glossary_terms list x-cli-version: '2.5' diff --git a/paths/glossary_terms/show.yaml b/paths/glossary_terms/show.yaml index f69e0cc2..7409afad 100644 --- a/paths/glossary_terms/show.yaml +++ b/paths/glossary_terms/show.yaml @@ -39,11 +39,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:glossary_id/terms/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase glossary_terms show \ - --account_id \ - --glossary_id \ - --id \ - --access_token +x-cli-command: glossary_terms show x-cli-version: '2.5' diff --git a/paths/glossary_terms/update.yaml b/paths/glossary_terms/update.yaml index 7e06e6b2..ee98d83e 100644 --- a/paths/glossary_terms/update.yaml +++ b/paths/glossary_terms/update.yaml @@ -44,14 +44,6 @@ x-code-samples: -X PATCH \ -d '{"term":"MyCompany","description":"Use this when refering to our company","translatable":true,"case_sensitive":true}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase glossary_terms update \ - --account_id \ - --glossary_id \ - --id \ - --data '{"term":"MyCompany", "description": "Use this when refering to our company", "translatable":true, "case_sensitive":true}' \ - --access_token requestBody: required: true content: @@ -76,4 +68,5 @@ requestBody: description: Indicates whether the term is case sensitive type: boolean example: true +x-cli-command: glossary_terms update x-cli-version: '2.5' diff --git a/paths/icu/skeleton.yaml b/paths/icu/skeleton.yaml index 11b87eb0..c5cbff65 100644 --- a/paths/icu/skeleton.yaml +++ b/paths/icu/skeleton.yaml @@ -41,11 +41,6 @@ x-code-samples: -X POST \ -d '{"content":"{number, plural, one {One} other {%{n}}}","locale_codes":["en"],"zero_form_enabled": true}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase icu skeleton \ - --data '{"content":"{number, plural, one {One} other {%{n}}}","locale_codes":["en"],"zero_form_enabled": true}' \ - --access_token requestBody: required: true content: @@ -88,4 +83,5 @@ requestBody: type: string example: cldr_41 +x-cli-command: icu skeleton x-cli-version: '2.9' diff --git a/paths/invitations/create.yaml b/paths/invitations/create.yaml index 60a40f86..9c7390ba 100644 --- a/paths/invitations/create.yaml +++ b/paths/invitations/create.yaml @@ -41,12 +41,6 @@ x-code-samples: -X POST \ -d '{"email":"example@mail.com","role":"Developer","project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","locale_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"team_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"default_locale_codes":["de","en"],"permissions":{"create_upload":true,"review_translations":true}}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase invitations create \ - --account_id \ - --data '{"email":"example@mail.com", "role":"Developer", "project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "locale_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"team_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"], "default_locale_codes":["de","en"], "permissions":"{"create_upload"=>true, "review_translations"=>true}"}' \ - --access_token requestBody: required: true content: @@ -106,4 +100,5 @@ requestBody: example: create_upload: true review_translations: true +x-cli-command: invitations create x-cli-version: '2.5' diff --git a/paths/invitations/destroy.yaml b/paths/invitations/destroy.yaml index 442ceeed..5a0c86fe 100644 --- a/paths/invitations/destroy.yaml +++ b/paths/invitations/destroy.yaml @@ -29,10 +29,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/invitations/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase invitations delete \ - --account_id \ - --id \ - --access_token +x-cli-command: invitations delete x-cli-version: '2.5' diff --git a/paths/invitations/index.yaml b/paths/invitations/index.yaml index b3a8acd9..fd328d8c 100644 --- a/paths/invitations/index.yaml +++ b/paths/invitations/index.yaml @@ -44,9 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/invitations" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase invitations list \ - --account_id \ - --access_token +x-cli-command: invitations list x-cli-version: '2.5' diff --git a/paths/invitations/resend.yaml b/paths/invitations/resend.yaml index e1bb4de5..ed468907 100644 --- a/paths/invitations/resend.yaml +++ b/paths/invitations/resend.yaml @@ -40,10 +40,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/invitations/:id/resend" \ -u USERNAME_OR_ACCESS_TOKEN \ -X POST -- lang: CLI v2 - source: |- - phrase invitations resend \ - --account_id \ - --id \ - --access_token +x-cli-command: invitations resend x-cli-version: '2.5' diff --git a/paths/invitations/show.yaml b/paths/invitations/show.yaml index ed35394e..53cbf32c 100644 --- a/paths/invitations/show.yaml +++ b/paths/invitations/show.yaml @@ -37,10 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/invitations/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase invitations show \ - --account_id \ - --id \ - --access_token +x-cli-command: invitations show x-cli-version: '2.5' diff --git a/paths/invitations/update.yaml b/paths/invitations/update.yaml index 19807f82..bed0e2c4 100644 --- a/paths/invitations/update.yaml +++ b/paths/invitations/update.yaml @@ -42,13 +42,6 @@ x-code-samples: -X PATCH \ -d '{"role":"Invitiation role","project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","locale_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"team_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"default_locale_codes":["de","en"],"permissions":{"create_upload":true}}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase invitations update \ - --account_id \ - --id \ - --data '{"role": "Invitiation role", "project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "locale_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"team_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"], "default_locale_codes":["de","en"], "permissions":"{"create_upload"=>true}"}' \ - --access_token requestBody: required: true content: @@ -100,4 +93,5 @@ requestBody: type: string example: create_upload: true +x-cli-command: invitations update x-cli-version: '2.5' diff --git a/paths/invitations/update_settings.yaml b/paths/invitations/update_settings.yaml index a6be38e3..48e4bfdd 100644 --- a/paths/invitations/update_settings.yaml +++ b/paths/invitations/update_settings.yaml @@ -42,13 +42,6 @@ x-code-samples: -X PATCH \ -d '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase invitations update_settings \ - --project_id \ - --id \ - --data '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \ - --access_token requestBody: required: true content: @@ -69,4 +62,5 @@ requestBody: example: - abcd1234abcd1234abcd1234 - abcd1234abcd1234abcd1235 +x-cli-command: invitations update_settings x-cli-version: '2.5' diff --git a/paths/job_annotations/destroy.yaml b/paths/job_annotations/destroy.yaml index 2f019962..64474f63 100644 --- a/paths/job_annotations/destroy.yaml +++ b/paths/job_annotations/destroy.yaml @@ -37,11 +37,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/annotations/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase job_annotations delete \ - --project_id \ - --job_id \ - --id \ - --access_token +x-cli-command: job_annotations delete x-cli-version: '2.43' diff --git a/paths/job_annotations/index.yaml b/paths/job_annotations/index.yaml index 9b45c701..b6b754ee 100644 --- a/paths/job_annotations/index.yaml +++ b/paths/job_annotations/index.yaml @@ -31,10 +31,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/annotations" \ -u USERNAME_OR_ACCESS_TOKEN \ -X GET -- lang: CLI v2 - source: |- - phrase job_annotations list \ - --project_id \ - --job_id \ - --access_token +x-cli-command: job_annotations list x-cli-version: '2.43' diff --git a/paths/job_annotations/update.yaml b/paths/job_annotations/update.yaml index 4ad52eb4..4f3dcd8b 100644 --- a/paths/job_annotations/update.yaml +++ b/paths/job_annotations/update.yaml @@ -42,14 +42,6 @@ x-code-samples: -X PATCH \ -d '{"value":"Some value..."}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_annotations update \ - --project_id \ - --job_id \ - --id \ - --data '{"value": "Some value..."}' \ - --access_token requestBody: required: true content: @@ -66,4 +58,5 @@ requestBody: description: Branch name of the job type: string example: my-feature-branch +x-cli-command: job_annotations update x-cli-version: '2.43' diff --git a/paths/job_comments/create.yaml b/paths/job_comments/create.yaml index 58a055c9..866938e3 100644 --- a/paths/job_comments/create.yaml +++ b/paths/job_comments/create.yaml @@ -36,13 +36,6 @@ x-code-samples: -X POST \ -d '{"message":"Some message..."}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_comments create \ - --project_id \ - --job_id \ - --data '{"message": "Some message..."}' \ - --access_token requestBody: required: true content: @@ -59,4 +52,5 @@ requestBody: description: Branch name for the job type: string example: my-feature-branch +x-cli-command: job_comments create x-cli-version: '2.5' diff --git a/paths/job_comments/destroy.yaml b/paths/job_comments/destroy.yaml index 70d10ec0..447d7036 100644 --- a/paths/job_comments/destroy.yaml +++ b/paths/job_comments/destroy.yaml @@ -27,12 +27,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_comments delete \ - --project_id \ - --job_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_comments delete x-cli-version: '2.5' diff --git a/paths/job_comments/index.yaml b/paths/job_comments/index.yaml index c1f0bbc3..e2d92c65 100644 --- a/paths/job_comments/index.yaml +++ b/paths/job_comments/index.yaml @@ -46,12 +46,5 @@ x-code-samples: source: |- 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 \ - --job_id \ - --branch my-feature-branch \ - --order desc \ - --access_token +x-cli-command: job_comments list x-cli-version: '2.5' diff --git a/paths/job_comments/show.yaml b/paths/job_comments/show.yaml index 044932ec..b45108d6 100644 --- a/paths/job_comments/show.yaml +++ b/paths/job_comments/show.yaml @@ -35,12 +35,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/comments/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase job_comments show \ - --project_id \ - --job_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_comments show x-cli-version: '2.5' diff --git a/paths/job_comments/update.yaml b/paths/job_comments/update.yaml index 9a097d67..d9311f43 100644 --- a/paths/job_comments/update.yaml +++ b/paths/job_comments/update.yaml @@ -37,14 +37,6 @@ x-code-samples: -X PATCH \ -d '{"message":"Some message..."}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_comments update \ - --project_id \ - --job_id \ - --id \ - --data '{"message": "Some message..."}' \ - --access_token requestBody: required: true content: @@ -61,4 +53,5 @@ requestBody: description: Branch name for the job type: string example: my-feature-branch +x-cli-command: job_comments update x-cli-version: '2.5' diff --git a/paths/job_locale_annotations/destroy.yaml b/paths/job_locale_annotations/destroy.yaml index f20407f5..ce59d5dd 100644 --- a/paths/job_locale_annotations/destroy.yaml +++ b/paths/job_locale_annotations/destroy.yaml @@ -38,12 +38,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:job_locale_id/annotations/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase job_locale_annotations delete \ - --project_id \ - --job_id \ - --job_locale_id \ - --id \ - --access_token +x-cli-command: job_annotations delete x-cli-version: '2.43' diff --git a/paths/job_locale_annotations/index.yaml b/paths/job_locale_annotations/index.yaml index 7cf013b5..233b12ed 100644 --- a/paths/job_locale_annotations/index.yaml +++ b/paths/job_locale_annotations/index.yaml @@ -32,11 +32,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:job_locale_id/annotations" \ -u USERNAME_OR_ACCESS_TOKEN \ -X GET -- lang: CLI v2 - source: |- - phrase job_locale_annotations list \ - --project_id \ - --job_id \ - --job_locale_id \ - --access_token +x-cli-command: job_annotations list x-cli-version: '2.43' diff --git a/paths/job_locale_annotations/update.yaml b/paths/job_locale_annotations/update.yaml index 4388c288..9cf62293 100644 --- a/paths/job_locale_annotations/update.yaml +++ b/paths/job_locale_annotations/update.yaml @@ -43,15 +43,6 @@ x-code-samples: -X PATCH \ -d '{"value":"Some value..."}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_locale_annotations update \ - --project_id \ - --job_id \ - --job_locale_id \ - --id \ - --data '{"value": "Some value..."}' \ - --access_token requestBody: required: true content: @@ -68,4 +59,5 @@ requestBody: description: Branch name of the job type: string example: my-feature-branch +x-cli-command: job_annotations update x-cli-version: '2.43' diff --git a/paths/job_locales/complete.yaml b/paths/job_locales/complete.yaml index d61571fc..0bf4e45c 100644 --- a/paths/job_locales/complete.yaml +++ b/paths/job_locales/complete.yaml @@ -37,14 +37,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_locales complete \ - --project_id \ - --job_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -57,4 +49,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: job_locales complete x-cli-version: '2.5' diff --git a/paths/job_locales/complete_review.yaml b/paths/job_locales/complete_review.yaml index 054298ab..335d2e81 100644 --- a/paths/job_locales/complete_review.yaml +++ b/paths/job_locales/complete_review.yaml @@ -37,14 +37,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_locales complete \ - --project_id \ - --job_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -57,4 +49,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: job_locales complete_review x-cli-version: '2.5' diff --git a/paths/job_locales/create.yaml b/paths/job_locales/create.yaml index ce4fce85..d59d0f1f 100644 --- a/paths/job_locales/create.yaml +++ b/paths/job_locales/create.yaml @@ -36,13 +36,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","user_ids":["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_locales create \ - --project_id \ - --job_id \ - --data '{"branch":"my-feature-branch", "locale_id":"abcd1234cdef1234abcd1234cdef1234", "user_ids": "abcd1234cdef1234abcd1234cdef1234", "translator_team_ids": "abcd1234cdef1234abcd1234cdef1234"}' \ - --access_token requestBody: required: true content: @@ -89,4 +82,5 @@ requestBody: - abcd1234cdef1234abcd1234cdef1234 required: - locale_id +x-cli-command: job_locales create x-cli-version: '2.6.8' diff --git a/paths/job_locales/destroy.yaml b/paths/job_locales/destroy.yaml index 888fd87a..dcf83310 100644 --- a/paths/job_locales/destroy.yaml +++ b/paths/job_locales/destroy.yaml @@ -27,12 +27,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_locales delete \ - --project_id \ - --job_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_locales delete x-cli-version: '2.5' diff --git a/paths/job_locales/index.yaml b/paths/job_locales/index.yaml index e6262a54..7f791668 100644 --- a/paths/job_locales/index.yaml +++ b/paths/job_locales/index.yaml @@ -43,11 +43,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase job_locales list \ - --project_id \ - --job_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_locales list x-cli-version: '2.5' diff --git a/paths/job_locales/reopen.yaml b/paths/job_locales/reopen.yaml index d983a129..f0cdcfc4 100644 --- a/paths/job_locales/reopen.yaml +++ b/paths/job_locales/reopen.yaml @@ -37,14 +37,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_locales reopen \ - --project_id \ - --job_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -57,4 +49,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: job_locales reopen x-cli-version: '2.5' diff --git a/paths/job_locales/show.yaml b/paths/job_locales/show.yaml index dd9e775b..54f64f1c 100644 --- a/paths/job_locales/show.yaml +++ b/paths/job_locales/show.yaml @@ -36,12 +36,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase job_locales show \ - --project_id \ - --job_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_locales show x-cli-version: '2.9.0' diff --git a/paths/job_locales/update.yaml b/paths/job_locales/update.yaml index 55b2e33b..5abf765b 100644 --- a/paths/job_locales/update.yaml +++ b/paths/job_locales/update.yaml @@ -37,14 +37,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","user_ids":["abcd1234cdef1234abcd1234cdef1234"], "team_ids":["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_locales update \ - --project_id \ - --job_id \ - --id \ - --data '{"branch":"my-feature-branch", "locale_id":"abcd1234cdef1234abcd1234cdef1234", "user_ids": "abcd1234cdef1234abcd1234cdef1234", "team_ids": "abcd1234cdef1234abcd1234cdef1234", "translator_team_ids": "abcd1234cdef1234abcd1234cdef1234"}' \ - --access_token requestBody: required: true content: @@ -89,4 +81,5 @@ requestBody: type: string example: - abcd1234cdef1234abcd1234cdef1234 +x-cli-command: job_locales update x-cli-version: '2.6.8' diff --git a/paths/job_template_locales/create.yaml b/paths/job_template_locales/create.yaml index 1e7bb524..3cf8559c 100644 --- a/paths/job_template_locales/create.yaml +++ b/paths/job_template_locales/create.yaml @@ -36,13 +36,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","user_ids":["abcd1234cdef1234abcd1234cdef1234"],"reviewer_ids":["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_template_locales create \ - --project_id \ - --job_template_id \ - --data '{"branch":"my-feature-branch", "locale_id":"abcd1234cdef1234abcd1234cdef1234", "user_ids": "abcd1234cdef1234abcd1234cdef1234", "reviewer_ids": "abcd1234cdef1234abcd1234cdef1234", "translator_team_ids":"abcd1234cdef1234abcd1234cdef1234"}' \ - --access_token requestBody: required: true content: @@ -89,4 +82,5 @@ requestBody: - abcd1234cdef1234abcd1234cdef1234 required: - locale_id +x-cli-command: job_template_locales create x-cli-version: '2.6.8' diff --git a/paths/job_template_locales/destroy.yaml b/paths/job_template_locales/destroy.yaml index e7bf2e9a..1a4d66a1 100644 --- a/paths/job_template_locales/destroy.yaml +++ b/paths/job_template_locales/destroy.yaml @@ -32,12 +32,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_template_locales delete \ - --project_id \ - --job_template_id \ - --job_template_locale_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_template_locales delete x-cli-version: '2.5' diff --git a/paths/job_template_locales/index.yaml b/paths/job_template_locales/index.yaml index e99bf8fb..6c19d328 100644 --- a/paths/job_template_locales/index.yaml +++ b/paths/job_template_locales/index.yaml @@ -47,11 +47,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/job_templates/:job_template_id/locales?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase job_template_locales list \ - --project_id \ - --job_template_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_template_locales list x-cli-version: '2.5' diff --git a/paths/job_template_locales/show.yaml b/paths/job_template_locales/show.yaml index 56b6505c..94c50ea8 100644 --- a/paths/job_template_locales/show.yaml +++ b/paths/job_template_locales/show.yaml @@ -40,12 +40,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/job_templates/:job_template_id/locales/:job_template_locale_id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase job_template_locales show \ - --project_id \ - --job_template_id \ - --job_template_locale_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_template_locales show x-cli-version: '2.6.8' diff --git a/paths/job_template_locales/update.yaml b/paths/job_template_locales/update.yaml index 23c60156..bdfa0b0c 100644 --- a/paths/job_template_locales/update.yaml +++ b/paths/job_template_locales/update.yaml @@ -37,14 +37,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","user_ids":["abcd1234cdef1234abcd1234cdef1234"],"reviewer_ids":["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_template_locales update \ - --project_id \ - --job_template_id \ - --job_template_locale_id \ - --data '{"branch":"my-feature-branch", "locale_id":"abcd1234cdef1234abcd1234cdef1234", "user_ids": "abcd1234cdef1234abcd1234cdef1234", "reviewer_ids": "abcd1234cdef1234abcd1234cdef1234", "translator_team_ids": "abcd1234cdef1234abcd1234cdef1234"}' \ - --access_token requestBody: required: true content: @@ -89,4 +81,5 @@ requestBody: type: string example: - abcd1234cdef1234abcd1234cdef1234 +x-cli-command: job_template_locales update x-cli-version: '2.6.8' diff --git a/paths/job_templates/create.yaml b/paths/job_templates/create.yaml index ee36a6cd..981ed08d 100644 --- a/paths/job_templates/create.yaml +++ b/paths/job_templates/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","name":"template","briefing":"text"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_templates create \ - --project_id \ - --data '{"branch":"my-feature-branch", "name":"template", "briefing":"text"}' \ - --access_token requestBody: required: true content: @@ -78,4 +72,5 @@ requestBody: example: abcd1234cdef1234abcd1234cdef1234 required: - name +x-cli-command: job_templates create x-cli-version: '2.5' diff --git a/paths/job_templates/destroy.yaml b/paths/job_templates/destroy.yaml index b6404680..3f97b8e9 100644 --- a/paths/job_templates/destroy.yaml +++ b/paths/job_templates/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_templates delete \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_templates delete x-cli-version: '2.5' diff --git a/paths/job_templates/index.yaml b/paths/job_templates/index.yaml index f20ba36e..eb8516e7 100644 --- a/paths/job_templates/index.yaml +++ b/paths/job_templates/index.yaml @@ -51,10 +51,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/job_templates?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase job_templates list \ - --project_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_templates list x-cli-version: "2.5" diff --git a/paths/job_templates/show.yaml b/paths/job_templates/show.yaml index 0197a9ff..14e2bfc9 100644 --- a/paths/job_templates/show.yaml +++ b/paths/job_templates/show.yaml @@ -44,11 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/job_templates/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase job_templates show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: job_templates show x-cli-version: "2.5" diff --git a/paths/job_templates/update.yaml b/paths/job_templates/update.yaml index 719af115..20b19a7e 100644 --- a/paths/job_templates/update.yaml +++ b/paths/job_templates/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","name":"template","briefing":"text"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase job_templates update \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch", "name":"template", "briefing":"text"}' \ - --access_token requestBody: required: true content: @@ -80,4 +73,5 @@ requestBody: example: abcd1234cdef1234abcd1234cdef1234 required: - name +x-cli-command: job_templates update x-cli-version: '2.5' diff --git a/paths/jobs/add_keys.yaml b/paths/jobs/add_keys.yaml index 99e4f33e..8f07d15e 100644 --- a/paths/jobs/add_keys.yaml +++ b/paths/jobs/add_keys.yaml @@ -36,13 +36,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","translation_key_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs keys_create \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch", "translation_key_ids": "abcd1234cdef1234abcd1234cdef1234"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: type: string example: - abcd1234cdef1234abcd1234cdef1234 +x-cli-command: jobs keys_create x-cli-version: '2.5' diff --git a/paths/jobs/complete.yaml b/paths/jobs/complete.yaml index a429583c..504f0049 100644 --- a/paths/jobs/complete.yaml +++ b/paths/jobs/complete.yaml @@ -43,13 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs complete \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: jobs complete x-cli-version: '2.5' diff --git a/paths/jobs/create.yaml b/paths/jobs/create.yaml index 47818db1..4801ead9 100644 --- a/paths/jobs/create.yaml +++ b/paths/jobs/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","name":"de","briefing":"de-DE","due_date":"2017-08-15","ticket_url":"https://example.atlassian.net/browse/FOO","tags":["myUploadTag"],"translation_key_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs create \ - --project_id \ - --data '{"branch":"my-feature-branch", "name":"de", "briefing":"de-DE", "due_date":"2017-08-15", "ticket_url":"https://example.atlassian.net/browse/FOO", "tags": ["myUploadTag"], "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"]}' \ - --access_token requestBody: required: true content: @@ -113,4 +107,5 @@ requestBody: description: Automatically translate the job using machine translation. type: boolean example: true +x-cli-command: jobs create x-cli-version: '2.5' diff --git a/paths/jobs/destroy.yaml b/paths/jobs/destroy.yaml index b66b1be7..1ac23a52 100644 --- a/paths/jobs/destroy.yaml +++ b/paths/jobs/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs delete \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: jobs delete x-cli-version: '2.5' diff --git a/paths/jobs/index.yaml b/paths/jobs/index.yaml index f54925bd..90be47eb 100644 --- a/paths/jobs/index.yaml +++ b/paths/jobs/index.yaml @@ -68,13 +68,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/jobs?branch=my-feature-branch&owned_by=abcd1234cdef1234abcd1234cdef1234&assigned_to=abcd1234cdef1234abcd1234cdef1234&state=completed" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase jobs list \ - --project_id \ - --branch my-feature-branch \ - --owned_by abcd1234cdef1234abcd1234cdef1234 \ - --assigned_to abcd1234cdef1234abcd1234cdef1234 \ - --state completed \ - --access_token +x-cli-command: jobs list x-cli-version: '2.5' diff --git a/paths/jobs/index_account.yaml b/paths/jobs/index_account.yaml index 43f12f1d..a932375f 100644 --- a/paths/jobs/index_account.yaml +++ b/paths/jobs/index_account.yaml @@ -49,12 +49,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/jobs?owned_by=abcd1234cdef1234abcd1234cdef1234&assigned_to=abcd1234cdef1234abcd1234cdef1234&state=completed" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase jobs by_account \ - --account_id \ - --owned_by abcd1234cdef1234abcd1234cdef1234 \ - --assigned_to abcd1234cdef1234abcd1234cdef1234 \ - --state completed \ - --access_token +x-cli-command: jobs by_account x-cli-version: '2.5' diff --git a/paths/jobs/lock.yaml b/paths/jobs/lock.yaml index df404dab..9de2751c 100644 --- a/paths/jobs/lock.yaml +++ b/paths/jobs/lock.yaml @@ -49,11 +49,5 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs lock \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: jobs lock x-cli-version: '2.5' diff --git a/paths/jobs/remove_keys.yaml b/paths/jobs/remove_keys.yaml index b6fb18ff..75aea2ad 100644 --- a/paths/jobs/remove_keys.yaml +++ b/paths/jobs/remove_keys.yaml @@ -25,14 +25,6 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch","translation_key_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs keys_delete \ - --project_id \ - --id \ - --branch my-feature-branch \ - --data '{"branch": "my-feature-branch", "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"]}' \ - --access_token requestBody: required: true content: @@ -54,3 +46,5 @@ requestBody: type: string example: - abcd1234cdef1234abcd1234cdef1234 + +x-cli-command: jobs keys_delete diff --git a/paths/jobs/reopen.yaml b/paths/jobs/reopen.yaml index 862ad2f5..4e5445e6 100644 --- a/paths/jobs/reopen.yaml +++ b/paths/jobs/reopen.yaml @@ -43,13 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs reopen \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: jobs reopen x-cli-version: '2.5' diff --git a/paths/jobs/show.yaml b/paths/jobs/show.yaml index d2f645b1..1c2d36dd 100644 --- a/paths/jobs/show.yaml +++ b/paths/jobs/show.yaml @@ -41,11 +41,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/jobs/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase jobs show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: jobs show x-cli-version: '2.5' diff --git a/paths/jobs/start.yaml b/paths/jobs/start.yaml index 8165f70e..f5abd8f0 100644 --- a/paths/jobs/start.yaml +++ b/paths/jobs/start.yaml @@ -43,13 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs start \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: jobs start x-cli-version: '2.5' diff --git a/paths/jobs/unlock.yaml b/paths/jobs/unlock.yaml index 51f62463..0cbd37c9 100644 --- a/paths/jobs/unlock.yaml +++ b/paths/jobs/unlock.yaml @@ -49,11 +49,5 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs unlock \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: jobs unlock x-cli-version: '2.5' diff --git a/paths/jobs/update.yaml b/paths/jobs/update.yaml index a7983730..d7203317 100644 --- a/paths/jobs/update.yaml +++ b/paths/jobs/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","name":"de","briefing":"de-DE","due_date":"2017-08-15","ticket_url":"https://example.atlassian.net/browse/FOO"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase jobs update \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch", "name":"de", "briefing":"de-DE", "due_date":"2017-08-15", "ticket_url":"https://example.atlassian.net/browse/FOO"}' \ - --access_token requestBody: required: true content: @@ -91,4 +84,5 @@ requestBody: description: Automatically translate the job using machine translation type: boolean example: true +x-cli-command: jobs update x-cli-version: '2.5' diff --git a/paths/key_links/batch_destroy.yaml b/paths/key_links/batch_destroy.yaml index 41a92cfe..0e762c93 100644 --- a/paths/key_links/batch_destroy.yaml +++ b/paths/key_links/batch_destroy.yaml @@ -67,3 +67,5 @@ x-code-samples: -X DELETE \ -H "Content-Type: application/json" \ -d '{"child_key_ids": ["feature.subtitle", "nav.home"], "strategy": "keep_content"}' + +x-cli-command: linked_keys batch_destroy diff --git a/paths/key_links/create.yaml b/paths/key_links/create.yaml index 2944c61d..990d2b02 100644 --- a/paths/key_links/create.yaml +++ b/paths/key_links/create.yaml @@ -60,3 +60,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -H "Content-Type: application/json" \ -d '{"child_key_ids": ["ijkl9012mnop3456ijkl9012mnop3456", "abcd1234efgh5678abcd1234efgh5678"]}' +x-cli-command: linked_keys create diff --git a/paths/key_links/destroy.yaml b/paths/key_links/destroy.yaml index 1fa7dd22..63dbf9b0 100644 --- a/paths/key_links/destroy.yaml +++ b/paths/key_links/destroy.yaml @@ -49,3 +49,5 @@ x-code-samples: curl -i "https://api.phrase.com/v2/projects/:project_id/keys/:id/key_links/1234abcd1234cdef1234abcd1234cdef" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE + +x-cli-command: linked_keys destroy diff --git a/paths/key_links/index.yaml b/paths/key_links/index.yaml index c74519ba..7b9f4977 100644 --- a/paths/key_links/index.yaml +++ b/paths/key_links/index.yaml @@ -35,3 +35,5 @@ responses: "$ref": "../../responses.yaml#/404" '429': "$ref": "../../responses.yaml#/429" + +x-cli-command: linked_keys index diff --git a/paths/keys/create.yaml b/paths/keys/create.yaml index 3e16425f..888b7f00 100644 --- a/paths/keys/create.yaml +++ b/paths/keys/create.yaml @@ -49,12 +49,6 @@ x-code-samples: -F max_characters_allowed=140 \ -F screenshot=@/path/to/my/screenshot.png \ -F custom_metadata[property]=value -- lang: CLI v2 - source: |- - phrase keys create \ - --project_id \ - --data '{"branch":"my-feature-branch", "name":"home.index.headline", "description": "Some description worth knowing...", "name_plural":"home.index.headlines", "data_type":"number", "tags":"awesome-feature,needs-proofreading", "max_characters_allowed":"140", "screenshot":"/path/to/my/screenshot.png", "custom_metadata": {"property" => "value"}}' \ - --access_token requestBody: required: true content: @@ -161,4 +155,5 @@ requestBody: type: string example: string +x-cli-command: keys create x-cli-version: '2.5' diff --git a/paths/keys/destroy-collection.yaml b/paths/keys/destroy-collection.yaml index 807cc23d..a9000496 100644 --- a/paths/keys/destroy-collection.yaml +++ b/paths/keys/destroy-collection.yaml @@ -53,12 +53,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch","q":"mykey* translated:true","locale_id":"abcd1234abcd1234abcd1234abcd1234"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase keys delete-collection \ - --project_id \ - --branch my-feature-branch \ - --query 'mykey* translated:true' \ - --locale_id abcd1234abcd1234abcd1234abcd1234 \ - --access_token +x-cli-command: keys delete-collection x-cli-version: '2.5' diff --git a/paths/keys/destroy.yaml b/paths/keys/destroy.yaml index ad4f7730..c2e742ad 100644 --- a/paths/keys/destroy.yaml +++ b/paths/keys/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase keys delete \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: keys delete x-cli-version: '2.5' diff --git a/paths/keys/exclude.yaml b/paths/keys/exclude.yaml index b68f7dc5..e20d2c64 100644 --- a/paths/keys/exclude.yaml +++ b/paths/keys/exclude.yaml @@ -40,12 +40,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"mykey* translated:true","target_locale_id":"abcd1234abcd1234abcd1234abcd1234","tags":"landing-page,release-1.2"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase keys exclude \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'mykey* translated:true'", "target_locale_id":"abcd1234abcd1234abcd1234abcd1234", "tags":"landing-page,release-1.2"}' \ - --access_token requestBody: required: true content: @@ -81,4 +75,5 @@ requestBody: description: Tag or comma-separated list of tags to add to the matching collection of keys type: string example: landing-page,release-1.2 +x-cli-command: keys exclude x-cli-version: '2.5' diff --git a/paths/keys/include.yaml b/paths/keys/include.yaml index 69b3b401..b83a1fde 100644 --- a/paths/keys/include.yaml +++ b/paths/keys/include.yaml @@ -40,12 +40,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"mykey* translated:true","target_locale_id":"abcd1234abcd1234abcd1234abcd1234","tags":"landing-page,release-1.2"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase keys include \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'mykey* translated:true'", "target_locale_id":"abcd1234abcd1234abcd1234abcd1234", "tags":"landing-page,release-1.2"}' \ - --access_token requestBody: required: true content: @@ -82,4 +76,5 @@ requestBody: description: Tag or comma-separated list of tags to add to the matching collection of keys type: string example: landing-page,release-1.2 +x-cli-command: keys include x-cli-version: '2.5' diff --git a/paths/keys/index.yaml b/paths/keys/index.yaml index 46cc1c02..4404600d 100644 --- a/paths/keys/index.yaml +++ b/paths/keys/index.yaml @@ -70,14 +70,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/keys?branch=my-feature-branch&sort=updated_at&order=desc&q=mykey*%20translated:true&locale_id=abcd1234abcd1234abcd1234abcd1234" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase keys list \ - --project_id \ - --branch my-feature-branch \ - --sort updated_at \ - --order desc \ - --query 'mykey* translated:true' \ - --locale_id abcd1234abcd1234abcd1234abcd1234 \ - --access_token +x-cli-command: keys list x-cli-version: '2.5' diff --git a/paths/keys/search.yaml b/paths/keys/search.yaml index e565c50b..388c473e 100644 --- a/paths/keys/search.yaml +++ b/paths/keys/search.yaml @@ -46,12 +46,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","sort":"updated_at","order":"desc","q":"mykey* translated:true","locale_id":"abcd1234abcd1234abcd1234abcd1234"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase keys search \ - --project_id \ - --data '{"branch":"my-feature-branch", "sort":"updated_at", "order":"desc", "q":"'mykey* translated:true'", "locale_id":"abcd1234abcd1234abcd1234abcd1234"}' \ - --access_token requestBody: required: true content: @@ -95,4 +89,5 @@ requestBody: description: Locale used to determine the translation state of a key when filtering for untranslated or translated keys. type: string example: abcd1234abcd1234abcd1234abcd1234 +x-cli-command: keys search x-cli-version: '2.5' diff --git a/paths/keys/show.yaml b/paths/keys/show.yaml index 3feae576..16a6ef58 100644 --- a/paths/keys/show.yaml +++ b/paths/keys/show.yaml @@ -44,11 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/keys/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase keys show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: keys show x-cli-version: '2.5' diff --git a/paths/keys/tag.yaml b/paths/keys/tag.yaml index cc025038..7b209a22 100644 --- a/paths/keys/tag.yaml +++ b/paths/keys/tag.yaml @@ -42,12 +42,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"mykey* translated:true","locale_id":"abcd1234abcd1234abcd1234abcd1234","tags":"landing-page,release-1.2"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase keys tag \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'mykey* translated:true'", "locale_id":"abcd1234abcd1234abcd1234abcd1234", "tags":"landing-page,release-1.2"}' \ - --access_token requestBody: required: true content: @@ -84,4 +78,5 @@ requestBody: description: Tag or comma-separated list of tags to add to the matching collection of keys type: string example: landing-page,release-1.2 +x-cli-command: keys tag x-cli-version: '2.5' diff --git a/paths/keys/untag.yaml b/paths/keys/untag.yaml index f362fc98..96b38021 100644 --- a/paths/keys/untag.yaml +++ b/paths/keys/untag.yaml @@ -40,12 +40,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"mykey* translated:true","locale_id":"abcd1234abcd1234abcd1234abcd1234","tags":"landing-page,release-1.2"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase keys untag \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'mykey* translated:true'", "locale_id":"abcd1234abcd1234abcd1234abcd1234", "tags":"landing-page,release-1.2"}' \ - --access_token requestBody: required: true content: @@ -81,4 +75,5 @@ requestBody: description: Tag or comma-separated list of tags to remove from the matching collection of keys type: string example: landing-page,release-1.2 +x-cli-command: keys untag x-cli-version: '2.5' diff --git a/paths/keys/update.yaml b/paths/keys/update.yaml index ae8ce1a9..7a232bf5 100644 --- a/paths/keys/update.yaml +++ b/paths/keys/update.yaml @@ -50,13 +50,6 @@ x-code-samples: -F max_characters_allowed=140 \ -F screenshot=@/path/to/my/screenshot.png \ -F custom_metadata[property]=value -- lang: CLI v2 - source: |- - phrase keys update \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch", "name":"home.index.headline", "description": "Some description worth knowing...", "name_plural":"home.index.headlines", "data_type":"number", "tags":"awesome-feature,needs-proofreading", "max_characters_allowed":"140", "screenshot":"/path/to/my/screenshot.png", "custom_metadata": {"property" => "value"}}' \ - --access_token requestBody: required: true content: @@ -152,4 +145,5 @@ requestBody: Override of the value type for the key in the export. Most useful for formats like Android XML that distinguish string vs. plural resources. type: string example: string +x-cli-command: keys update x-cli-version: '2.5' diff --git a/paths/locale_downloads/create.yaml b/paths/locale_downloads/create.yaml index ab37ad23..55dc74ed 100644 --- a/paths/locale_downloads/create.yaml +++ b/paths/locale_downloads/create.yaml @@ -154,13 +154,5 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","file_format":"yml","tags":"feature1,feature","custom_metadata_filters":{"tone":"friendly"}}' \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase locale_downloads create \ - --project_id \ - --locale_id \ - --branch my-feature-branch \ - --file_format yml \ - --tags feature1,feature2 \ - --access_token +x-cli-command: locale_downloads create x-cli-version: "2.29.0" diff --git a/paths/locale_downloads/show.yaml b/paths/locale_downloads/show.yaml index a2eb1bdf..c1d98851 100644 --- a/paths/locale_downloads/show.yaml +++ b/paths/locale_downloads/show.yaml @@ -44,11 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/locales/:locale_id/downloads/:id" \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase locale_downloads show \ - --project_id \ - --locale_id \ - --id - --access_token +x-cli-command: locale_downloads show x-cli-version: "2.29.0" diff --git a/paths/locales/create.yaml b/paths/locales/create.yaml index e941028d..45559519 100644 --- a/paths/locales/create.yaml +++ b/paths/locales/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","name":"de","code":"de-DE","source_locale_id":"abcd1234abcd1234abcd1234abcd1234", "fallback_locale_id":"abcd1234abcd1234abcd1234abcd1234"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase locales create \ - --project_id \ - --data '{"branch":"my-feature-branch", "name":"de", "code":"de-DE", "source_locale_id":"abcd1234abcd1234abcd1234abcd1234", "fallback_locale_id":"abcd1234abcd1234abcd1234abcd1234"}' \ - --access_token requestBody: required: true content: @@ -107,4 +101,5 @@ requestBody: description: Identifier of the Language AI profile to use for this locale. type: string example: abcd1234abcd1234abcd1234abcd1234 +x-cli-command: locales create x-cli-version: '2.5' diff --git a/paths/locales/destroy.yaml b/paths/locales/destroy.yaml index 3e6930c2..76a99c1a 100644 --- a/paths/locales/destroy.yaml +++ b/paths/locales/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase locales delete \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: locales delete x-cli-version: '2.5' diff --git a/paths/locales/download.yaml b/paths/locales/download.yaml index f17be581..1eddbb8f 100644 --- a/paths/locales/download.yaml +++ b/paths/locales/download.yaml @@ -198,14 +198,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/locales/:id/download?branch=my-feature-branch&file_format=yml&tags=feature1,feature2&tag=feature&custom_metadata_filters[tone]=friendly" \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase locales download \ - --project_id \ - --id \ - --branch my-feature-branch \ - --file_format yml \ - --tags feature1,feature2 \ - --tag feature \ - --access_token +x-cli-command: locales download x-cli-version: "2.6.4" diff --git a/paths/locales/index.yaml b/paths/locales/index.yaml index 67506291..0e591c03 100644 --- a/paths/locales/index.yaml +++ b/paths/locales/index.yaml @@ -63,10 +63,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/locales?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase locales list \ - --project_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: locales list x-cli-version: '2.5' diff --git a/paths/locales/show.yaml b/paths/locales/show.yaml index 7281ac65..d8218819 100644 --- a/paths/locales/show.yaml +++ b/paths/locales/show.yaml @@ -44,11 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/locales/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase locales show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: locales show x-cli-version: '2.5' diff --git a/paths/locales/update.yaml b/paths/locales/update.yaml index 9752fe8e..3b153533 100644 --- a/paths/locales/update.yaml +++ b/paths/locales/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","name":"de","code":"de-DE","source_locale_id":"abcd1234abcd1234abcd1234abcd1234"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase locales update \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch", "name":"de", "code":"de-DE", "source_locale_id":"abcd1234abcd1234abcd1234abcd1234"}' \ - --access_token requestBody: required: true content: @@ -106,4 +99,5 @@ requestBody: description: Identifier of the Language AI profile to use for this locale. type: string example: abcd1234abcd1234abcd1234abcd1234 +x-cli-command: locales update x-cli-version: '2.5' diff --git a/paths/members/destroy.yaml b/paths/members/destroy.yaml index 51c28de7..6dd352be 100644 --- a/paths/members/destroy.yaml +++ b/paths/members/destroy.yaml @@ -29,10 +29,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/members/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase members delete \ - --account_id \ - --id \ - --access_token +x-cli-command: members delete x-cli-version: '2.5' diff --git a/paths/members/index.yaml b/paths/members/index.yaml index 5076ebd1..fec43cc6 100644 --- a/paths/members/index.yaml +++ b/paths/members/index.yaml @@ -44,9 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/members" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase members list \ - --account_id \ - --access_token +x-cli-command: members list x-cli-version: '2.5' diff --git a/paths/members/show.yaml b/paths/members/show.yaml index 1a6331fb..252dc63f 100644 --- a/paths/members/show.yaml +++ b/paths/members/show.yaml @@ -37,10 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/members/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase members show \ - --account_id \ - --id \ - --access_token +x-cli-command: members show x-cli-version: '2.5' diff --git a/paths/members/update.yaml b/paths/members/update.yaml index 6985d254..ab0de64f 100644 --- a/paths/members/update.yaml +++ b/paths/members/update.yaml @@ -42,13 +42,6 @@ x-code-samples: -X PATCH \ -d '{"role":"Developer","strategy":"set","project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","locale_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","default_locale_codes":["de","en"],"space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],"permissions":{"create_upload":true,"review_translations":true}}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase members update \ - --account_id \ - --id \ - --data '{"role":"Developer", "strategy":"set", "project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "locale_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "default_locale_codes":["de","en"], "space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"], "permissions":"{"create_upload"=>true, "review_translations"=>true}"}' \ - --access_token requestBody: required: true content: @@ -97,4 +90,5 @@ requestBody: example: create_upload: true review_translations: true +x-cli-command: members update x-cli-version: '2.5' diff --git a/paths/members/update_settings.yaml b/paths/members/update_settings.yaml index bae698eb..f5657464 100644 --- a/paths/members/update_settings.yaml +++ b/paths/members/update_settings.yaml @@ -42,13 +42,6 @@ x-code-samples: -X PATCH \ -d '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase members update_settings \ - --project_id \ - --id \ - --data '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \ - --access_token requestBody: required: true content: @@ -69,4 +62,5 @@ requestBody: example: - abcd1234abcd1234abcd1234 - abcd1234abcd1234abcd1235 +x-cli-command: members update_settings x-cli-version: '2.5' diff --git a/paths/notification_groups/index.yaml b/paths/notification_groups/index.yaml index aefb3a94..f5f2b22c 100644 --- a/paths/notification_groups/index.yaml +++ b/paths/notification_groups/index.yaml @@ -44,8 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/notification_groups" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase notification_groups list \ - --access_token +x-cli-command: notification_groups list x-cli-version: '2.5' diff --git a/paths/notification_groups/mark_all_as_read.yaml b/paths/notification_groups/mark_all_as_read.yaml index 17ad3af1..28603294 100644 --- a/paths/notification_groups/mark_all_as_read.yaml +++ b/paths/notification_groups/mark_all_as_read.yaml @@ -40,8 +40,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X PATCH \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase notification_groups mark_all_as_read \ - --access_token +x-cli-command: notification_groups mark_all_as_read x-cli-version: '2.5' diff --git a/paths/notification_groups/mark_as_read.yaml b/paths/notification_groups/mark_as_read.yaml index f53fd49a..ae4ce58e 100644 --- a/paths/notification_groups/mark_as_read.yaml +++ b/paths/notification_groups/mark_as_read.yaml @@ -39,9 +39,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X PATCH \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase notification_groups mark_as_read \ - --id \ - --access_token +x-cli-command: notification_groups mark_as_read x-cli-version: '2.5' diff --git a/paths/notifications/index.yaml b/paths/notifications/index.yaml index 02914099..bd6ff283 100644 --- a/paths/notifications/index.yaml +++ b/paths/notifications/index.yaml @@ -57,8 +57,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/notifications" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase notifications list \ - --access_token +x-cli-command: notifications list x-cli-version: '2.5' diff --git a/paths/notifications/mark_all_as_read.yaml b/paths/notifications/mark_all_as_read.yaml index d1d21d48..9a622261 100644 --- a/paths/notifications/mark_all_as_read.yaml +++ b/paths/notifications/mark_all_as_read.yaml @@ -40,8 +40,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase notifications mark_all_as_read \ - --access_token +x-cli-command: notifications mark_all_as_read x-cli-version: '2.5' diff --git a/paths/notifications/show.yaml b/paths/notifications/show.yaml index 46572646..4b7c7676 100644 --- a/paths/notifications/show.yaml +++ b/paths/notifications/show.yaml @@ -36,9 +36,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/notification/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase notifications show \ - --id \ - --access_token +x-cli-command: notifications show x-cli-version: '2.5' diff --git a/paths/orders/confirm.yaml b/paths/orders/confirm.yaml index 347ba7ee..c5cdc5f4 100644 --- a/paths/orders/confirm.yaml +++ b/paths/orders/confirm.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase orders confirm \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: orders confirm x-cli-version: '2.5' diff --git a/paths/orders/create.yaml b/paths/orders/create.yaml index 7fa17720..5d148563 100644 --- a/paths/orders/create.yaml +++ b/paths/orders/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","name":"Welcome message translations","lsp":"textmaster","source_locale_id":"abcd1234abcd1234abcd1234abcd1234","target_locale_ids":["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],"translation_type":"premium","tag":"my-awesome-feature","message":"Please make everything sound really nice :)","styleguide_id":"1234abcd1234abcd1234abcd1234abcd","category":"C021"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase orders create \ - --project_id \ - --data '{"branch":"my-feature-branch", "name":"Welcome message translations", "lsp":"textmaster", "source_locale_id":"abcd1234abcd1234abcd1234abcd1234", "target_locale_ids": "1234abcd1234abcd1234abcd1234abcd,abcd1234abcd1234abcd1234abcd1234", "translation_type":"premium", "tag":"my-awesome-feature", "message": "Please make everything sound really nice :)", "styleguide_id":"1234abcd1234abcd1234abcd1234abcd", "category":"C021"}' \ - --access_token requestBody: required: true content: @@ -123,4 +117,5 @@ requestBody: description: Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster. type: boolean example: +x-cli-command: orders create x-cli-version: '2.5' diff --git a/paths/orders/destroy.yaml b/paths/orders/destroy.yaml index 3ef1ce0e..e497eca1 100644 --- a/paths/orders/destroy.yaml +++ b/paths/orders/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase orders delete \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: orders delete x-cli-version: '2.5' diff --git a/paths/orders/index.yaml b/paths/orders/index.yaml index d96b75bc..794d0194 100644 --- a/paths/orders/index.yaml +++ b/paths/orders/index.yaml @@ -58,10 +58,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/orders?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase orders list \ - --project_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: orders list x-cli-version: '2.5' diff --git a/paths/orders/show.yaml b/paths/orders/show.yaml index c29d878f..2a0fd742 100644 --- a/paths/orders/show.yaml +++ b/paths/orders/show.yaml @@ -44,11 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/orders/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase orders show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: orders show x-cli-version: '2.5' diff --git a/paths/organization_job_template_locales/create.yaml b/paths/organization_job_template_locales/create.yaml index 35541f2e..806e7a5a 100644 --- a/paths/organization_job_template_locales/create.yaml +++ b/paths/organization_job_template_locales/create.yaml @@ -36,13 +36,6 @@ x-code-samples: -X POST \ -d '{"locale_name":"de-1","locale_code:"de-DE",user_ids":["abcd1234cdef1234abcd1234cdef1234"],"reviewer_ids":["abcd1234cdef1234abcd1234cdef1234"],"translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase organization_job_template_locales create \ - --account_id \ - --job_template_id \ - --data '{"locale_name": "de-1", "locale_code: "de-DE", "user_ids": "abcd1234cdef1234abcd1234cdef1234", "reviewer_ids": "abcd1234cdef1234abcd1234cdef1234", "translator_team_ids": "abcd1234cdef1234abcd1234cdef1234"}' \ - --access_token requestBody: required: true content: @@ -90,4 +83,5 @@ requestBody: required: - locale_name - locale_code +x-cli-command: organization_job_template_locales create x-cli-version: "2.7.0" diff --git a/paths/organization_job_template_locales/destroy.yaml b/paths/organization_job_template_locales/destroy.yaml index edaac1a3..46ab87a0 100644 --- a/paths/organization_job_template_locales/destroy.yaml +++ b/paths/organization_job_template_locales/destroy.yaml @@ -25,11 +25,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase organization_job_template_locales delete \ - --account_id \ - --job_template_id \ - --job_template_locale_id \ - --access_token +x-cli-command: organization_job_template_locales delete x-cli-version: "2.7.0" diff --git a/paths/organization_job_template_locales/index.yaml b/paths/organization_job_template_locales/index.yaml index b8655fa2..eb22d4db 100644 --- a/paths/organization_job_template_locales/index.yaml +++ b/paths/organization_job_template_locales/index.yaml @@ -41,10 +41,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/job_templates/:job_template_id/locales" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase organization_job_template_locales list \ - --account_id \ - --job_template_id \ - --access_token +x-cli-command: organization_job_template_locales list x-cli-version: "2.7.0" diff --git a/paths/organization_job_template_locales/show.yaml b/paths/organization_job_template_locales/show.yaml index 53251ccb..45ed927e 100644 --- a/paths/organization_job_template_locales/show.yaml +++ b/paths/organization_job_template_locales/show.yaml @@ -34,11 +34,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/job_templates/:job_template_id/locales/:job_template_locale_id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase organization_job_template_locales show \ - --account_id \ - --job_template_id \ - --job_template_locale_id \ - --access_token +x-cli-command: organization_job_template_locales show x-cli-version: "2.7.0" diff --git a/paths/organization_job_template_locales/update.yaml b/paths/organization_job_template_locales/update.yaml index d676a1a8..40cd1dae 100644 --- a/paths/organization_job_template_locales/update.yaml +++ b/paths/organization_job_template_locales/update.yaml @@ -37,14 +37,6 @@ x-code-samples: -X PATCH \ -d '{"locale_name":"de-1","locale_code:"de-DE","user_ids":["abcd1234cdef1234abcd1234cdef1234"],"reviewer_ids":["abcd1234cdef1234abcd1234cdef1234"],"translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase organization_job_template_locales update \ - --account_id \ - --job_template_id \ - --job_template_locale_id \ - --data '{"locale_name": "de-1", "locale_code: "de-DE", "user_ids": "abcd1234cdef1234abcd1234cdef1234", "reviewer_ids": "abcd1234cdef1234abcd1234cdef1234","translator_team_ids": "abcd1234cdef1234abcd1234cdef1234"}' \ - --access_token requestBody: required: true content: @@ -89,4 +81,5 @@ requestBody: type: string example: - abcd1234cdef1234abcd1234cdef1234 +x-cli-command: organization_job_template_locales update x-cli-version: "2.7.0" diff --git a/paths/organization_job_templates/create.yaml b/paths/organization_job_templates/create.yaml index c747d9d9..d4539620 100644 --- a/paths/organization_job_templates/create.yaml +++ b/paths/organization_job_templates/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"name":"template","briefing":"text"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase organization_job_templates create \ - --account_id \ - --data '{"name":"template", "briefing":"text"}' \ - --access_token requestBody: required: true content: @@ -70,4 +64,5 @@ requestBody: example: true required: - name +x-cli-command: organization_job_templates create x-cli-version: "2.7.0" diff --git a/paths/organization_job_templates/destroy.yaml b/paths/organization_job_templates/destroy.yaml index 5e508d1b..0495090a 100644 --- a/paths/organization_job_templates/destroy.yaml +++ b/paths/organization_job_templates/destroy.yaml @@ -31,10 +31,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase organization_job_templates delete \ - --account_id \ - --id \ - --access_token +x-cli-command: organization_job_templates delete x-cli-version: "2.7.0" diff --git a/paths/organization_job_templates/index.yaml b/paths/organization_job_templates/index.yaml index 69371640..e6cba999 100644 --- a/paths/organization_job_templates/index.yaml +++ b/paths/organization_job_templates/index.yaml @@ -45,9 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/job_templates" \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase organization_job_templates list \ - --account_id \ - --access_token +x-cli-command: organization_job_templates list x-cli-version: "2.7.0" diff --git a/paths/organization_job_templates/show.yaml b/paths/organization_job_templates/show.yaml index 918766a3..9e414f5a 100644 --- a/paths/organization_job_templates/show.yaml +++ b/paths/organization_job_templates/show.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/job_templates/:id" \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase organization_job_templates show \ - --account_id \ - --id \ - --access_token +x-cli-command: organization_job_templates show x-cli-version: "2.7.0" diff --git a/paths/organization_job_templates/update.yaml b/paths/organization_job_templates/update.yaml index 361051c6..269461fd 100644 --- a/paths/organization_job_templates/update.yaml +++ b/paths/organization_job_templates/update.yaml @@ -42,12 +42,6 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X PATCH \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase organization_job_templates update \ - --account_id \ - --id \ - --access_token requestBody: required: true content: @@ -70,4 +64,5 @@ requestBody: example: true required: - name +x-cli-command: organization_job_templates update x-cli-version: "2.7.0" diff --git a/paths/projects/create.yaml b/paths/projects/create.yaml index 5d6d0e6b..69b97b6b 100644 --- a/paths/projects/create.yaml +++ b/paths/projects/create.yaml @@ -47,11 +47,6 @@ x-code-samples: -F name=My%20Android%20Project \ -F main_format=yml \ -F shares_translation_memory=true - - lang: CLI v2 - source: |- - phrase projects create \ - --data '{"name": "My Android Project", "main_format":"yml", "shares_translation_memory":true}' \ - --access_token requestBody: required: true content: @@ -207,4 +202,5 @@ requestBody: example: - "angular" - "iOS" +x-cli-command: projects create x-cli-version: "2.6.3" diff --git a/paths/projects/destroy.yaml b/paths/projects/destroy.yaml index 490d0b04..34379813 100644 --- a/paths/projects/destroy.yaml +++ b/paths/projects/destroy.yaml @@ -30,9 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase projects delete \ - --id \ - --access_token +x-cli-command: projects delete x-cli-version: '2.5' diff --git a/paths/projects/index.yaml b/paths/projects/index.yaml index eb1af088..d5589d01 100644 --- a/paths/projects/index.yaml +++ b/paths/projects/index.yaml @@ -79,8 +79,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase projects list \ - --access_token +x-cli-command: projects list x-cli-version: '2.5' diff --git a/paths/projects/show.yaml b/paths/projects/show.yaml index 656e5dab..8f28d569 100644 --- a/paths/projects/show.yaml +++ b/paths/projects/show.yaml @@ -37,9 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase projects show \ - --id \ - --access_token +x-cli-command: projects show x-cli-version: '2.5' diff --git a/paths/projects/update.yaml b/paths/projects/update.yaml index f1161b28..2ac2971f 100644 --- a/paths/projects/update.yaml +++ b/paths/projects/update.yaml @@ -43,12 +43,6 @@ x-code-samples: -F name=My%20Android%20Project \ -F main_format=yml \ -F shares_translation_memory=true - - lang: CLI v2 - source: |- - phrase projects update \ - --id \ - --data '{"name": "My Android Project", "main_format":"yml", "shares_translation_memory":true}' \ - --access_token requestBody: required: true content: @@ -199,4 +193,5 @@ requestBody: description: "(Optional) CLDR plural-rule version used by the project." type: string example: "legacy" +x-cli-command: projects update x-cli-version: "2.6.3" diff --git a/paths/quality_performance_score/index.yaml b/paths/quality_performance_score/index.yaml index fc1faff8..b659d1a7 100644 --- a/paths/quality_performance_score/index.yaml +++ b/paths/quality_performance_score/index.yaml @@ -41,12 +41,6 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -d '{"translation_ids":["translation_id_1", "translation_id_2"]}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase quality_performance_score list \ - --project_id \ - --data '{"translation_ids":["translation_id_1", "translation_id_2"]}' \ - --access_token requestBody: required: true content: @@ -60,4 +54,5 @@ requestBody: items: type: string example: translation_id_1 +x-cli-command: quality_performance_score list x-cli-version: '2.20' diff --git a/paths/release_triggers/create.yaml b/paths/release_triggers/create.yaml index 53c91ff7..4348b9eb 100644 --- a/paths/release_triggers/create.yaml +++ b/paths/release_triggers/create.yaml @@ -81,11 +81,5 @@ x-code-samples: -X POST \ -d '{"cron_schedule":"15 18 * * 1,3","time_zone":"Europe/Berlin","locale_ids":["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],"tags":["android","feature1"],"branch":"my-feature-branch","app_min_version":"1.0.0","app_max_version":"2.0.0"}' \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase release_triggers create \ - --account_id \ - --distribution_id \ - --data '{"cron_schedule":"15 18 * * 1,3","time_zone":"Europe/Berlin","locale_ids":["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],"tags":["android","feature1"],"branch":"my-feature-branch","app_min_version":"1.0.0","app_max_version":"2.0.0"}' \ - --access_token +x-cli-command: release_triggers create x-cli-version: "2.28" diff --git a/paths/release_triggers/destroy.yaml b/paths/release_triggers/destroy.yaml index c737329a..2e17f578 100644 --- a/paths/release_triggers/destroy.yaml +++ b/paths/release_triggers/destroy.yaml @@ -24,11 +24,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/release_triggers/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase release_triggers delete \ - --account_id \ - --distribution_id \ - --id \ - --access_token +x-cli-command: release_triggers destroy x-cli-version: '2.28' diff --git a/paths/release_triggers/index.yaml b/paths/release_triggers/index.yaml index 0c66bd7d..f04592cd 100644 --- a/paths/release_triggers/index.yaml +++ b/paths/release_triggers/index.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/release_triggers" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase release_triggers list \ - --account_id \ - --distribution_id \ - --access_token +x-cli-command: release_triggers list x-cli-version: '2.28' diff --git a/paths/release_triggers/show.yaml b/paths/release_triggers/show.yaml index 18ec4e6c..30f4ed67 100644 --- a/paths/release_triggers/show.yaml +++ b/paths/release_triggers/show.yaml @@ -34,11 +34,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/release_triggers/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase release_triggers show \ - --account_id \ - --distribution_id \ - --id \ - --access_token +x-cli-command: release_triggers show x-cli-version: '2.28' diff --git a/paths/release_triggers/update.yaml b/paths/release_triggers/update.yaml index 5a31f643..8d7877e9 100644 --- a/paths/release_triggers/update.yaml +++ b/paths/release_triggers/update.yaml @@ -81,12 +81,5 @@ x-code-samples: -X PATCH \ -d '{"cron_schedule":"15 18 * * 1,3","time_zone":"Europe/Berlin","locale_ids":["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],"tags":["android","feature1"],"branch":"my-feature-branch","app_min_version":"1.0.0","app_max_version":"2.0.0"}' \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase release_triggers update \ - --account_id \ - --distribution_id \ - --id \ - --data '{"cron_schedule":"15 18 * * 1,3","time_zone":"Europe/Berlin","locale_ids":["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],"tags":["android","feature1"],"branch":"my-feature-branch","app_min_version":"1.0.0","app_max_version":"2.0.0"}' \ - --access_token +x-cli-command: release_triggers update x-cli-version: "2.28" diff --git a/paths/releases/create.yaml b/paths/releases/create.yaml index 2ef022cf..5aea334c 100644 --- a/paths/releases/create.yaml +++ b/paths/releases/create.yaml @@ -43,13 +43,6 @@ x-code-samples: -X POST \ -d '{"description":"My first Release","platforms":["android","ios"],"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase releases create \ - --account_id \ - --distribution_id \ - --data '{"description": "My first Release", "platforms": ["android", "ios"], "branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -98,4 +91,5 @@ requestBody: description: Branch used for release type: string example: my-feature-branch +x-cli-command: releases create x-cli-version: "2.8" diff --git a/paths/releases/destroy.yaml b/paths/releases/destroy.yaml index dfc97be3..5353f059 100644 --- a/paths/releases/destroy.yaml +++ b/paths/releases/destroy.yaml @@ -31,11 +31,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/releases/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase releases delete \ - --account_id \ - --distribution_id \ - --id \ - --access_token +x-cli-command: releases delete x-cli-version: '2.5' diff --git a/paths/releases/index.yaml b/paths/releases/index.yaml index b3cb0447..ba72e3a6 100644 --- a/paths/releases/index.yaml +++ b/paths/releases/index.yaml @@ -46,10 +46,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/releases" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase releases list \ - --account_id \ - --distribution_id \ - --access_token +x-cli-command: releases list x-cli-version: '2.5' diff --git a/paths/releases/publish.yaml b/paths/releases/publish.yaml index a6a6ac7a..14bc3ad2 100644 --- a/paths/releases/publish.yaml +++ b/paths/releases/publish.yaml @@ -42,11 +42,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/releases/:id/publish" \ -u USERNAME_OR_ACCESS_TOKEN \ -X POST -- lang: CLI v2 - source: |- - phrase releases publish \ - --account_id \ - --distribution_id \ - --id \ - --access_token +x-cli-command: releases publish x-cli-version: '2.5' diff --git a/paths/releases/show.yaml b/paths/releases/show.yaml index 4aa70894..fccd0ecf 100644 --- a/paths/releases/show.yaml +++ b/paths/releases/show.yaml @@ -39,11 +39,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/releases/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase releases show \ - --account_id \ - --distribution_id \ - --id \ - --access_token +x-cli-command: releases show x-cli-version: '2.5' diff --git a/paths/releases/update.yaml b/paths/releases/update.yaml index 33ad17c5..ad4780ab 100644 --- a/paths/releases/update.yaml +++ b/paths/releases/update.yaml @@ -44,14 +44,6 @@ x-code-samples: -X PATCH \ -d '{"description":"My first Release","platforms":["android","ios"],"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase releases update \ - --account_id \ - --distribution_id \ - --id \ - --data '{"description": "My first Release", "platforms": "android,ios", "branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -84,4 +76,5 @@ requestBody: description: Branch used for release type: string example: my-feature-branch +x-cli-command: releases update x-cli-version: '2.5' diff --git a/paths/repo_sync_events/index.yaml b/paths/repo_sync_events/index.yaml index 133940fd..996aba41 100644 --- a/paths/repo_sync_events/index.yaml +++ b/paths/repo_sync_events/index.yaml @@ -40,10 +40,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs/56ef78/events"\ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase repo_sync_events list \ - --id \ - --account_id abcd1234 \ - --access_token +x-cli-command: repo_sync_events list x-cli-version: '2.24' diff --git a/paths/repo_sync_events/show.yaml b/paths/repo_sync_events/show.yaml index 0a985209..8d41eb08 100644 --- a/paths/repo_sync_events/show.yaml +++ b/paths/repo_sync_events/show.yaml @@ -34,11 +34,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs/56ef78/events/78dfgj"\ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase repo_sync_events show \ - --id \ - --repo_sync_id \ - --account_id abcd1234 \ - --access_token +x-cli-command: repo_sync_events show x-cli-version: '2.24' diff --git a/paths/repo_syncs/activate.yaml b/paths/repo_syncs/activate.yaml index c3f9fff6..5319cc24 100644 --- a/paths/repo_syncs/activate.yaml +++ b/paths/repo_syncs/activate.yaml @@ -44,9 +44,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase repo_syncs activate \ - --id \ - --access_token +x-cli-command: repo_syncs activate x-cli-version: '2.24' diff --git a/paths/repo_syncs/create.yaml b/paths/repo_syncs/create.yaml index 61d99b28..16a6d0fd 100644 --- a/paths/repo_syncs/create.yaml +++ b/paths/repo_syncs/create.yaml @@ -49,12 +49,6 @@ x-code-samples: "repo_name": "my-org/my-repo", "base_branch": "main" }' -- lang: CLI v2 - source: |- - phrase repo_syncs create \ - --account_id abcd1234 \ - --data '{"project_id":"abcd1234abcd1234abcd1234abcd1234","git_provider":"github","connection_type":"github_app","repo_name":"my-org/my-repo","base_branch":"main"}' \ - --access_token requestBody: required: true content: @@ -126,4 +120,5 @@ requestBody: description: Custom API endpoint URL for self-hosted Git instances. Required when `connection_type` is `self_hosted`. type: string example: https://git.example.com/api/v4 +x-cli-command: repo_syncs create x-cli-version: '2.60' diff --git a/paths/repo_syncs/deactivate.yaml b/paths/repo_syncs/deactivate.yaml index 9e479e62..1b4d7d95 100644 --- a/paths/repo_syncs/deactivate.yaml +++ b/paths/repo_syncs/deactivate.yaml @@ -44,9 +44,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase repo_syncs deactivate \ - --id \ - --access_token +x-cli-command: repo_syncs deactivate x-cli-version: '2.24' diff --git a/paths/repo_syncs/export.yaml b/paths/repo_syncs/export.yaml index 0c22b389..2c0eb79b 100644 --- a/paths/repo_syncs/export.yaml +++ b/paths/repo_syncs/export.yaml @@ -63,9 +63,4 @@ x-code-samples: -X POST \ -H 'Content-Type: application/json' \ -d '{"pr_branch":"my-feature-branch", "branch":"my-strings-branch"}' -- lang: CLI v2 - source: |- - phrase repo_syncs export \ - --id \ - --data '{"pr_branch":"my-feature-branch", "branch":"my-strings-branch"}' \ - --access_token +x-cli-command: repo_syncs export diff --git a/paths/repo_syncs/import.yaml b/paths/repo_syncs/import.yaml index b816cb4d..668610b8 100644 --- a/paths/repo_syncs/import.yaml +++ b/paths/repo_syncs/import.yaml @@ -63,9 +63,4 @@ x-code-samples: -X POST \ -d '{"repository_branch":"my-feature-branch", "branch":"my-strings-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase repo_syncs import \ - --id \ - --data '{"repository_branch":"my-feature-branch", "branch":"my-strings-branch"}' \ - --access_token +x-cli-command: repo_syncs import diff --git a/paths/repo_syncs/index.yaml b/paths/repo_syncs/index.yaml index 767532e1..cfa576ca 100644 --- a/paths/repo_syncs/index.yaml +++ b/paths/repo_syncs/index.yaml @@ -43,9 +43,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs"\ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase repo_syncs list \ - --account_id abcd1234 \ - --access_token +x-cli-command: repo_syncs list x-cli-version: '2.24' diff --git a/paths/repo_syncs/show.yaml b/paths/repo_syncs/show.yaml index 7f047ddd..164abe84 100644 --- a/paths/repo_syncs/show.yaml +++ b/paths/repo_syncs/show.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs/56ef78"\ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase repo_syncs show \ - --id \ - --account_id abcd1234 \ - --access_token +x-cli-command: repo_syncs show x-cli-version: '2.24' diff --git a/paths/reports/locales/index.yaml b/paths/reports/locales/index.yaml index 86c463b7..e0387a79 100644 --- a/paths/reports/locales/index.yaml +++ b/paths/reports/locales/index.yaml @@ -52,11 +52,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/report/locales?locale_codes[]=de&locale_codes[]=en&branch=my-feature-branch" \ -X GET \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase report locales list \ - --project_id \ - --branch my-feature-branch \ - --locale_codes de \ - --access_token +x-cli-command: reports locales_list x-cli-version: "2.13" diff --git a/paths/reports/show.yaml b/paths/reports/show.yaml index 49890d26..b7ec54fb 100644 --- a/paths/reports/show.yaml +++ b/paths/reports/show.yaml @@ -46,10 +46,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/report?branch=my-feature-branch" \ -X GET \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase report show \ - --project_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: reports show x-cli-version: "2.13" diff --git a/paths/screenshot_markers/create.yaml b/paths/screenshot_markers/create.yaml index 79d5c38b..10d2cfe5 100644 --- a/paths/screenshot_markers/create.yaml +++ b/paths/screenshot_markers/create.yaml @@ -43,13 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch", "key_id":"abcd1234abcd1234abcd1234abcd1234","presentation":"{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase screenshot_markers create \ - --project_id \ - --screenshot_id \ - --data '{"branch":"my-feature-branch", "key_id":"abcd1234abcd1234abcd1234abcd1234", "presentation": "{ "x": 100, "y": 100, "w": 100, "h": 100 }"}' \ - --access_token requestBody: required: true content: @@ -75,4 +68,5 @@ requestBody: Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (`x`-axis and `y`-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (`w` and `h` in pixels). type: string example: '{ "x": 100, "y": 100, "w": 100, "h": 100 }' +x-cli-command: screenshot_markers create x-cli-version: '2.5' diff --git a/paths/screenshot_markers/destroy.yaml b/paths/screenshot_markers/destroy.yaml index 58cbcc79..455d8a7e 100644 --- a/paths/screenshot_markers/destroy.yaml +++ b/paths/screenshot_markers/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase screenshot_markers delete \ - --project_id \ - --screenshot_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: screenshot_markers delete x-cli-version: '2.5' diff --git a/paths/screenshot_markers/index.yaml b/paths/screenshot_markers/index.yaml index ab90106d..b37a4331 100644 --- a/paths/screenshot_markers/index.yaml +++ b/paths/screenshot_markers/index.yaml @@ -52,11 +52,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/screenshots/:id/markers?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase screenshot_markers list \ - --project_id \ - --branch my-feature-branch \ - --id \ - --access_token +x-cli-command: screenshot_markers list x-cli-version: '2.5' diff --git a/paths/screenshot_markers/show.yaml b/paths/screenshot_markers/show.yaml index 6576733d..7306f068 100644 --- a/paths/screenshot_markers/show.yaml +++ b/paths/screenshot_markers/show.yaml @@ -45,12 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/screenshots/:screenshot_id/markers/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase screenshot_markers show \ - --project_id \ - --screenshot_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: screenshot_markers show x-cli-version: '2.5' diff --git a/paths/screenshot_markers/update.yaml b/paths/screenshot_markers/update.yaml index caf6ebc8..cee520e6 100644 --- a/paths/screenshot_markers/update.yaml +++ b/paths/screenshot_markers/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch", "key_id":"abcd1234abcd1234abcd1234abcd1234","presentation":"{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase screenshot_markers update \ - --project_id \ - --screenshot_id \ - --data '{"branch":"my-feature-branch", "key_id":"abcd1234abcd1234abcd1234abcd1234", "presentation": "{ "x": 100, "y": 100, "w": 100, "h": 100 }"}' \ - --access_token requestBody: required: true content: @@ -73,4 +66,5 @@ requestBody: Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (`x`-axis and `y`-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (`w` and `h` in pixels). type: string example: '{ "x": 100, "y": 100, "w": 100, "h": 100 }' +x-cli-command: screenshot_markers update x-cli-version: '2.5' diff --git a/paths/screenshots/create.yaml b/paths/screenshots/create.yaml index a7292fc5..284e4792 100644 --- a/paths/screenshots/create.yaml +++ b/paths/screenshots/create.yaml @@ -56,15 +56,6 @@ x-code-samples: -F name=home_screen \ -F description="Main landing page hero section" \ -F filename=@/path/to/home_screen.png -- lang: CLI v2 - source: |- - phrase screenshots create \ - --project_id \ - --branch "my-feature-branch" \ - --name "home_screen" \ - --description "Main landing page hero section" \ - --filename "/path/to/home_screen.png" \ - --access_token requestBody: required: true content: @@ -97,4 +88,5 @@ requestBody: - gif - png x-max-size-mb: 10 +x-cli-command: screenshots create x-cli-version: '2.5' diff --git a/paths/screenshots/destroy.yaml b/paths/screenshots/destroy.yaml index df35b034..6f5bbdab 100644 --- a/paths/screenshots/destroy.yaml +++ b/paths/screenshots/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase screenshots delete \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: screenshots delete x-cli-version: '2.5' diff --git a/paths/screenshots/index.yaml b/paths/screenshots/index.yaml index cffab21a..8f4e9705 100644 --- a/paths/screenshots/index.yaml +++ b/paths/screenshots/index.yaml @@ -57,10 +57,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/screenshots?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase screenshots list \ - --project_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: screenshots list x-cli-version: '2.5' diff --git a/paths/screenshots/show.yaml b/paths/screenshots/show.yaml index ad73d271..921e56f3 100644 --- a/paths/screenshots/show.yaml +++ b/paths/screenshots/show.yaml @@ -44,11 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/screenshots/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase screenshots show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: screenshots show x-cli-version: '2.5' diff --git a/paths/screenshots/update.yaml b/paths/screenshots/update.yaml index df4f3e29..477ed2e4 100644 --- a/paths/screenshots/update.yaml +++ b/paths/screenshots/update.yaml @@ -45,13 +45,6 @@ x-code-samples: -F name=A%20screenshot%20name \ -F description=A%20screenshot%20description \ -F filename=@/path/to/my/screenshot.png -- lang: CLI v2 - source: |- - phrase screenshots update \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch", "name": "A screenshot name", "description": "A screenshot description", "filename":"/path/to/my/screenshot.png"}' \ - --access_token requestBody: required: true content: @@ -77,4 +70,5 @@ requestBody: type: string format: binary example: "/path/to/my/screenshot.png" +x-cli-command: screenshots update x-cli-version: '2.5' diff --git a/paths/search/in_account.yaml b/paths/search/in_account.yaml index 59011542..613502d9 100644 --- a/paths/search/in_account.yaml +++ b/paths/search/in_account.yaml @@ -47,12 +47,6 @@ x-code-samples: -F locale_code=localecode \ -F page=1 \ -F per_page=25 \ -- lang: CLI v2 - source: |- - phrase search in_account \ - --account_id \ - --data '{"q":"keyword","locale_code": "de","page": 1,"per_page": 25}' \ - --access_token requestBody: required: true content: @@ -85,4 +79,5 @@ requestBody: type: string example: - abcd1234abcd1234abcd1234abcd1234 +x-cli-command: search in_account x-cli-version: '2.5' diff --git a/paths/spaces/add_project.yaml b/paths/spaces/add_project.yaml index e6de9d46..5b52bc97 100644 --- a/paths/spaces/add_project.yaml +++ b/paths/spaces/add_project.yaml @@ -32,13 +32,6 @@ x-code-samples: -X POST \ -d '{"id":"a4b3c2d1"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase spaces projects_create \ - --account_id \ - --space_id \ - --data '{"id":"a4b3c2d1"}' \ - --access_token requestBody: required: true content: @@ -53,4 +46,5 @@ requestBody: description: Project ID to add or to the Space type: string example: a4b3c2d1 +x-cli-command: spaces projects_create x-cli-version: '2.5' diff --git a/paths/spaces/create.yaml b/paths/spaces/create.yaml index 468b4833..67c4ce71 100644 --- a/paths/spaces/create.yaml +++ b/paths/spaces/create.yaml @@ -35,12 +35,6 @@ x-code-samples: -X POST \ -d '{"name":"My Android Projects"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase spaces create \ - --account_id \ - --data '{"name": "My Android Projects"}' \ - --access_token requestBody: required: true content: @@ -55,4 +49,5 @@ requestBody: description: Name of the space type: string example: My Android Projects +x-cli-command: spaces create x-cli-version: '2.5' diff --git a/paths/spaces/delete.yaml b/paths/spaces/delete.yaml index 654cd75e..bc14923e 100644 --- a/paths/spaces/delete.yaml +++ b/paths/spaces/delete.yaml @@ -23,10 +23,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/spaces/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase spaces delete \ - --account_id \ - --id \ - --access_token +x-cli-command: spaces delete x-cli-version: '2.5' diff --git a/paths/spaces/index.yaml b/paths/spaces/index.yaml index fca3aa53..328ee318 100644 --- a/paths/spaces/index.yaml +++ b/paths/spaces/index.yaml @@ -40,9 +40,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/spaces" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase spaces list \ - --account_id \ - --access_token +x-cli-command: spaces list x-cli-version: '2.5' diff --git a/paths/spaces/remove_project.yaml b/paths/spaces/remove_project.yaml index 8e2cb20b..bfc8c196 100644 --- a/paths/spaces/remove_project.yaml +++ b/paths/spaces/remove_project.yaml @@ -24,11 +24,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/spaces/:space_id/projects/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase spaces projects_delete \ - --account_id \ - --space_id \ - --id \ - --access_token +x-cli-command: spaces projects_delete x-cli-version: '2.5' diff --git a/paths/spaces/show.yaml b/paths/spaces/show.yaml index 225f6664..f02c381b 100644 --- a/paths/spaces/show.yaml +++ b/paths/spaces/show.yaml @@ -33,10 +33,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/spaces/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase spaces show \ - --account_id \ - --id \ - --access_token +x-cli-command: spaces show x-cli-version: '2.5' diff --git a/paths/spaces/spaces_projects.yaml b/paths/spaces/spaces_projects.yaml index 3c57c748..6097703f 100644 --- a/paths/spaces/spaces_projects.yaml +++ b/paths/spaces/spaces_projects.yaml @@ -41,10 +41,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/spaces/:space_id/projects" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase spaces projects_list \ - --account_id \ - --space_id \ - --access_token +x-cli-command: spaces projects_list x-cli-version: '2.5' diff --git a/paths/spaces/update.yaml b/paths/spaces/update.yaml index 186c0ca7..ea734a9f 100644 --- a/paths/spaces/update.yaml +++ b/paths/spaces/update.yaml @@ -36,13 +36,6 @@ x-code-samples: -X PATCH \ -d '{"name":"My Android Projects"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase spaces update \ - --account_id \ - --id \ - --data '{"name": "My Android Projects"}' \ - --access_token requestBody: required: true content: @@ -55,4 +48,5 @@ requestBody: description: New name of the space type: string example: My Android Projects +x-cli-command: spaces update x-cli-version: '2.5' diff --git a/paths/styleguides/create.yaml b/paths/styleguides/create.yaml index 44b2e275..4bf1a215 100644 --- a/paths/styleguides/create.yaml +++ b/paths/styleguides/create.yaml @@ -40,14 +40,8 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/styleguides" \ -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ - -d '{"title":"Web application style guide","audience":"customer-facing","target_audience":"teenager","grammatical_person":"first_person_singular","vocabulary_type":"technical","business":"We are a travel site that helps customers find the best hotels and flights.","company_branding":"ACME Inc. should never be translated.","formatting":"Never use capital letters","glossary_terms":"Apartment, cabin, loft","grammar_consistency":","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \ + -d '{"title":"Web application style guide","audience":"customer-facing","target_audience":"teenager","grammatical_person":"first_person_singular","vocabulary_type":"technical","business":"We are a travel site that helps customers find the best hotels and flights.","company_branding":"ACME Inc. should never be translated.","formatting":"Never use capital letters","glossary_terms":"Apartment, cabin, loft","grammar_consistency":"Use informal pronouns and consistent present-tense conjugation","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase styleguides create \ - --project_id \ - --data '{"title": "Web application style guide", "audience":"customer-facing", "target_audience":"teenager", "grammatical_person":"first_person_singular", "vocabulary_type":"technical", "business": "We are a travel site that helps customers find the best hotels and flights.", "company_branding": "ACME Inc. should never be translated.", "formatting": "Never use capital letters", "glossary_terms": "Apartment, cabin, loft", "grammar_consistency":", "literal_translation":"Neutral", "overall_tone": "Tone should be fun and light", "samples": "http://www.myexample.com/my/document/path/to/samples.pdf"}' \ - --access_token requestBody: required: true content: @@ -119,7 +113,7 @@ requestBody: grammar_consistency: description: Formal or informal pronouns, consistent conjugation, grammatical gender type: string - example: '' + example: Use informal pronouns and consistent present-tense conjugation literal_translation: description: 'Can be one of: Cultural/Conversational, Literal, Neutral.' type: string @@ -132,4 +126,5 @@ requestBody: description: Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. type: string example: http://www.myexample.com/my/document/path/to/samples.pdf +x-cli-command: style_guides create x-cli-version: '2.5' diff --git a/paths/styleguides/destroy.yaml b/paths/styleguides/destroy.yaml index 3b50cba3..029afc04 100644 --- a/paths/styleguides/destroy.yaml +++ b/paths/styleguides/destroy.yaml @@ -30,10 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/styleguides/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase styleguides delete \ - --project_id \ - --id \ - --access_token +x-cli-command: style_guides delete x-cli-version: '2.5' diff --git a/paths/styleguides/index.yaml b/paths/styleguides/index.yaml index aba9bd46..f73bae09 100644 --- a/paths/styleguides/index.yaml +++ b/paths/styleguides/index.yaml @@ -45,9 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/styleguides" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase styleguides list \ - --project_id \ - --access_token +x-cli-command: style_guides list x-cli-version: '2.5' diff --git a/paths/styleguides/show.yaml b/paths/styleguides/show.yaml index 8d2f8289..983a244e 100644 --- a/paths/styleguides/show.yaml +++ b/paths/styleguides/show.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/styleguides/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase styleguides show \ - --project_id \ - --id \ - --access_token +x-cli-command: style_guides show x-cli-version: '2.5' diff --git a/paths/styleguides/update.yaml b/paths/styleguides/update.yaml index 7ef3c19a..298e3cc7 100644 --- a/paths/styleguides/update.yaml +++ b/paths/styleguides/update.yaml @@ -41,15 +41,8 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/styleguides/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X PATCH \ - -d '{"title":"Web application style guide","audience":"customer-facing","target_audience":"teenager","grammatical_person":"first_person_singular","vocabulary_type":"technical","business":"We are a travel site that helps customers find the best hotels and flights.","company_branding":"ACME Inc. should never be translated.","formatting":"Never use capital letters","glossary_terms":"Apartment, cabin, loft","grammar_consistency":","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \ + -d '{"title":"Web application style guide","audience":"customer-facing","target_audience":"teenager","grammatical_person":"first_person_singular","vocabulary_type":"technical","business":"We are a travel site that helps customers find the best hotels and flights.","company_branding":"ACME Inc. should never be translated.","formatting":"Never use capital letters","glossary_terms":"Apartment, cabin, loft","grammar_consistency":"Use informal pronouns and consistent present-tense conjugation","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase styleguides update \ - --project_id \ - --id \ - --data '{"title": "Web application style guide", "audience":"customer-facing", "target_audience":"teenager", "grammatical_person":"first_person_singular", "vocabulary_type":"technical", "business": "We are a travel site that helps customers find the best hotels and flights.", "company_branding": "ACME Inc. should never be translated.", "formatting": "Never use capital letters", "glossary_terms": "Apartment, cabin, loft", "grammar_consistency":", "literal_translation":"Neutral", "overall_tone": "Tone should be fun and light", "samples": "http://www.myexample.com/my/document/path/to/samples.pdf"}' \ - --access_token requestBody: required: true content: @@ -119,7 +112,7 @@ requestBody: grammar_consistency: description: Formal or informal pronouns, consistent conjugation, grammatical gender type: string - example: '' + example: Use informal pronouns and consistent present-tense conjugation literal_translation: description: 'Can be one of: Cultural/Conversational, Literal, Neutral.' type: string @@ -132,4 +125,5 @@ requestBody: description: Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. type: string example: http://www.myexample.com/my/document/path/to/samples.pdf +x-cli-command: style_guides update x-cli-version: '2.5' diff --git a/paths/tags/create.yaml b/paths/tags/create.yaml index c61c116c..ae19945a 100644 --- a/paths/tags/create.yaml +++ b/paths/tags/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","name":"my-feature"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase tags create \ - --project_id \ - --data '{"branch":"my-feature-branch", "name":"my-feature"}' \ - --access_token requestBody: required: true content: @@ -66,4 +60,5 @@ requestBody: description: Name of the tag type: string example: my-feature +x-cli-command: tags create x-cli-version: '2.5' diff --git a/paths/tags/destroy.yaml b/paths/tags/destroy.yaml index 614ed838..ec827750 100644 --- a/paths/tags/destroy.yaml +++ b/paths/tags/destroy.yaml @@ -38,11 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase tags delete \ - --project_id \ - --name \ - --branch my-feature-branch \ - --access_token +x-cli-command: tags delete x-cli-version: '2.5' diff --git a/paths/tags/index.yaml b/paths/tags/index.yaml index ce5855a4..eb62624d 100644 --- a/paths/tags/index.yaml +++ b/paths/tags/index.yaml @@ -68,10 +68,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/tags?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN - - lang: CLI v2 - source: |- - phrase tags list \ - --project_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: tags list x-cli-version: '2.5' diff --git a/paths/tags/show.yaml b/paths/tags/show.yaml index f54735d2..3704c2bc 100644 --- a/paths/tags/show.yaml +++ b/paths/tags/show.yaml @@ -50,11 +50,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/tags/:name?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase tags show \ - --project_id \ - --name \ - --branch my-feature-branch \ - --access_token +x-cli-command: tags show x-cli-version: '2.5' diff --git a/paths/teams/add_project.yaml b/paths/teams/add_project.yaml index 8adfaacb..aad08e84 100644 --- a/paths/teams/add_project.yaml +++ b/paths/teams/add_project.yaml @@ -32,13 +32,6 @@ x-code-samples: -X POST \ -d '{"id":"a4b3c2d1"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase teams projects_create \ - --account_id \ - --team_id \ - --data '{"id":"a4b3c2d1"}' \ - --access_token requestBody: required: true content: @@ -53,4 +46,5 @@ requestBody: description: Project ID to add to the Team type: string example: a4b3c2d1 +x-cli-command: teams projects_create x-cli-version: '2.5' diff --git a/paths/teams/add_space.yaml b/paths/teams/add_space.yaml index 3c5612cc..cf48860f 100644 --- a/paths/teams/add_space.yaml +++ b/paths/teams/add_space.yaml @@ -32,13 +32,6 @@ x-code-samples: -X POST \ -d '{"id":"a4b3c2d1"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase teams spaces_create \ - --account_id \ - --team_id \ - --data '{"id":"a4b3c2d1"}' \ - --access_token requestBody: required: true content: @@ -53,4 +46,5 @@ requestBody: description: Space ID to add to the Team type: string example: a4b3c2d1 +x-cli-command: teams spaces_create x-cli-version: '2.5' diff --git a/paths/teams/add_user.yaml b/paths/teams/add_user.yaml index b41e8e68..adb2e1d1 100644 --- a/paths/teams/add_user.yaml +++ b/paths/teams/add_user.yaml @@ -32,13 +32,6 @@ x-code-samples: -X POST \ -d '{"id":"a4b3c2d1"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase teams users_create \ - --account_id \ - --team_id \ - --data '{"id":"a4b3c2d1"}' \ - --access_token requestBody: required: true content: @@ -53,4 +46,5 @@ requestBody: description: User ID to add to the Team type: string example: a4b3c2d1 +x-cli-command: teams users_create x-cli-version: '2.5' diff --git a/paths/teams/create.yaml b/paths/teams/create.yaml index c4f19e27..b8aa71e1 100644 --- a/paths/teams/create.yaml +++ b/paths/teams/create.yaml @@ -35,12 +35,6 @@ x-code-samples: -X POST \ -d '{"name":"German Translators"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase teams create \ - --account_id \ - --data '{"name": "German Translators"}' \ - --access_token requestBody: required: true content: @@ -55,4 +49,5 @@ requestBody: description: Name of the team type: string example: German Translators +x-cli-command: teams create x-cli-version: '2.5' diff --git a/paths/teams/delete.yaml b/paths/teams/delete.yaml index ca27a852..22899364 100644 --- a/paths/teams/delete.yaml +++ b/paths/teams/delete.yaml @@ -23,10 +23,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/teams/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase teams delete \ - --account_id \ - --id \ - --access_token +x-cli-command: teams delete x-cli-version: '2.5' diff --git a/paths/teams/index.yaml b/paths/teams/index.yaml index 94e1417b..26ee9a1a 100644 --- a/paths/teams/index.yaml +++ b/paths/teams/index.yaml @@ -40,9 +40,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/teams" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase teams list \ - --account_id \ - --access_token +x-cli-command: teams list x-cli-version: '2.5' diff --git a/paths/teams/remove_project.yaml b/paths/teams/remove_project.yaml index b532b940..0c444f37 100644 --- a/paths/teams/remove_project.yaml +++ b/paths/teams/remove_project.yaml @@ -24,11 +24,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/teams/:team_id/projects/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase teams projects_delete \ - --account_id \ - --team_id \ - --id \ - --access_token +x-cli-command: teams projects_delete x-cli-version: '2.5' diff --git a/paths/teams/remove_space.yaml b/paths/teams/remove_space.yaml index 446a656b..e03ca3fe 100644 --- a/paths/teams/remove_space.yaml +++ b/paths/teams/remove_space.yaml @@ -24,11 +24,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/teams/:team_id/spaces/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase teams spaces_delete \ - --account_id \ - --team_id \ - --id \ - --access_token +x-cli-command: teams spaces_delete x-cli-version: '2.5' diff --git a/paths/teams/remove_user.yaml b/paths/teams/remove_user.yaml index 42c2e566..bb7b7916 100644 --- a/paths/teams/remove_user.yaml +++ b/paths/teams/remove_user.yaml @@ -24,11 +24,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/teams/:team_id/users/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase teams users_delete \ - --account_id \ - --team_id \ - --id \ - --access_token +x-cli-command: teams users_delete x-cli-version: '2.5' diff --git a/paths/teams/show.yaml b/paths/teams/show.yaml index d95992d6..a54f7967 100644 --- a/paths/teams/show.yaml +++ b/paths/teams/show.yaml @@ -33,10 +33,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/teams/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase teams show \ - --account_id \ - --id \ - --access_token +x-cli-command: teams show x-cli-version: '2.5' diff --git a/paths/teams/update.yaml b/paths/teams/update.yaml index f289d325..532692e9 100644 --- a/paths/teams/update.yaml +++ b/paths/teams/update.yaml @@ -36,13 +36,6 @@ x-code-samples: -X PATCH \ -d '{"name":"German Translators"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase teams update \ - --account_id \ - --id \ - --data '{"name": "German Translators"}' \ - --access_token requestBody: required: true content: @@ -55,4 +48,5 @@ requestBody: description: New name of the team type: string example: German Translators +x-cli-command: teams update x-cli-version: '2.5' diff --git a/paths/translations/batch_exclude.yaml b/paths/translations/batch_exclude.yaml index 6623c35a..edc0e993 100644 --- a/paths/translations/batch_exclude.yaml +++ b/paths/translations/batch_exclude.yaml @@ -40,12 +40,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%20verified:true%20tags:feature,center","sort":"updated_at","order":"desc"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations exclude-collection \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'PhraseApp*%20verified:true%20tags:feature,center'", "sort":"updated_at", "order":"desc"}' \ - --access_token requestBody: required: true content: @@ -83,4 +77,5 @@ requestBody: description: 'Order direction. Can be one of: asc, desc.' type: string example: desc +x-cli-command: translations exclude-collection x-cli-version: '2.5' diff --git a/paths/translations/batch_include.yaml b/paths/translations/batch_include.yaml index 1d83f024..44781941 100644 --- a/paths/translations/batch_include.yaml +++ b/paths/translations/batch_include.yaml @@ -40,12 +40,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%20verified:true%20tags:feature,center","sort":"updated_at","order":"desc"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations include-collection \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'PhraseApp*%20verified:true%20tags:feature,center'", "sort":"updated_at", "order":"desc"}' \ - --access_token requestBody: required: true content: @@ -82,4 +76,5 @@ requestBody: description: 'Order direction. Can be one of: asc, desc.' type: string example: desc +x-cli-command: translations include-collection x-cli-version: '2.5' diff --git a/paths/translations/batch_review.yaml b/paths/translations/batch_review.yaml index 39d9a8a1..5ad62aac 100644 --- a/paths/translations/batch_review.yaml +++ b/paths/translations/batch_review.yaml @@ -42,12 +42,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%reviewed:false%20tags:feature,center"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations review-collection \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'PhraseApp*%reviewed:false%20tags:feature,center'"}' \ - --access_token requestBody: required: true content: @@ -77,4 +71,5 @@ requestBody: Find more examples [here](/en/api/strings/usage-examples). type: string example: PhraseApp*%reviewed:false%20tags:feature,center +x-cli-command: translations review-collection x-cli-version: '2.5' diff --git a/paths/translations/batch_unreview.yaml b/paths/translations/batch_unreview.yaml index 62558d80..5240fe12 100644 --- a/paths/translations/batch_unreview.yaml +++ b/paths/translations/batch_unreview.yaml @@ -41,12 +41,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%reviewed:false%20tags:feature,center"}' \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase translations unreview-collection \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'PhraseApp*%reviewed:false%20tags:feature,center'"}' \ - --access_token requestBody: required: true content: @@ -75,4 +69,5 @@ requestBody: Find more examples [here](/en/api/strings/usage-examples). type: string example: PhraseApp*%reviewed:true%20tags:feature,center +x-cli-command: translations unreview-collection x-cli-version: '2.41' diff --git a/paths/translations/batch_unverify.yaml b/paths/translations/batch_unverify.yaml index c33a527b..d021c1a4 100644 --- a/paths/translations/batch_unverify.yaml +++ b/paths/translations/batch_unverify.yaml @@ -42,12 +42,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%20verified:true%20tags:feature,center","sort":"updated_at","order":"desc"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations unverify-collection \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'PhraseApp*%20verified:true%20tags:feature,center'", "sort":"updated_at", "order":"desc"}' \ - --access_token requestBody: required: true content: @@ -84,4 +78,5 @@ requestBody: description: 'Order direction. Can be one of: asc, desc.' type: string example: desc +x-cli-command: translations unverify-collection x-cli-version: '2.5' diff --git a/paths/translations/batch_verify.yaml b/paths/translations/batch_verify.yaml index 8fc68d36..c8538515 100644 --- a/paths/translations/batch_verify.yaml +++ b/paths/translations/batch_verify.yaml @@ -42,12 +42,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%20unverified:true%20tags:feature,center"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations verify-collection \ - --project_id \ - --data '{"branch":"my-feature-branch", "q":"'PhraseApp*%20unverified:true%20tags:feature,center'"}' \ - --access_token requestBody: required: true content: @@ -80,4 +74,5 @@ requestBody: Find more examples [here](/en/api/strings/usage-examples). type: string example: PhraseApp*%20unverified:true%20tags:feature,center +x-cli-command: translations verify-collection x-cli-version: '2.5' diff --git a/paths/translations/create.yaml b/paths/translations/create.yaml index cd62cdce..1e7bc465 100644 --- a/paths/translations/create.yaml +++ b/paths/translations/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","key_id":"abcd1234cdef1234abcd1234cdef1234","content":"My translation"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations create \ - --project_id \ - --data '{"branch":"my-feature-branch", "locale_id":"abcd1234cdef1234abcd1234cdef1234", "key_id":"abcd1234cdef1234abcd1234cdef1234", "content": "My translation"}' \ - --access_token requestBody: required: true content: @@ -98,4 +92,5 @@ requestBody: When `true` and the project's review workflow is enabled, the translation is created in the `reviewed` state. type: boolean example: false +x-cli-command: translations create x-cli-version: '2.5' diff --git a/paths/translations/exclude.yaml b/paths/translations/exclude.yaml index 752958dc..71a77b3c 100644 --- a/paths/translations/exclude.yaml +++ b/paths/translations/exclude.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations exclude \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: translations exclude x-cli-version: '2.5' diff --git a/paths/translations/include.yaml b/paths/translations/include.yaml index 99477bd8..e34034b1 100644 --- a/paths/translations/include.yaml +++ b/paths/translations/include.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations include \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: translations include x-cli-version: '2.5' diff --git a/paths/translations/index.yaml b/paths/translations/index.yaml index e3eccfc6..8befee50 100644 --- a/paths/translations/index.yaml +++ b/paths/translations/index.yaml @@ -100,13 +100,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/translations?branch=my-feature-branch&sort=updated_at&order=desc&q=PhraseApp*%2520unverified:true%2520excluded:true%2520tags:feature,center" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase translations list \ - --project_id \ - --branch my-feature-branch \ - --sort updated_at \ - --order desc \ - --query 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' \ - --access_token +x-cli-command: translations list x-cli-version: '2.6.4' diff --git a/paths/translations/index_keys.yaml b/paths/translations/index_keys.yaml index 1828c246..0c455731 100644 --- a/paths/translations/index_keys.yaml +++ b/paths/translations/index_keys.yaml @@ -81,14 +81,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/translations?branch=my-feature-branch&sort=updated_at&order=desc&q=PhraseApp*%2520unverified:true%2520excluded:true%2520tags:feature,center" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase translations by_key \ - --project_id \ - --key_id \ - --branch my-feature-branch \ - --sort updated_at \ - --order desc \ - --query 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' \ - --access_token +x-cli-command: translations by_key x-cli-version: '2.5' diff --git a/paths/translations/index_locale.yaml b/paths/translations/index_locale.yaml index dbc7d821..98b39426 100644 --- a/paths/translations/index_locale.yaml +++ b/paths/translations/index_locale.yaml @@ -83,14 +83,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/locales/:locale_id/translations?branch=my-feature-branch&sort=updated_at&order=desc&q=PhraseApp*%2520unverified:true%2520excluded:true%2520tags:feature,center" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase translations by_locale \ - --project_id \ - --locale_id \ - --branch my-feature-branch \ - --sort updated_at \ - --order desc \ - --query 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' \ - --access_token +x-cli-command: translations by_locale x-cli-version: '2.5' diff --git a/paths/translations/review.yaml b/paths/translations/review.yaml index f84f819c..0b636495 100644 --- a/paths/translations/review.yaml +++ b/paths/translations/review.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations review \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: translations review x-cli-version: '2.5' diff --git a/paths/translations/search.yaml b/paths/translations/search.yaml index 3a589237..8739a157 100644 --- a/paths/translations/search.yaml +++ b/paths/translations/search.yaml @@ -46,12 +46,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","sort":"updated_at","order":"desc","q":"PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations search \ - --project_id \ - --data '{"branch":"my-feature-branch", "sort":"updated_at", "order":"desc", "q":"'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center'"}' \ - --access_token requestBody: required: true content: @@ -89,4 +83,5 @@ requestBody: Find more examples [here](/en/api/strings/usage-examples). type: string example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center +x-cli-command: translations search x-cli-version: '2.5' diff --git a/paths/translations/show.yaml b/paths/translations/show.yaml index b75e7884..23168225 100644 --- a/paths/translations/show.yaml +++ b/paths/translations/show.yaml @@ -44,11 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/translations/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase translations show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: translations show x-cli-version: '2.5' diff --git a/paths/translations/unreview.yaml b/paths/translations/unreview.yaml index d32cf8bd..5674419f 100644 --- a/paths/translations/unreview.yaml +++ b/paths/translations/unreview.yaml @@ -42,13 +42,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' - - lang: CLI v2 - source: |- - phrase translations unreview \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -61,4 +54,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: translations unreview x-cli-version: '2.41' diff --git a/paths/translations/unverify.yaml b/paths/translations/unverify.yaml index 3ccaf3a4..6d44eebe 100644 --- a/paths/translations/unverify.yaml +++ b/paths/translations/unverify.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations unverify \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: translations unverify x-cli-version: '2.5' diff --git a/paths/translations/update.yaml b/paths/translations/update.yaml index 57b2a581..ede214b5 100644 --- a/paths/translations/update.yaml +++ b/paths/translations/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","content":"My translation"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations update \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch", "content": "My translation"}' \ - --access_token requestBody: required: true content: @@ -91,4 +84,5 @@ requestBody: When `true`, the update is treated as a minor edit and does not trigger downstream re-verification on the linked locales' translations. type: boolean example: false +x-cli-command: translations update x-cli-version: '2.5' diff --git a/paths/translations/verify.yaml b/paths/translations/verify.yaml index fa92e6a0..1ff3d95f 100644 --- a/paths/translations/verify.yaml +++ b/paths/translations/verify.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase translations verify \ - --project_id \ - --id \ - --data '{"branch":"my-feature-branch"}' \ - --access_token requestBody: required: true content: @@ -62,4 +55,5 @@ requestBody: description: specify the branch to use type: string example: my-feature-branch +x-cli-command: translations verify x-cli-version: '2.5' diff --git a/paths/upload_batches/create.yaml b/paths/upload_batches/create.yaml index caee266a..cf9d337a 100644 --- a/paths/upload_batches/create.yaml +++ b/paths/upload_batches/create.yaml @@ -76,15 +76,4 @@ x-code-samples: ] }' \ -u : - - lang: CLI v2 - source: |- - phrase upload_batches create --project-id :project_id \ - --data '{ - "branch": "my-feature-branch", - "delete_unmentioned_keys": true, - "upload_ids": [ - "abcd1234cdef1234abcd1234cdef1234", - "bcde2345defg2345bcde2345defg2345" - ] - }' \ - --access_token +x-cli-command: upload_batches create diff --git a/paths/uploads/create.yaml b/paths/uploads/create.yaml index d1f4ca81..e0dc1067 100644 --- a/paths/uploads/create.yaml +++ b/paths/uploads/create.yaml @@ -49,18 +49,6 @@ x-code-samples: -F tags=awesome-feature,needs-proofreading \ -F locale_mapping[en]=2 \ -F format_options[foo]=bar - - lang: CLI v2 - source: |- - phrase uploads create \ - --project_id \ - --branch my-feature-branch \ - --file /path/to/my/file.json \ - --file_format json \ - --locale_id abcd1234cdef1234abcd1234cdef1234 \ - --tags awesome-feature,needs-proofreading \ - --locale_mapping '{"en": "2"}' \ - --format_options '{"foo": "bar"}' \ - --access_token requestBody: required: true content: @@ -176,4 +164,5 @@ requestBody: type: boolean default: false example: false +x-cli-command: uploads create x-cli-version: '2.12' diff --git a/paths/uploads/index.yaml b/paths/uploads/index.yaml index 2f08d34f..1c113414 100644 --- a/paths/uploads/index.yaml +++ b/paths/uploads/index.yaml @@ -51,10 +51,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/uploads?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase uploads list \ - --project_id \ - --branch my-feature-branch \ - --access_token +x-cli-command: uploads list x-cli-version: '2.5' diff --git a/paths/uploads/show.yaml b/paths/uploads/show.yaml index 61495e98..9a2feea9 100644 --- a/paths/uploads/show.yaml +++ b/paths/uploads/show.yaml @@ -44,11 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/uploads/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase uploads show \ - --project_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: uploads show x-cli-version: '2.5' diff --git a/paths/users/user.yaml b/paths/users/user.yaml index e8fe4508..b5c81a53 100644 --- a/paths/users/user.yaml +++ b/paths/users/user.yaml @@ -36,8 +36,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/user" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase shows user \ - --access_token +x-cli-command: users user x-cli-version: '2.5' diff --git a/paths/variables/create.yaml b/paths/variables/create.yaml index f88bbefb..6e2f553d 100644 --- a/paths/variables/create.yaml +++ b/paths/variables/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"name":"MY_VARIABLE","value":"Hello World"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase variables create \ - --project_id \ - --data '{"name":"MY_VARIABLE", "value":"Hello World"}' \ - --access_token requestBody: required: true content: @@ -66,4 +60,5 @@ requestBody: description: Value of the variable type: string example: Hello World +x-cli-command: variables create x-cli-version: '2.5' diff --git a/paths/variables/destroy.yaml b/paths/variables/destroy.yaml index aa3772c9..1b7c1e01 100644 --- a/paths/variables/destroy.yaml +++ b/paths/variables/destroy.yaml @@ -30,10 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/variables/:name" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase variables delete \ - --project_id \ - --name \ - --access_token +x-cli-command: variables delete x-cli-version: '2.5' diff --git a/paths/variables/index.yaml b/paths/variables/index.yaml index 638d62ad..b72c3526 100644 --- a/paths/variables/index.yaml +++ b/paths/variables/index.yaml @@ -45,9 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/variables" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase variables list \ - --project_id \ - --access_token +x-cli-command: variables list x-cli-version: '2.5' diff --git a/paths/variables/show.yaml b/paths/variables/show.yaml index 9c3be817..6234e4ae 100644 --- a/paths/variables/show.yaml +++ b/paths/variables/show.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/variables/:name" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase variables show \ - --project_id \ - --name \ - --access_token +x-cli-command: variables show x-cli-version: '2.5' diff --git a/paths/variables/update.yaml b/paths/variables/update.yaml index d7ebdd78..1c2fe112 100644 --- a/paths/variables/update.yaml +++ b/paths/variables/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"name":"MY_VARIABLE","value":"Hello World"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase variables update \ - --project_id \ - --name \ - --data '{"name":"MY_VARIABLE","value":"Hello World"}' \ - --access_token requestBody: required: true content: @@ -66,4 +59,5 @@ requestBody: description: Value of the variable type: string example: Hello World +x-cli-command: variables update x-cli-version: '2.5' diff --git a/paths/versions/index.yaml b/paths/versions/index.yaml index 9e88a18c..2d50f8ab 100644 --- a/paths/versions/index.yaml +++ b/paths/versions/index.yaml @@ -59,12 +59,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/translations/:translation_id/versions?branch=my-feature-branch&only_content_updates=true" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase versions list \ - --project_id \ - --translation_id \ - --branch my-feature-branch \ - --only_content_updates true \ - --access_token +x-cli-command: versions_history list x-cli-version: '2.5' diff --git a/paths/versions/show.yaml b/paths/versions/show.yaml index ddb84731..5167350c 100644 --- a/paths/versions/show.yaml +++ b/paths/versions/show.yaml @@ -45,12 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/translations/:translation_id/versions/:id?branch=my-feature-branch" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase versions show \ - --project_id \ - --translation_id \ - --id \ - --branch my-feature-branch \ - --access_token +x-cli-command: versions_history show x-cli-version: '2.5' diff --git a/paths/webhook_deliveries/index.yaml b/paths/webhook_deliveries/index.yaml index 55d0794b..f399ff86 100644 --- a/paths/webhook_deliveries/index.yaml +++ b/paths/webhook_deliveries/index.yaml @@ -40,10 +40,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:webhook_id/deliveries?response_status_codes=401%2C404" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase webhooks list \ - --project_id \ - --webhook_id \ - --access_token +x-cli-command: webhook_deliveries list x-cli-version: '2.5' diff --git a/paths/webhook_deliveries/redeliver.yaml b/paths/webhook_deliveries/redeliver.yaml index b2c32202..8effaf69 100644 --- a/paths/webhook_deliveries/redeliver.yaml +++ b/paths/webhook_deliveries/redeliver.yaml @@ -38,11 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:webhook_id/deliveries/:id/redeliver" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase webhook deliveries show \ - --project_id \ - --webhook_id \ - --id \ - --access_token +x-cli-command: webhook_deliveries redeliver x-cli-version: '2.5' diff --git a/paths/webhook_deliveries/show.yaml b/paths/webhook_deliveries/show.yaml index 7f85828e..85d4ccfa 100644 --- a/paths/webhook_deliveries/show.yaml +++ b/paths/webhook_deliveries/show.yaml @@ -36,11 +36,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:webhook_id/deliveries/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase webhook deliveries show \ - --project_id \ - --webhook_id \ - --id \ - --access_token +x-cli-command: webhook_deliveries show x-cli-version: '2.5' diff --git a/paths/webhooks/create.yaml b/paths/webhooks/create.yaml index 7b78b0a5..6939f87a 100644 --- a/paths/webhooks/create.yaml +++ b/paths/webhooks/create.yaml @@ -42,12 +42,6 @@ x-code-samples: -X POST \ -d '{"callback_url":"http://example.com/hooks/phraseapp-notifications","description":"My webhook for chat notifications","events":"locales:create,translations:update"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase webhooks create \ - --project_id \ - --data '{"callback_url": "http://example.com/hooks/phraseapp-notifications", "description": "My webhook for chat notifications", "events": "locales:create,translations:update"}' \ - --access_token requestBody: required: true content: @@ -82,4 +76,5 @@ requestBody: description: If enabled, webhook will also be triggered for events from branches of the project specified. type: boolean example: +x-cli-command: webhooks create x-cli-version: '2.5' diff --git a/paths/webhooks/destroy.yaml b/paths/webhooks/destroy.yaml index 9a73687e..3dd10b32 100644 --- a/paths/webhooks/destroy.yaml +++ b/paths/webhooks/destroy.yaml @@ -30,10 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- lang: CLI v2 - source: |- - phrase webhooks delete \ - --project_id \ - --id \ - --access_token +x-cli-command: webhooks delete x-cli-version: '2.5' diff --git a/paths/webhooks/index.yaml b/paths/webhooks/index.yaml index 8ad7694e..a85470c1 100644 --- a/paths/webhooks/index.yaml +++ b/paths/webhooks/index.yaml @@ -45,9 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/webhooks" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase webhooks list \ - --project_id \ - --access_token +x-cli-command: webhooks list x-cli-version: '2.5' diff --git a/paths/webhooks/show.yaml b/paths/webhooks/show.yaml index ee2416de..4a06f972 100644 --- a/paths/webhooks/show.yaml +++ b/paths/webhooks/show.yaml @@ -38,10 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- lang: CLI v2 - source: |- - phrase webhooks show \ - --project_id \ - --id \ - --access_token +x-cli-command: webhooks show x-cli-version: '2.5' diff --git a/paths/webhooks/test.yaml b/paths/webhooks/test.yaml index d94f3c06..7b655b37 100644 --- a/paths/webhooks/test.yaml +++ b/paths/webhooks/test.yaml @@ -42,10 +42,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:id/test" \ -u USERNAME_OR_ACCESS_TOKEN \ -X POST -- lang: CLI v2 - source: |- - phrase webhooks test \ - --project_id \ - --id \ - --access_token +x-cli-command: webhooks test x-cli-version: '2.5' diff --git a/paths/webhooks/update.yaml b/paths/webhooks/update.yaml index f415434c..b9561619 100644 --- a/paths/webhooks/update.yaml +++ b/paths/webhooks/update.yaml @@ -43,13 +43,6 @@ x-code-samples: -X PATCH \ -d '{"callback_url":"http://example.com/hooks/phraseapp-notifications","description":"My webhook for chat notifications","events":"locales:create,translations:update"}' \ -H 'Content-Type: application/json' -- lang: CLI v2 - source: |- - phrase webhooks update \ - --project_id \ - --id \ - --data '{"callback_url": "http://example.com/hooks/phraseapp-notifications", "description": "My webhook for chat notifications", "events": "locales:create,translations:update"}' \ - --access_token requestBody: required: true content: @@ -82,4 +75,5 @@ requestBody: description: If enabled, webhook will also be triggered for events from branches of the project specified. type: boolean example: +x-cli-command: webhooks update x-cli-version: '2.5' diff --git a/scripts/inject-cli-examples.js b/scripts/inject-cli-examples.js new file mode 100644 index 00000000..a13c465a --- /dev/null +++ b/scripts/inject-cli-examples.js @@ -0,0 +1,59 @@ +#!/usr/bin/env node +'use strict'; + +// Inject generated CLI v2 code samples into a compiled OpenAPI bundle. +// +// Path files no longer carry the CLI v2 x-code-sample; it is generated into +// examples/cli.yaml (keyed by operationId) by the cli_examples.handlebars +// template during `make cli`, and appended to each operation's x-code-samples +// here, after bundling. Supports both JSON and YAML bundles. +// +// Usage: node scripts/inject-cli-examples.js [...] + +const fs = require('fs'); +const path = require('path'); +const yaml = require('js-yaml'); + +const EXAMPLES = path.join(__dirname, '..', 'examples', 'cli.yaml'); +const HTTP_METHODS = ['get', 'post', 'put', 'patch', 'delete', 'options', 'head']; + +function main() { + const targets = process.argv.slice(2); + if (targets.length === 0) { + console.error('usage: inject-cli-examples.js [...]'); + process.exit(1); + } + + const examples = yaml.load(fs.readFileSync(EXAMPLES, 'utf8')) || {}; + + for (const file of targets) { + const isJson = file.endsWith('.json'); + const raw = fs.readFileSync(file, 'utf8'); + const doc = isJson ? JSON.parse(raw) : yaml.load(raw); + + let injected = 0; + let missing = 0; + for (const item of Object.values(doc.paths || {})) { + for (const method of HTTP_METHODS) { + const op = item[method]; + if (!op || !op.operationId) continue; + const ex = examples[op.operationId]; + if (!ex) { missing++; continue; } + + const samples = (op['x-code-samples'] = op['x-code-samples'] || []); + // replace an existing CLI v2 entry if present, else append + const i = samples.findIndex((s) => s && s.lang === ex.lang); + if (i >= 0) samples[i] = ex; else samples.push(ex); + injected++; + } + } + + const out = isJson + ? JSON.stringify(doc, null, 2) + '\n' + : yaml.dump(doc, { lineWidth: 300, noRefs: true }); + fs.writeFileSync(file, out); + console.error(`${file}: injected ${injected}, no example for ${missing}`); + } +} + +main();