From 723b4d4d6e4706d114cb2bcc32f962616e306a43 Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Fri, 26 Jun 2026 13:50:21 +0200 Subject: [PATCH 1/8] docs(CLI): generate CLI v2 code samples from the spec Auto-generate the `CLI v2` x-code-samples for every endpoint instead of maintaining them by hand. A new handlebars supporting-file template (cli_examples.handlebars) emits examples/cli.yaml during `make cli`, and each path file references its example via a $ref into that file, which the bundler inlines into doc/compiled.json. - Add cli_examples.handlebars + files: wiring in cli_lang.yaml - Add x-cli-command to every path file (the noun+subcommand the template cannot derive, since handlebars lacks snake_case/split helpers) - Replace inline CLI v2 samples with $ref to examples/cli.yaml - Fix spec example bugs surfaced along the way: - distributions format_options: malformed JSON example -> proper object - styleguides grammar_consistency: empty example (also broke the Curl sample) -> real example - Document generator/template gotchas in templates/TEMPLATING.md The generated examples reflect the real CLI (correct command names, complete flag coverage) and fix numerous stale/incorrect hand-written samples. Co-Authored-By: Claude Opus 4.8 (1M context) --- doc/compiled.json | 907 ++++--- examples/cli.yaml | 2385 +++++++++++++++++ openapi-generator/cli_lang.yaml | 4 + openapi-generator/templates/TEMPLATING.md | 205 ++ .../templates/cli/cli_examples.handlebars | 8 + paths/accounts/index.yaml | 6 +- paths/accounts/locales.yaml | 7 +- paths/accounts/show.yaml | 7 +- paths/authorizations/create.yaml | 6 +- paths/authorizations/destroy.yaml | 6 +- paths/authorizations/index.yaml | 4 +- paths/authorizations/show.yaml | 6 +- paths/authorizations/update.yaml | 7 +- paths/automations/activate.yaml | 8 +- paths/automations/create.yaml | 8 +- paths/automations/deactivate.yaml | 8 +- paths/automations/destroy.yaml | 8 +- paths/automations/index.yaml | 9 +- paths/automations/show.yaml | 8 +- paths/automations/trigger.yaml | 8 +- paths/automations/update.yaml | 9 +- paths/blacklisted_keys/create.yaml | 8 +- paths/blacklisted_keys/destroy.yaml | 8 +- paths/blacklisted_keys/index.yaml | 7 +- paths/blacklisted_keys/show.yaml | 8 +- paths/blacklisted_keys/update.yaml | 9 +- paths/branches/compare.yaml | 9 +- paths/branches/create.yaml | 8 +- paths/branches/create_comparison.yaml | 9 +- paths/branches/destroy.yaml | 8 +- paths/branches/index.yaml | 7 +- paths/branches/merge.yaml | 10 +- paths/branches/show.yaml | 8 +- paths/branches/sync.yaml | 10 +- paths/branches/update.yaml | 9 +- paths/comment_reactions/create.yaml | 10 +- paths/comment_reactions/destroy.yaml | 11 +- paths/comment_reactions/index.yaml | 10 +- paths/comment_reactions/show.yaml | 11 +- paths/comment_replies/create.yaml | 10 +- paths/comment_replies/destroy.yaml | 11 +- paths/comment_replies/index.yaml | 13 +- paths/comment_replies/mark_as_read.yaml | 11 +- paths/comment_replies/mark_as_unread.yaml | 11 +- paths/comment_replies/show.yaml | 11 +- paths/comments/check_if_read.yaml | 10 +- paths/comments/create.yaml | 9 +- paths/comments/destroy.yaml | 10 +- paths/comments/index.yaml | 13 +- paths/comments/mark_as_read.yaml | 10 +- paths/comments/show.yaml | 10 +- paths/comments/unmark_as_read.yaml | 10 +- paths/comments/update.yaml | 10 +- paths/custom_metadata_properties/create.yaml | 8 +- paths/custom_metadata_properties/destroy.yaml | 8 +- paths/custom_metadata_properties/index.yaml | 13 +- paths/custom_metadata_properties/show.yaml | 8 +- paths/custom_metadata_properties/update.yaml | 9 +- paths/distributions/create.yaml | 11 +- paths/distributions/destroy.yaml | 8 +- paths/distributions/index.yaml | 7 +- paths/distributions/show.yaml | 8 +- paths/distributions/update.yaml | 12 +- paths/documents/destroy.yaml | 8 +- paths/documents/index.yaml | 7 +- paths/figma_attachment_keys/create.yaml | 10 +- paths/figma_attachment_keys/destroy.yaml | 10 +- paths/figma_attachments/create.yaml | 8 +- paths/figma_attachments/destroy.yaml | 9 +- paths/figma_attachments/index.yaml | 8 +- paths/figma_attachments/show.yaml | 9 +- paths/figma_attachments/update.yaml | 9 +- paths/formats/index.yaml | 6 +- paths/glossaries/create.yaml | 8 +- paths/glossaries/destroy.yaml | 8 +- paths/glossaries/index.yaml | 7 +- paths/glossaries/show.yaml | 8 +- paths/glossaries/update.yaml | 9 +- paths/glossary_term_translations/create.yaml | 10 +- paths/glossary_term_translations/destroy.yaml | 10 +- paths/glossary_term_translations/update.yaml | 11 +- paths/glossary_terms/create.yaml | 9 +- paths/glossary_terms/destroy.yaml | 9 +- paths/glossary_terms/index.yaml | 8 +- paths/glossary_terms/show.yaml | 9 +- paths/glossary_terms/update.yaml | 10 +- paths/icu/skeleton.yaml | 7 +- paths/invitations/create.yaml | 8 +- paths/invitations/destroy.yaml | 8 +- paths/invitations/index.yaml | 7 +- paths/invitations/resend.yaml | 8 +- paths/invitations/show.yaml | 8 +- paths/invitations/update.yaml | 9 +- paths/invitations/update_settings.yaml | 9 +- paths/job_annotations/destroy.yaml | 9 +- paths/job_annotations/index.yaml | 8 +- paths/job_annotations/update.yaml | 10 +- paths/job_comments/create.yaml | 9 +- paths/job_comments/destroy.yaml | 10 +- paths/job_comments/index.yaml | 10 +- paths/job_comments/show.yaml | 10 +- paths/job_comments/update.yaml | 10 +- paths/job_locale_annotations/destroy.yaml | 10 +- paths/job_locale_annotations/index.yaml | 9 +- paths/job_locale_annotations/update.yaml | 11 +- paths/job_locales/complete.yaml | 10 +- paths/job_locales/complete_review.yaml | 10 +- paths/job_locales/create.yaml | 9 +- paths/job_locales/destroy.yaml | 10 +- paths/job_locales/index.yaml | 9 +- paths/job_locales/reopen.yaml | 10 +- paths/job_locales/show.yaml | 10 +- paths/job_locales/update.yaml | 10 +- paths/job_template_locales/create.yaml | 9 +- paths/job_template_locales/destroy.yaml | 10 +- paths/job_template_locales/index.yaml | 9 +- paths/job_template_locales/show.yaml | 10 +- paths/job_template_locales/update.yaml | 10 +- paths/job_templates/create.yaml | 8 +- paths/job_templates/destroy.yaml | 9 +- paths/job_templates/index.yaml | 8 +- paths/job_templates/show.yaml | 9 +- paths/job_templates/update.yaml | 9 +- paths/jobs/add_keys.yaml | 9 +- paths/jobs/complete.yaml | 9 +- paths/jobs/create.yaml | 8 +- paths/jobs/destroy.yaml | 9 +- paths/jobs/index.yaml | 11 +- paths/jobs/index_account.yaml | 10 +- paths/jobs/lock.yaml | 9 +- paths/jobs/remove_keys.yaml | 11 +- paths/jobs/reopen.yaml | 9 +- paths/jobs/show.yaml | 9 +- paths/jobs/start.yaml | 9 +- paths/jobs/unlock.yaml | 9 +- paths/jobs/update.yaml | 9 +- paths/key_links/batch_destroy.yaml | 2 + paths/key_links/create.yaml | 2 + paths/key_links/destroy.yaml | 2 + paths/key_links/index.yaml | 2 + paths/keys/create.yaml | 8 +- paths/keys/destroy-collection.yaml | 10 +- paths/keys/destroy.yaml | 9 +- paths/keys/exclude.yaml | 8 +- paths/keys/include.yaml | 8 +- paths/keys/index.yaml | 12 +- paths/keys/search.yaml | 8 +- paths/keys/show.yaml | 9 +- paths/keys/tag.yaml | 8 +- paths/keys/untag.yaml | 8 +- paths/keys/update.yaml | 9 +- paths/locale_downloads/create.yaml | 11 +- paths/locale_downloads/show.yaml | 9 +- paths/locales/create.yaml | 8 +- paths/locales/destroy.yaml | 9 +- paths/locales/download.yaml | 12 +- paths/locales/index.yaml | 8 +- paths/locales/show.yaml | 9 +- paths/locales/update.yaml | 9 +- paths/members/destroy.yaml | 8 +- paths/members/index.yaml | 7 +- paths/members/show.yaml | 8 +- paths/members/update.yaml | 9 +- paths/members/update_settings.yaml | 9 +- paths/notification_groups/index.yaml | 6 +- .../notification_groups/mark_all_as_read.yaml | 6 +- paths/notification_groups/mark_as_read.yaml | 7 +- paths/notifications/index.yaml | 6 +- paths/notifications/mark_all_as_read.yaml | 6 +- paths/notifications/show.yaml | 7 +- paths/orders/confirm.yaml | 9 +- paths/orders/create.yaml | 8 +- paths/orders/destroy.yaml | 9 +- paths/orders/index.yaml | 8 +- paths/orders/show.yaml | 9 +- .../create.yaml | 9 +- .../destroy.yaml | 9 +- .../index.yaml | 8 +- .../show.yaml | 9 +- .../update.yaml | 10 +- paths/organization_job_templates/create.yaml | 8 +- paths/organization_job_templates/destroy.yaml | 8 +- paths/organization_job_templates/index.yaml | 7 +- paths/organization_job_templates/show.yaml | 8 +- paths/organization_job_templates/update.yaml | 8 +- paths/projects/create.yaml | 7 +- paths/projects/destroy.yaml | 7 +- paths/projects/index.yaml | 6 +- paths/projects/show.yaml | 7 +- paths/projects/update.yaml | 8 +- paths/quality_performance_score/index.yaml | 8 +- paths/release_triggers/create.yaml | 9 +- paths/release_triggers/destroy.yaml | 9 +- paths/release_triggers/index.yaml | 8 +- paths/release_triggers/show.yaml | 9 +- paths/release_triggers/update.yaml | 10 +- paths/releases/create.yaml | 9 +- paths/releases/destroy.yaml | 9 +- paths/releases/index.yaml | 8 +- paths/releases/publish.yaml | 9 +- paths/releases/show.yaml | 9 +- paths/releases/update.yaml | 10 +- paths/repo_sync_events/index.yaml | 8 +- paths/repo_sync_events/show.yaml | 9 +- paths/repo_syncs/activate.yaml | 7 +- paths/repo_syncs/create.yaml | 8 +- paths/repo_syncs/deactivate.yaml | 7 +- paths/repo_syncs/export.yaml | 8 +- paths/repo_syncs/import.yaml | 8 +- paths/repo_syncs/index.yaml | 7 +- paths/repo_syncs/show.yaml | 8 +- paths/reports/locales/index.yaml | 9 +- paths/reports/show.yaml | 8 +- paths/screenshot_markers/create.yaml | 9 +- paths/screenshot_markers/destroy.yaml | 9 +- paths/screenshot_markers/index.yaml | 9 +- paths/screenshot_markers/show.yaml | 10 +- paths/screenshot_markers/update.yaml | 9 +- paths/screenshots/create.yaml | 11 +- paths/screenshots/destroy.yaml | 9 +- paths/screenshots/index.yaml | 8 +- paths/screenshots/show.yaml | 9 +- paths/screenshots/update.yaml | 9 +- paths/search/in_account.yaml | 8 +- paths/spaces/add_project.yaml | 9 +- paths/spaces/create.yaml | 8 +- paths/spaces/delete.yaml | 8 +- paths/spaces/index.yaml | 7 +- paths/spaces/remove_project.yaml | 9 +- paths/spaces/show.yaml | 8 +- paths/spaces/spaces_projects.yaml | 8 +- paths/spaces/update.yaml | 9 +- paths/styleguides/create.yaml | 12 +- paths/styleguides/destroy.yaml | 8 +- paths/styleguides/index.yaml | 7 +- paths/styleguides/show.yaml | 8 +- paths/styleguides/update.yaml | 13 +- paths/tags/create.yaml | 8 +- paths/tags/destroy.yaml | 9 +- paths/tags/index.yaml | 8 +- paths/tags/show.yaml | 9 +- paths/teams/add_project.yaml | 9 +- paths/teams/add_space.yaml | 9 +- paths/teams/add_user.yaml | 9 +- paths/teams/create.yaml | 8 +- paths/teams/delete.yaml | 8 +- paths/teams/index.yaml | 7 +- paths/teams/remove_project.yaml | 9 +- paths/teams/remove_space.yaml | 9 +- paths/teams/remove_user.yaml | 9 +- paths/teams/show.yaml | 8 +- paths/teams/update.yaml | 9 +- paths/translations/batch_exclude.yaml | 8 +- paths/translations/batch_include.yaml | 8 +- paths/translations/batch_review.yaml | 8 +- paths/translations/batch_unreview.yaml | 8 +- paths/translations/batch_unverify.yaml | 8 +- paths/translations/batch_verify.yaml | 8 +- paths/translations/create.yaml | 8 +- paths/translations/exclude.yaml | 9 +- paths/translations/include.yaml | 9 +- paths/translations/index.yaml | 11 +- paths/translations/index_keys.yaml | 12 +- paths/translations/index_locale.yaml | 12 +- paths/translations/review.yaml | 9 +- paths/translations/search.yaml | 8 +- paths/translations/show.yaml | 9 +- paths/translations/unreview.yaml | 9 +- paths/translations/unverify.yaml | 9 +- paths/translations/update.yaml | 9 +- paths/translations/verify.yaml | 9 +- paths/upload_batches/create.yaml | 14 +- paths/uploads/create.yaml | 14 +- paths/uploads/index.yaml | 8 +- paths/uploads/show.yaml | 9 +- paths/users/user.yaml | 6 +- paths/variables/create.yaml | 8 +- paths/variables/destroy.yaml | 8 +- paths/variables/index.yaml | 7 +- paths/variables/show.yaml | 8 +- paths/variables/update.yaml | 9 +- paths/versions/index.yaml | 10 +- paths/versions/show.yaml | 10 +- paths/webhook_deliveries/index.yaml | 8 +- paths/webhook_deliveries/redeliver.yaml | 9 +- paths/webhook_deliveries/show.yaml | 9 +- paths/webhooks/create.yaml | 8 +- paths/webhooks/destroy.yaml | 8 +- paths/webhooks/index.yaml | 7 +- paths/webhooks/show.yaml | 8 +- paths/webhooks/test.yaml | 8 +- paths/webhooks/update.yaml | 9 +- 292 files changed, 3787 insertions(+), 2211 deletions(-) create mode 100644 examples/cli.yaml create mode 100644 openapi-generator/templates/TEMPLATING.md create mode 100644 openapi-generator/templates/cli/cli_examples.handlebars diff --git a/doc/compiled.json b/doc/compiled.json index bc8e8a34..53012add 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -5733,7 +5733,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 +5785,7 @@ } } }, + "x-cli-command": "icu skeleton", "x-cli-version": "2.9" } }, @@ -5862,9 +5863,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 +5979,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 +6036,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 +6117,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 +6213,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 +6306,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 +6385,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 +6414,7 @@ } } }, + "x-cli-command": "figma_attachments create", "x-cli-version": "2.13" } }, @@ -6484,9 +6492,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 +6574,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 +6600,7 @@ } } }, + "x-cli-command": "figma_attachments update", "x-cli-version": "2.13" }, "delete": { @@ -6651,9 +6661,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 +6720,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 +6779,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 +6863,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 +6929,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 +7020,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 +7042,7 @@ } } }, + "x-cli-command": "style_guides create", "x-cli-version": "2.5" } }, @@ -7096,9 +7111,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 +7180,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 +7268,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 +7290,7 @@ } } }, + "x-cli-command": "style_guides update", "x-cli-version": "2.5" }, "delete": { @@ -7325,9 +7342,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 +7458,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 +7574,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 +7639,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 +7748,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 +7793,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 +7876,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 +7945,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 +8029,7 @@ } } }, + "x-cli-command": "invitations create", "x-cli-version": "2.5" } }, @@ -8072,9 +8097,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 +8169,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 +8243,7 @@ } } }, + "x-cli-command": "invitations update", "x-cli-version": "2.5" }, "delete": { @@ -8267,9 +8294,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 +8368,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 +8442,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 +8474,7 @@ } } }, + "x-cli-command": "invitations update_settings", "x-cli-version": "2.5" } }, @@ -8537,9 +8567,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 +8651,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 +8726,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 +8760,7 @@ } } }, + "x-cli-command": "screenshot_markers create", "x-cli-version": "2.5" }, "patch": { @@ -8797,7 +8830,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 +8861,7 @@ } } }, + "x-cli-command": "screenshot_markers update", "x-cli-version": "2.5" }, "delete": { @@ -8888,9 +8922,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 +9019,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 +9130,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 +9200,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 +9280,7 @@ } } }, + "x-cli-command": "locales create", "x-cli-version": "2.5" } }, @@ -9320,9 +9358,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 +9431,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 +9507,7 @@ } } }, + "x-cli-command": "locales update", "x-cli-version": "2.5" }, "delete": { @@ -9528,9 +9568,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 +9862,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 \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\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 +10069,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 \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\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 +10153,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 \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\n --access_token " } ], + "x-cli-command": "locale_downloads show", "x-cli-version": "2.29.0" } }, @@ -10193,9 +10237,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 +10307,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 +10360,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 +10389,7 @@ } } }, + "x-cli-command": "distributions create", "x-cli-version": "2.5" } }, @@ -10410,9 +10458,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 +10531,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 +10580,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 +10609,7 @@ } } }, + "x-cli-command": "distributions update", "x-cli-version": "2.5" }, "delete": { @@ -10609,9 +10661,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 +10748,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 +10821,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 +10890,7 @@ } } }, + "x-cli-command": "releases create", "x-cli-version": "2.8" } }, @@ -10907,9 +10962,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 +11038,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 +11085,7 @@ } } }, + "x-cli-command": "releases update", "x-cli-version": "2.5" }, "delete": { @@ -11083,9 +11140,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 +11218,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 +11286,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 +11409,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 +11477,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 +11603,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 +11651,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 +11774,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 +11844,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 +11935,7 @@ } } }, + "x-cli-command": "jobs create", "x-cli-version": "2.5" } }, @@ -11962,9 +12028,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 +12109,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 +12182,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 +12240,7 @@ } } }, + "x-cli-command": "jobs update", "x-cli-version": "2.5" }, "delete": { @@ -12232,9 +12301,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 +12376,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 +12397,7 @@ } } }, + "x-cli-command": "jobs start", "x-cli-version": "2.5" } }, @@ -12398,7 +12469,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 +12490,7 @@ } } }, + "x-cli-command": "jobs complete", "x-cli-version": "2.5" } }, @@ -12490,7 +12562,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 +12583,7 @@ } } }, + "x-cli-command": "jobs reopen", "x-cli-version": "2.5" } }, @@ -12591,9 +12664,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 +12748,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 +12813,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 +12844,7 @@ } } }, + "x-cli-command": "jobs keys_create", "x-cli-version": "2.5" }, "delete": { @@ -12810,7 +12886,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 +12919,8 @@ } } } - } + }, + "x-cli-command": "jobs keys_delete" } }, "/projects/{project_id}/job_templates": { @@ -12932,9 +13009,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 +13079,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 +13123,7 @@ } } }, + "x-cli-command": "job_templates create", "x-cli-version": "2.5" } }, @@ -13122,9 +13201,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 +13274,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 +13318,7 @@ } } }, + "x-cli-command": "job_templates update", "x-cli-version": "2.5" }, "delete": { @@ -13298,9 +13379,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 +13463,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 +13533,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 +13573,7 @@ } } }, + "x-cli-command": "glossaries create", "x-cli-version": "2.5" } }, @@ -13558,9 +13642,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 +13715,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 +13752,7 @@ } } }, + "x-cli-command": "glossaries update", "x-cli-version": "2.5" }, "delete": { @@ -13718,9 +13804,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 +13885,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 +13952,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 +13999,7 @@ } } }, + "x-cli-command": "authorizations create", "x-cli-version": "2.5" } }, @@ -13976,9 +14065,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 +14135,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 +14179,7 @@ } } }, + "x-cli-command": "authorizations update", "x-cli-version": "2.5" }, "delete": { @@ -14137,9 +14228,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 +14379,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 +14452,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 +14492,7 @@ } } }, + "x-cli-command": "comments create", "x-cli-version": "2.5" } }, @@ -14479,9 +14573,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 +14649,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 +14675,7 @@ } } }, + "x-cli-command": "comments update", "x-cli-version": "2.5" }, "delete": { @@ -14643,9 +14739,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 +14799,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 +14820,7 @@ } } }, + "x-cli-command": "comments mark_read", "x-cli-version": "2.5" }, "delete": { @@ -14786,9 +14884,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 +14948,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 +15043,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 +15130,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 +15213,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 +15276,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 +15404,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 +15499,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 +15582,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 +15645,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 +15710,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 +15775,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 +15859,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 +15929,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 +15978,7 @@ } } }, + "x-cli-command": "webhooks create", "x-cli-version": "2.5" } }, @@ -15935,9 +16047,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 +16120,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 +16166,7 @@ } } }, + "x-cli-command": "webhooks update", "x-cli-version": "2.5" }, "delete": { @@ -16104,9 +16218,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 +16293,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 +16365,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 +16511,7 @@ } } }, + "x-cli-command": "uploads create", "x-cli-version": "2.12" }, "get": { @@ -16482,9 +16599,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 +16680,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 +16831,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 +16936,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 +17020,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 +17098,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 +17128,7 @@ } } }, + "x-cli-command": "glossary_term_translations create", "x-cli-version": "2.5" } }, @@ -17083,7 +17206,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 +17232,7 @@ } } }, + "x-cli-command": "glossary_term_translations update", "x-cli-version": "2.5" }, "delete": { @@ -17166,9 +17290,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 +17414,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 +17481,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 +17679,7 @@ } } }, + "x-cli-command": "projects create", "x-cli-version": "2.6.3" } }, @@ -17618,9 +17745,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 +17815,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 +18005,7 @@ } } }, + "x-cli-command": "projects update", "x-cli-version": "2.6.3" }, "delete": { @@ -17925,9 +18054,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 +18140,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 +18203,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 +18272,7 @@ } } }, + "x-cli-command": "job_locales create", "x-cli-version": "2.6.8" } }, @@ -18211,9 +18343,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 +18409,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 +18475,7 @@ } } }, + "x-cli-command": "job_locales update", "x-cli-version": "2.6.8" }, "delete": { @@ -18389,9 +18523,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 +18591,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 +18612,7 @@ } } }, + "x-cli-command": "job_locales complete", "x-cli-version": "2.5" } }, @@ -18541,7 +18677,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 +18698,7 @@ } } }, + "x-cli-command": "job_locales complete_review", "x-cli-version": "2.5" } }, @@ -18626,7 +18763,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 +18784,7 @@ } } }, + "x-cli-command": "job_locales reopen", "x-cli-version": "2.5" } }, @@ -18732,9 +18870,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 +18933,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 +19002,7 @@ } } }, + "x-cli-command": "job_template_locales create", "x-cli-version": "2.6.8" } }, @@ -18936,9 +19076,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 +19142,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 +19208,7 @@ } } }, + "x-cli-command": "job_template_locales update", "x-cli-version": "2.6.8" }, "delete": { @@ -19120,9 +19262,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 +19324,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 +19398,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 +19424,7 @@ } } }, + "x-cli-command": "job_annotations update", "x-cli-version": "2.43" }, "delete": { @@ -19344,9 +19489,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 +19554,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 +19631,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 +19657,7 @@ } } }, + "x-cli-command": "job_annotations update", "x-cli-version": "2.43" }, "delete": { @@ -19577,9 +19725,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 +19809,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 +19879,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 +19908,7 @@ } } }, + "x-cli-command": "variables create", "x-cli-version": "2.5" } }, @@ -19826,9 +19977,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 +20050,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 +20076,7 @@ } } }, + "x-cli-command": "variables update", "x-cli-version": "2.5" }, "delete": { @@ -19975,9 +20128,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 +20212,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 +20282,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 +20311,7 @@ } } }, + "x-cli-command": "branches create", "x-cli-version": "2.5" } }, @@ -20224,9 +20380,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 +20453,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 +20474,7 @@ } } }, + "x-cli-command": "branches update", "x-cli-version": "2.5" }, "delete": { @@ -20372,9 +20530,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 +20602,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 +20626,8 @@ } } } - } + }, + "x-cli-command": "branches merge" } }, "/projects/{project_id}/branches/{name}/sync": { @@ -20531,7 +20691,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 +20715,8 @@ } } } - } + }, + "x-cli-command": "branches sync" } }, "/projects/{project_id}/branches/{name}/compare": { @@ -20629,9 +20790,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 +20839,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 +20860,8 @@ } } } - } + }, + "x-cli-command": "branches comparison_create" } }, "/accounts": { @@ -20775,9 +20938,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 +21007,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 +21073,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 +21156,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 +21227,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 +21299,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 +21368,7 @@ } } }, + "x-cli-command": "members update", "x-cli-version": "2.5" }, "delete": { @@ -21250,9 +21419,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 +21493,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 +21525,7 @@ } } }, + "x-cli-command": "members update_settings", "x-cli-version": "2.5" } }, @@ -21453,9 +21624,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 +21702,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 +21748,7 @@ } } }, + "x-cli-command": "screenshots create", "x-cli-version": "2.5" } }, @@ -21653,9 +21826,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 +21899,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 +21936,7 @@ } } }, + "x-cli-command": "screenshots update", "x-cli-version": "2.5" }, "delete": { @@ -21822,9 +21997,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 +22084,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 +22157,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 +22196,7 @@ } } }, + "x-cli-command": "glossary_terms create", "x-cli-version": "2.5" } }, @@ -22090,9 +22268,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 +22344,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 +22380,7 @@ } } }, + "x-cli-command": "glossary_terms update", "x-cli-version": "2.5" }, "delete": { @@ -22255,9 +22435,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 +22555,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 +22625,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 +22654,7 @@ } } }, + "x-cli-command": "tags create", "x-cli-version": "2.5" } }, @@ -22558,9 +22741,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 +22805,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 +22898,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 +22968,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 +22992,7 @@ } } }, + "x-cli-command": "blacklisted_keys create", "x-cli-version": "2.5" } }, @@ -22874,9 +23061,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 +23134,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 +23155,7 @@ } } }, + "x-cli-command": "blacklisted_keys update", "x-cli-version": "2.5" }, "delete": { @@ -23018,9 +23207,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 +23330,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 +23400,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 +23536,7 @@ } } }, + "x-cli-command": "keys create", "x-cli-version": "2.5" }, "delete": { @@ -23429,9 +23621,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 +23702,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 +23743,7 @@ } } }, + "x-cli-command": "keys search", "x-cli-version": "2.5" } }, @@ -23627,9 +23821,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 +23894,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 +24017,7 @@ } } }, + "x-cli-command": "keys update", "x-cli-version": "2.5" }, "delete": { @@ -23882,9 +24078,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 +24150,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 +24186,7 @@ } } }, + "x-cli-command": "keys tag", "x-cli-version": "2.5" } }, @@ -24054,7 +24252,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 +24288,7 @@ } } }, + "x-cli-command": "keys untag", "x-cli-version": "2.5" } }, @@ -24155,7 +24354,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 +24390,7 @@ } } }, + "x-cli-command": "keys exclude", "x-cli-version": "2.5" } }, @@ -24256,7 +24456,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 +24492,7 @@ } } }, + "x-cli-command": "keys include", "x-cli-version": "2.5" } }, @@ -24390,9 +24591,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 +24661,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 +24762,7 @@ } } }, + "x-cli-command": "orders create", "x-cli-version": "2.5" } }, @@ -24637,9 +24840,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 +24904,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 +24979,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 +25000,7 @@ } } }, + "x-cli-command": "orders confirm", "x-cli-version": "2.5" } }, @@ -24947,7 +25153,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 +25176,7 @@ } } }, + "x-cli-command": "quality_performance_score list", "x-cli-version": "2.20" } }, @@ -25044,9 +25251,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 +25321,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 +25404,7 @@ } } }, + "x-cli-command": "repo_syncs create", "x-cli-version": "2.60" } }, @@ -25264,9 +25473,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 +25571,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 +25668,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 +25741,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 +25809,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 +25884,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 +25959,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 +26036,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 +26096,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 +26120,7 @@ } } }, + "x-cli-command": "spaces create", "x-cli-version": "2.5" } }, @@ -25964,9 +26182,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 +26245,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 +26266,7 @@ } } }, + "x-cli-command": "spaces update", "x-cli-version": "2.5" }, "delete": { @@ -26088,9 +26308,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 +26388,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 +26444,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 +26468,7 @@ } } }, + "x-cli-command": "spaces projects_create", "x-cli-version": "2.5" } }, @@ -26292,9 +26515,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 +26592,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 +26652,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 +26676,7 @@ } } }, + "x-cli-command": "teams create", "x-cli-version": "2.5" } }, @@ -26512,9 +26738,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 +26801,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 +26822,7 @@ } } }, + "x-cli-command": "teams update", "x-cli-version": "2.5" }, "delete": { @@ -26636,9 +26864,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 +26922,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 +26946,7 @@ } } }, + "x-cli-command": "teams projects_create", "x-cli-version": "2.5" } }, @@ -26763,9 +26993,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 +27051,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 +27075,7 @@ } } }, + "x-cli-command": "teams spaces_create", "x-cli-version": "2.5" } }, @@ -26890,9 +27122,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 +27180,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 +27204,7 @@ } } }, + "x-cli-command": "teams users_create", "x-cli-version": "2.5" } }, @@ -27017,9 +27251,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 +27395,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 \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\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 +27465,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 +27531,7 @@ } } }, + "x-cli-command": "translations create", "x-cli-version": "2.5" } }, @@ -27414,9 +27651,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 +27774,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 +27855,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 +27891,7 @@ } } }, + "x-cli-command": "translations search", "x-cli-version": "2.5" } }, @@ -27729,9 +27969,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 +28042,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 +28098,7 @@ } } }, + "x-cli-command": "translations update", "x-cli-version": "2.5" } }, @@ -27928,7 +28170,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 +28191,7 @@ } } }, + "x-cli-command": "translations verify", "x-cli-version": "2.5" } }, @@ -28020,7 +28263,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 +28284,7 @@ } } }, + "x-cli-command": "translations unverify", "x-cli-version": "2.5" } }, @@ -28112,7 +28356,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 +28377,7 @@ } } }, + "x-cli-command": "translations review", "x-cli-version": "2.5" } }, @@ -28204,7 +28449,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 +28470,7 @@ } } }, + "x-cli-command": "translations unreview", "x-cli-version": "2.41" } }, @@ -28296,7 +28542,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 +28563,7 @@ } } }, + "x-cli-command": "translations exclude", "x-cli-version": "2.5" } }, @@ -28388,7 +28635,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 +28656,7 @@ } } }, + "x-cli-command": "translations include", "x-cli-version": "2.5" } }, @@ -28477,7 +28725,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 +28756,7 @@ } } }, + "x-cli-command": "translations verify-collection", "x-cli-version": "2.5" } }, @@ -28576,7 +28825,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 +28861,7 @@ } } }, + "x-cli-command": "translations unverify-collection", "x-cli-version": "2.5" } }, @@ -28680,7 +28930,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 +28956,7 @@ } } }, + "x-cli-command": "translations review-collection", "x-cli-version": "2.5" } }, @@ -28774,7 +29025,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 +29051,7 @@ } } }, + "x-cli-command": "translations unreview-collection", "x-cli-version": "2.41" } }, @@ -28865,7 +29117,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 +29153,7 @@ } } }, + "x-cli-command": "translations exclude-collection", "x-cli-version": "2.5" } }, @@ -28966,7 +29219,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 +29255,7 @@ } } }, + "x-cli-command": "translations include-collection", "x-cli-version": "2.5" } }, @@ -29097,9 +29351,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 +29420,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 +29488,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 +29569,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 +29638,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 +29707,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 +29905,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 +29951,7 @@ } } }, + "x-cli-command": "search in_account", "x-cli-version": "2.5" } }, @@ -29758,9 +30019,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 +30085,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 +30111,7 @@ } } }, + "x-cli-command": "job_comments update", "x-cli-version": "2.5" }, "delete": { @@ -29896,9 +30159,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 +30245,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 +30308,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 +30334,7 @@ } } }, + "x-cli-command": "job_comments create", "x-cli-version": "2.5" } }, @@ -30142,9 +30408,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 +30479,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 +30553,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 +30637,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 +30707,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 +30741,7 @@ } } }, + "x-cli-command": "organization_job_templates create", "x-cli-version": "2.7.0" } }, @@ -30539,9 +30810,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 +30883,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 +30917,7 @@ } } }, + "x-cli-command": "organization_job_templates update", "x-cli-version": "2.7.0" }, "delete": { @@ -30696,9 +30969,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 +31049,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 +31112,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 +31182,7 @@ } } }, + "x-cli-command": "organization_job_template_locales create", "x-cli-version": "2.7.0" } }, @@ -30971,9 +31247,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 +31313,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 +31379,7 @@ } } }, + "x-cli-command": "organization_job_template_locales update", "x-cli-version": "2.7.0" }, "delete": { @@ -31146,9 +31424,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" } }, @@ -31248,7 +31527,8 @@ "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\"}'" } - ] + ], + "x-cli-command": "linked_keys batch_destroy" }, "get": { "summary": "List child keys of a parent key", @@ -31310,7 +31590,8 @@ "429": { "$ref": "#/components/responses/429" } - } + }, + "x-cli-command": "linked_keys index" }, "post": { "summary": "Link child keys to a parent key", @@ -31387,7 +31668,8 @@ "429": { "$ref": "#/components/responses/429" } - } + }, + "x-cli-command": "linked_keys create" } }, "/projects/{project_id}/keys/{id}/key_links/{child_key_id}": { @@ -31459,7 +31741,8 @@ "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" } - ] + ], + "x-cli-command": "linked_keys destroy" } }, "/accounts/{account_id}/automations": { @@ -31539,9 +31822,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", @@ -31695,9 +31979,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}": { @@ -31765,9 +32050,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", @@ -31924,9 +32210,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", @@ -31974,9 +32261,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": { @@ -32047,9 +32335,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": { @@ -32120,9 +32409,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": { @@ -32175,9 +32465,10 @@ }, { "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..277e665c --- /dev/null +++ b/examples/cli.yaml @@ -0,0 +1,2385 @@ +AccountShow: + lang: CLI v2 + source: |- + phrase accounts show \ + --id \ + --access_token +AccountsList: + lang: CLI v2 + source: |- + phrase accounts list \ + --page "1" \ + --per_page "25" \ + --access_token +AuthorizationCreate: + lang: CLI v2 + source: |- + phrase authorizations create \ + --data '{ "note": "My Deploy Script", "scopes": ["read","write"], "expires_at": "2015-03-30T09:52:53Z" }' \ + --access_token +AuthorizationDelete: + lang: CLI v2 + source: |- + phrase authorizations delete \ + --id \ + --access_token +AuthorizationShow: + lang: CLI v2 + source: |- + phrase authorizations show \ + --id \ + --access_token +AuthorizationUpdate: + 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 +AuthorizationsList: + lang: CLI v2 + source: |- + phrase authorizations list \ + --page "1" \ + --per_page "25" \ + --access_token +AutomationActivate: + lang: CLI v2 + source: |- + phrase automations activate \ + --account_id \ + --id \ + --access_token +AutomationCreate: + 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 +AutomationDeactivate: + lang: CLI v2 + source: |- + phrase automations deactivate \ + --account_id \ + --id \ + --access_token +AutomationDelete: + lang: CLI v2 + source: |- + phrase automations delete \ + --account_id \ + --id \ + --access_token +AutomationShow: + lang: CLI v2 + source: |- + phrase automations show \ + --account_id \ + --id \ + --access_token +AutomationTrigger: + lang: CLI v2 + source: |- + phrase automations trigger \ + --account_id \ + --id \ + --access_token +AutomationUpdate: + 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 +AutomationsList: + lang: CLI v2 + source: |- + phrase automations list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +BlacklistedKeyCreate: + lang: CLI v2 + source: |- + phrase blacklisted_keys create \ + --project_id \ + --data '{ "name": "date.formats.*" }' \ + --access_token +BlacklistedKeyDelete: + lang: CLI v2 + source: |- + phrase blacklisted_keys delete \ + --project_id \ + --id \ + --access_token +BlacklistedKeyShow: + lang: CLI v2 + source: |- + phrase blacklisted_keys show \ + --project_id \ + --id \ + --access_token +BlacklistedKeyUpdate: + lang: CLI v2 + source: |- + phrase blacklisted_keys update \ + --project_id \ + --id \ + --data '{ "name": "date.formats.*" }' \ + --access_token +BlacklistedKeysList: + lang: CLI v2 + source: |- + phrase blacklisted_keys list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +BranchCompare: + lang: CLI v2 + source: |- + phrase branches compare \ + --project_id \ + --name \ + --access_token +BranchComparisonCreate: + lang: CLI v2 + source: |- + phrase branches comparison_create \ + --project_id \ + --name \ + --data '{ "direction": "merge" }' \ + --access_token +BranchCreate: + lang: CLI v2 + source: |- + phrase branches create \ + --project_id \ + --data '{ "name": "my-branch", "base": "parent-branch" }' \ + --access_token +BranchDelete: + lang: CLI v2 + source: |- + phrase branches delete \ + --project_id \ + --name \ + --access_token +BranchMerge: + lang: CLI v2 + source: |- + phrase branches merge \ + --project_id \ + --name \ + --data '{ "strategy": "use_main" }' \ + --access_token +BranchShow: + lang: CLI v2 + source: |- + phrase branches show \ + --project_id \ + --name \ + --access_token +BranchSync: + lang: CLI v2 + source: |- + phrase branches sync \ + --project_id \ + --name \ + --data '{ "strategy": "use_main" }' \ + --access_token +BranchUpdate: + lang: CLI v2 + source: |- + phrase branches update \ + --project_id \ + --name \ + --data '{ "name": "my-branch" }' \ + --access_token +BranchesList: + lang: CLI v2 + source: |- + phrase branches list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --access_token +ReactionCreate: + lang: CLI v2 + source: |- + phrase comment_reactions create \ + --project_id \ + --key_id \ + --comment_id \ + --branch "my-feature-branch" \ + --emoji "👍" \ + --access_token +ReactionDelete: + lang: CLI v2 + source: |- + phrase comment_reactions delete \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +ReactionShow: + lang: CLI v2 + source: |- + phrase comment_reactions show \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +ReactionsList: + 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 +RepliesList: + 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 +ReplyCreate: + lang: CLI v2 + source: |- + phrase comment_replies create \ + --project_id \ + --key_id \ + --comment_id \ + --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ + --access_token +ReplyDelete: + lang: CLI v2 + source: |- + phrase comment_replies delete \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +ReplyMarkAsRead: + lang: CLI v2 + source: |- + phrase comment_replies mark_as_read \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +ReplyMarkAsUnread: + lang: CLI v2 + source: |- + phrase comment_replies mark_as_unread \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +ReplyShow: + lang: CLI v2 + source: |- + phrase comment_replies show \ + --project_id \ + --key_id \ + --comment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +CommentCreate: + 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 +CommentDelete: + lang: CLI v2 + source: |- + phrase comments delete \ + --project_id \ + --key_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +CommentMarkCheck: + lang: CLI v2 + source: |- + phrase comments mark_check \ + --project_id \ + --key_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +CommentMarkRead: + lang: CLI v2 + source: |- + phrase comments mark_read \ + --project_id \ + --key_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +CommentMarkUnread: + lang: CLI v2 + source: |- + phrase comments mark_unread \ + --project_id \ + --key_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +CommentShow: + lang: CLI v2 + source: |- + phrase comments show \ + --project_id \ + --key_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +CommentUpdate: + lang: CLI v2 + source: |- + phrase comments update \ + --project_id \ + --key_id \ + --id \ + --data '{ "branch": "my-feature-branch", "message": "Some message..." }' \ + --access_token +CommentsList: + 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 +CustomMetadataPropertiesDelete: + lang: CLI v2 + source: |- + phrase custom_metadata delete \ + --account_id \ + --id \ + --access_token +CustomMetadataPropertiesList: + 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 +CustomMetadataPropertyCreate: + 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 +CustomMetadataPropertyShow: + lang: CLI v2 + source: |- + phrase custom_metadata show \ + --account_id \ + --id \ + --access_token +CustomMetadataPropertyUpdate: + 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 +DistributionCreate: + 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 +DistributionDelete: + lang: CLI v2 + source: |- + phrase distributions delete \ + --account_id \ + --id \ + --access_token +DistributionShow: + lang: CLI v2 + source: |- + phrase distributions show \ + --account_id \ + --id \ + --access_token +DistributionUpdate: + 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 +DistributionsList: + lang: CLI v2 + source: |- + phrase distributions list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +DocumentDelete: + lang: CLI v2 + source: |- + phrase documents delete \ + --project_id \ + --id \ + --access_token +DocumentsList: + lang: CLI v2 + source: |- + phrase documents list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --q "invoice" \ + --access_token +FigmaAttachmentCreate: + 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 +FigmaAttachmentDelete: + lang: CLI v2 + source: |- + phrase figma_attachments delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +FigmaAttachmentShow: + lang: CLI v2 + source: |- + phrase figma_attachments show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +FigmaAttachmentUpdate: + 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 +FigmaAttachmentsList: + lang: CLI v2 + source: |- + phrase figma_attachments list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +FormatsList: + lang: CLI v2 + source: |- + phrase formats list \ + --access_token +GlossariesList: + lang: CLI v2 + source: |- + phrase glossaries list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +GlossaryCreate: + lang: CLI v2 + source: |- + phrase glossaries create \ + --account_id \ + --data '{ "name": "My glossary", "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ + --access_token +GlossaryDelete: + lang: CLI v2 + source: |- + phrase glossaries delete \ + --account_id \ + --id \ + --access_token +GlossaryShow: + lang: CLI v2 + source: |- + phrase glossaries show \ + --account_id \ + --id \ + --access_token +GlossaryUpdate: + lang: CLI v2 + source: |- + phrase glossaries update \ + --account_id \ + --id \ + --data '{ "name": "My glossary", "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ + --access_token +GlossaryTermTranslationCreate: + 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 +GlossaryTermTranslationDelete: + lang: CLI v2 + source: |- + phrase glossary_term_translations delete \ + --account_id \ + --glossary_id \ + --term_id \ + --id \ + --access_token +GlossaryTermTranslationUpdate: + 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 +GlossaryTermCreate: + 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 +GlossaryTermDelete: + lang: CLI v2 + source: |- + phrase glossary_terms delete \ + --account_id \ + --glossary_id \ + --id \ + --access_token +GlossaryTermShow: + lang: CLI v2 + source: |- + phrase glossary_terms show \ + --account_id \ + --glossary_id \ + --id \ + --access_token +GlossaryTermUpdate: + 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 +GlossaryTermsList: + lang: CLI v2 + source: |- + phrase glossary_terms list \ + --account_id \ + --glossary_id \ + --page "1" \ + --per_page "25" \ + --access_token +IcuSkeleton: + 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 +InvitationCreate: + 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 +InvitationDelete: + lang: CLI v2 + source: |- + phrase invitations delete \ + --account_id \ + --id \ + --access_token +InvitationResend: + lang: CLI v2 + source: |- + phrase invitations resend \ + --account_id \ + --id \ + --access_token +InvitationShow: + lang: CLI v2 + source: |- + phrase invitations show \ + --account_id \ + --id \ + --access_token +InvitationUpdate: + 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 +InvitationUpdateSettings: + lang: CLI v2 + source: |- + phrase invitations update_settings \ + --project_id \ + --id \ + --data '{ "project_role": "Developer", "locale_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ + --access_token +InvitationsList: + lang: CLI v2 + source: |- + phrase invitations list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +JobAnnotationDelete: + lang: CLI v2 + source: |- + phrase job_annotations delete \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobAnnotationUpdate: + lang: CLI v2 + source: |- + phrase job_annotations update \ + --project_id \ + --job_id \ + --id \ + --data '{ "value": "Some value...", "branch": "my-feature-branch" }' \ + --access_token +JobAnnotationsList: + lang: CLI v2 + source: |- + phrase job_annotations list \ + --project_id \ + --job_id \ + --branch "my-feature-branch" \ + --access_token +JobLocaleAnnotationDelete: + lang: CLI v2 + source: |- + phrase job_annotations delete \ + --project_id \ + --job_id \ + --job_locale_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobLocaleAnnotationUpdate: + 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 +JobLocaleAnnotationsList: + lang: CLI v2 + source: |- + phrase job_annotations list \ + --project_id \ + --job_id \ + --job_locale_id \ + --branch "my-feature-branch" \ + --access_token +JobCommentCreate: + lang: CLI v2 + source: |- + phrase job_comments create \ + --project_id \ + --job_id \ + --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ + --access_token +JobCommentDelete: + lang: CLI v2 + source: |- + phrase job_comments delete \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobCommentShow: + lang: CLI v2 + source: |- + phrase job_comments show \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobCommentUpdate: + lang: CLI v2 + source: |- + phrase job_comments update \ + --project_id \ + --key_id \ + --id \ + --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ + --access_token +JobCommentsList: + lang: CLI v2 + source: |- + phrase job_comments list \ + --project_id \ + --job_id \ + --branch "my-feature-branch" \ + --order "desc" \ + --access_token +JobLocaleComplete: + lang: CLI v2 + source: |- + phrase job_locales complete \ + --project_id \ + --job_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +JobLocaleCompleteReview: + lang: CLI v2 + source: |- + phrase job_locales complete_review \ + --project_id \ + --job_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +JobLocaleDelete: + lang: CLI v2 + source: |- + phrase job_locales delete \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobLocaleReopen: + lang: CLI v2 + source: |- + phrase job_locales reopen \ + --project_id \ + --job_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +JobLocaleShow: + lang: CLI v2 + source: |- + phrase job_locales show \ + --project_id \ + --job_id \ + --id \ + --branch "my-feature-branch" \ + --include_annotations true \ + --access_token +JobLocaleUpdate: + 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 +JobLocalesCreate: + 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 +JobLocalesList: + 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 +JobTemplateLocaleDelete: + lang: CLI v2 + source: |- + phrase job_template_locales delete \ + --project_id \ + --job_template_id \ + --job_template_locale_id \ + --branch "my-feature-branch" \ + --access_token +JobTemplateLocaleShow: + lang: CLI v2 + source: |- + phrase job_template_locales show \ + --project_id \ + --job_template_id \ + --job_template_locale_id \ + --branch "my-feature-branch" \ + --access_token +JobTemplateLocaleUpdate: + 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 +JobTemplateLocalesCreate: + 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 +JobTemplateLocalesList: + 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 +JobTemplateCreate: + 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 +JobTemplateDelete: + lang: CLI v2 + source: |- + phrase job_templates delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobTemplateUpdate: + 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 +JobTemplatesList: + lang: CLI v2 + source: |- + phrase job_templates list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +JobTemplatesShow: + lang: CLI v2 + source: |- + phrase job_templates show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobComplete: + lang: CLI v2 + source: |- + phrase jobs complete \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +JobCreate: + 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 +JobDelete: + lang: CLI v2 + source: |- + phrase jobs delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobKeysCreate: + lang: CLI v2 + source: |- + phrase jobs keys_create \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +JobKeysDelete: + lang: CLI v2 + source: |- + phrase jobs keys_delete \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch", "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ + --access_token +JobLock: + lang: CLI v2 + source: |- + phrase jobs lock \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobReopen: + lang: CLI v2 + source: |- + phrase jobs reopen \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +JobShow: + lang: CLI v2 + source: |- + phrase jobs show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --include_annotations true \ + --omit_translation_keys true \ + --access_token +JobStart: + lang: CLI v2 + source: |- + phrase jobs start \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +JobUnlock: + lang: CLI v2 + source: |- + phrase jobs unlock \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +JobUpdate: + 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 +JobsByAccount: + 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 +JobsList: + 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 +KeyCreate: + 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 +KeyDelete: + lang: CLI v2 + source: |- + phrase keys delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +KeyShow: + lang: CLI v2 + source: |- + phrase keys show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +KeyUpdate: + 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 +KeysDeleteCollection: + lang: CLI v2 + source: |- + phrase keys delete-collection \ + --project_id \ + --branch "my-feature-branch" \ + --q "mykey* translated:true" \ + --locale_id "abcd1234abcd1234abcd1234abcd1234" \ + --access_token +KeysExclude: + 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 +KeysInclude: + 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 +KeysList: + 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 +KeysSearch: + 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 +KeysTag: + 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 +KeysUntag: + 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 +FigmaAttachmentAttachToKey: + lang: CLI v2 + source: |- + phrase keys_figma_attachments attach_to_key \ + --project_id \ + --figma_attachment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +FigmaAttachmentDetachFromKey: + lang: CLI v2 + source: |- + phrase keys_figma_attachments detach_from_key \ + --project_id \ + --figma_attachment_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +KeyLinksBatchDestroy: + 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 +KeyLinksCreate: + lang: CLI v2 + source: |- + phrase linked_keys create \ + --project_id \ + --id \ + --data '{ "child_key_ids": ["child_key_id1","child_key_id2"] }' \ + --access_token +KeyLinksDestroy: + lang: CLI v2 + source: |- + phrase linked_keys destroy \ + --project_id \ + --id \ + --child_key_id \ + --access_token +KeyLinksIndex: + lang: CLI v2 + source: |- + phrase linked_keys index \ + --project_id \ + --id \ + --access_token +LocaleDownloadCreate: + lang: CLI v2 + source: |- + phrase locale_downloads create \ + --project_id \ + --locale_id \ + --If-Modified-Since "ifModifiedSince_example" \ + --If-None-Match "ifNoneMatch_example" \ + --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 +LocaleDownloadShow: + lang: CLI v2 + source: |- + phrase locale_downloads show \ + --project_id \ + --locale_id \ + --id \ + --If-Modified-Since "ifModifiedSince_example" \ + --If-None-Match "ifNoneMatch_example" \ + --access_token +AccountLocales: + lang: CLI v2 + source: |- + phrase locales locales \ + --id \ + --page "1" \ + --per_page "25" \ + --access_token +LocaleCreate: + 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 +LocaleDelete: + lang: CLI v2 + source: |- + phrase locales delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +LocaleDownload: + lang: CLI v2 + source: |- + phrase locales download \ + --project_id \ + --id \ + --If-Modified-Since "ifModifiedSince_example" \ + --If-None-Match "ifNoneMatch_example" \ + --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 +LocaleShow: + lang: CLI v2 + source: |- + phrase locales show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +LocaleUpdate: + 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 +LocalesList: + 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 +MemberDelete: + lang: CLI v2 + source: |- + phrase members delete \ + --account_id \ + --id \ + --access_token +MemberShow: + lang: CLI v2 + source: |- + phrase members show \ + --account_id \ + --id \ + --access_token +MemberUpdate: + 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 +MemberUpdateSettings: + lang: CLI v2 + source: |- + phrase members update_settings \ + --project_id \ + --id \ + --data '{ "project_role": "Developer", "locale_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ + --access_token +MembersList: + lang: CLI v2 + source: |- + phrase members list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +NotificationGroupsList: + lang: CLI v2 + source: |- + phrase notification_groups list \ + --page "1" \ + --per_page "25" \ + --access_token +NotificationGroupsMarkAllAsRead: + lang: CLI v2 + source: |- + phrase notification_groups mark_all_as_read \ + --access_token +NotificationGroupsMarkAsRead: + lang: CLI v2 + source: |- + phrase notification_groups mark_as_read \ + --id \ + --access_token +NotificationsList: + lang: CLI v2 + source: |- + phrase notifications list \ + --page "1" \ + --per_page "25" \ + --unseen true \ + --last_days "7" \ + --access_token +NotificationsMarkAllAsRead: + lang: CLI v2 + source: |- + phrase notifications mark_all_as_read \ + --access_token +NotificationsShow: + lang: CLI v2 + source: |- + phrase notifications show \ + --id \ + --access_token +OrderConfirm: + lang: CLI v2 + source: |- + phrase orders confirm \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +OrderCreate: + 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 +OrderDelete: + lang: CLI v2 + source: |- + phrase orders delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +OrderShow: + lang: CLI v2 + source: |- + phrase orders show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +OrdersList: + lang: CLI v2 + source: |- + phrase orders list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --translation_id "abcd1234cdef1234abcd1234cdef1234" \ + --access_token +OrganizationJobTemplateLocaleDelete: + lang: CLI v2 + source: |- + phrase organization_job_template_locales delete \ + --account_id \ + --job_template_id \ + --job_template_locale_id \ + --access_token +OrganizationJobTemplateLocaleShow: + lang: CLI v2 + source: |- + phrase organization_job_template_locales show \ + --account_id \ + --job_template_id \ + --job_template_locale_id \ + --access_token +OrganizationJobTemplateLocaleUpdate: + 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 +OrganizationJobTemplateLocalesCreate: + 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 +OrganizationJobTemplateLocalesList: + lang: CLI v2 + source: |- + phrase organization_job_template_locales list \ + --account_id \ + --job_template_id \ + --page "1" \ + --per_page "25" \ + --access_token +OrganizationJobTemplateCreate: + lang: CLI v2 + source: |- + phrase organization_job_templates create \ + --account_id \ + --data '{ "name": "template", "briefing": "text", "autotranslate": true }' \ + --access_token +OrganizationJobTemplateDelete: + lang: CLI v2 + source: |- + phrase organization_job_templates delete \ + --account_id \ + --id \ + --access_token +OrganizationJobTemplateUpdate: + lang: CLI v2 + source: |- + phrase organization_job_templates update \ + --account_id \ + --id \ + --data '{ "name": "template", "briefing": "text", "autotranslate": true }' \ + --access_token +OrganizationJobTemplatesList: + lang: CLI v2 + source: |- + phrase organization_job_templates list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +OrganizationJobTemplatesShow: + lang: CLI v2 + source: |- + phrase organization_job_templates show \ + --account_id \ + --id \ + --access_token +ProjectCreate: + 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 +ProjectDelete: + lang: CLI v2 + source: |- + phrase projects delete \ + --id \ + --access_token +ProjectShow: + lang: CLI v2 + source: |- + phrase projects show \ + --id \ + --access_token +ProjectUpdate: + 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 +ProjectsList: + 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 +QualityPerformanceScoreList: + lang: CLI v2 + source: |- + phrase quality_performance_score list \ + --project_id \ + --data '{ "translation_ids": null }' \ + --access_token +ReleaseTriggersCreate: + 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 +ReleaseTriggersDestroy: + lang: CLI v2 + source: |- + phrase release_triggers destroy \ + --account_id \ + --distribution_id \ + --id \ + --access_token +ReleaseTriggersList: + lang: CLI v2 + source: |- + phrase release_triggers list \ + --account_id \ + --distribution_id \ + --access_token +ReleaseTriggersShow: + lang: CLI v2 + source: |- + phrase release_triggers show \ + --account_id \ + --distribution_id \ + --id \ + --access_token +ReleaseTriggersUpdate: + 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 +ReleaseCreate: + 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 +ReleaseDelete: + lang: CLI v2 + source: |- + phrase releases delete \ + --account_id \ + --distribution_id \ + --id \ + --access_token +ReleasePublish: + lang: CLI v2 + source: |- + phrase releases publish \ + --account_id \ + --distribution_id \ + --id \ + --access_token +ReleaseShow: + lang: CLI v2 + source: |- + phrase releases show \ + --account_id \ + --distribution_id \ + --id \ + --access_token +ReleaseUpdate: + 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 +ReleasesList: + lang: CLI v2 + source: |- + phrase releases list \ + --account_id \ + --distribution_id \ + --page "1" \ + --per_page "25" \ + --access_token +RepoSyncEventList: + lang: CLI v2 + source: |- + phrase repo_sync_events list \ + --account_id \ + --id \ + --access_token +RepoSyncEventShow: + lang: CLI v2 + source: |- + phrase repo_sync_events show \ + --account_id \ + --repo_sync_id \ + --id \ + --access_token +RepoSyncActivate: + lang: CLI v2 + source: |- + phrase repo_syncs activate \ + --account_id \ + --id \ + --access_token +RepoSyncCreate: + 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 +RepoSyncDeactivate: + lang: CLI v2 + source: |- + phrase repo_syncs deactivate \ + --account_id \ + --id \ + --access_token +RepoSyncExport: + lang: CLI v2 + source: |- + phrase repo_syncs export \ + --account_id \ + --id \ + --data '{ "pr_branch": "my-feature-branch", "branch": "my-strings-branch" }' \ + --access_token +RepoSyncImport: + lang: CLI v2 + source: |- + phrase repo_syncs import \ + --account_id \ + --id \ + --data '{ "repository_branch": "my-feature-branch", "branch": "my-strings-branch" }' \ + --access_token +RepoSyncList: + lang: CLI v2 + source: |- + phrase repo_syncs list \ + --account_id \ + --access_token +RepoSyncShow: + lang: CLI v2 + source: |- + phrase repo_syncs show \ + --account_id \ + --id \ + --access_token +ReportLocalesList: + 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 +ReportShow: + lang: CLI v2 + source: |- + phrase reports show \ + --project_id \ + --branch "my-feature-branch" \ + --access_token +ScreenshotMarkerCreate: + 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 +ScreenshotMarkerDelete: + lang: CLI v2 + source: |- + phrase screenshot_markers delete \ + --project_id \ + --screenshot_id \ + --branch "my-feature-branch" \ + --access_token +ScreenshotMarkerShow: + lang: CLI v2 + source: |- + phrase screenshot_markers show \ + --project_id \ + --screenshot_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +ScreenshotMarkerUpdate: + 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 +ScreenshotMarkersList: + lang: CLI v2 + source: |- + phrase screenshot_markers list \ + --project_id \ + --id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +ScreenshotCreate: + lang: CLI v2 + source: |- + phrase screenshots create \ + --project_id \ + --filename \ + --branch "branch_example" \ + --name "name_example" \ + --description "description_example" \ + --access_token +ScreenshotDelete: + lang: CLI v2 + source: |- + phrase screenshots delete \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +ScreenshotShow: + lang: CLI v2 + source: |- + phrase screenshots show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +ScreenshotUpdate: + 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 +ScreenshotsList: + lang: CLI v2 + source: |- + phrase screenshots list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --key_id "abcd1234cdef1234abcd1234cdef1234" \ + --access_token +SearchInAccount: + 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 +SpaceCreate: + lang: CLI v2 + source: |- + phrase spaces create \ + --account_id \ + --data '{ "name": "My Android Projects" }' \ + --access_token +SpaceDelete: + lang: CLI v2 + source: |- + phrase spaces delete \ + --account_id \ + --id \ + --access_token +SpaceShow: + lang: CLI v2 + source: |- + phrase spaces show \ + --account_id \ + --id \ + --access_token +SpaceUpdate: + lang: CLI v2 + source: |- + phrase spaces update \ + --account_id \ + --id \ + --data '{ "name": "My Android Projects" }' \ + --access_token +SpacesList: + lang: CLI v2 + source: |- + phrase spaces list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +SpacesProjectsCreate: + lang: CLI v2 + source: |- + phrase spaces projects_create \ + --account_id \ + --space_id \ + --data '{ "id": "a4b3c2d1" }' \ + --access_token +SpacesProjectsDelete: + lang: CLI v2 + source: |- + phrase spaces projects_delete \ + --account_id \ + --space_id \ + --id \ + --access_token +SpacesProjectsList: + lang: CLI v2 + source: |- + phrase spaces projects_list \ + --account_id \ + --space_id \ + --page "1" \ + --per_page "25" \ + --access_token +StyleguideCreate: + 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 +StyleguideDelete: + lang: CLI v2 + source: |- + phrase style_guides delete \ + --project_id \ + --id \ + --access_token +StyleguideShow: + lang: CLI v2 + source: |- + phrase style_guides show \ + --project_id \ + --id \ + --access_token +StyleguideUpdate: + 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 +StyleguidesList: + lang: CLI v2 + source: |- + phrase style_guides list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --access_token +TagCreate: + lang: CLI v2 + source: |- + phrase tags create \ + --project_id \ + --data '{ "branch": "my-feature-branch", "name": "my-feature" }' \ + --access_token +TagDelete: + lang: CLI v2 + source: |- + phrase tags delete \ + --project_id \ + --name \ + --branch "my-feature-branch" \ + --access_token +TagShow: + lang: CLI v2 + source: |- + phrase tags show \ + --project_id \ + --name \ + --omit_statistics true \ + --branch "my-feature-branch" \ + --access_token +TagsList: + 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 +TeamCreate: + lang: CLI v2 + source: |- + phrase teams create \ + --account_id \ + --data '{ "name": "German Translators" }' \ + --access_token +TeamDelete: + lang: CLI v2 + source: |- + phrase teams delete \ + --account_id \ + --id \ + --access_token +TeamShow: + lang: CLI v2 + source: |- + phrase teams show \ + --account_id \ + --id \ + --access_token +TeamUpdate: + lang: CLI v2 + source: |- + phrase teams update \ + --account_id \ + --id \ + --data '{ "name": "German Translators" }' \ + --access_token +TeamsList: + lang: CLI v2 + source: |- + phrase teams list \ + --account_id \ + --page "1" \ + --per_page "25" \ + --access_token +TeamsProjectsCreate: + lang: CLI v2 + source: |- + phrase teams projects_create \ + --account_id \ + --team_id \ + --data '{ "id": "a4b3c2d1" }' \ + --access_token +TeamsProjectsDelete: + lang: CLI v2 + source: |- + phrase teams projects_delete \ + --account_id \ + --team_id \ + --id \ + --access_token +TeamsSpacesCreate: + lang: CLI v2 + source: |- + phrase teams spaces_create \ + --account_id \ + --team_id \ + --data '{ "id": "a4b3c2d1" }' \ + --access_token +TeamsSpacesDelete: + lang: CLI v2 + source: |- + phrase teams spaces_delete \ + --account_id \ + --team_id \ + --id \ + --access_token +TeamsUsersCreate: + lang: CLI v2 + source: |- + phrase teams users_create \ + --account_id \ + --team_id \ + --data '{ "id": "a4b3c2d1" }' \ + --access_token +TeamsUsersDelete: + lang: CLI v2 + source: |- + phrase teams users_delete \ + --account_id \ + --team_id \ + --id \ + --access_token +TranslationCreate: + 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 +TranslationExclude: + lang: CLI v2 + source: |- + phrase translations exclude \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +TranslationInclude: + lang: CLI v2 + source: |- + phrase translations include \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +TranslationReview: + lang: CLI v2 + source: |- + phrase translations review \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +TranslationShow: + lang: CLI v2 + source: |- + phrase translations show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +TranslationUnreview: + lang: CLI v2 + source: |- + phrase translations unreview \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +TranslationUnverify: + lang: CLI v2 + source: |- + phrase translations unverify \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +TranslationUpdate: + 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 +TranslationVerify: + lang: CLI v2 + source: |- + phrase translations verify \ + --project_id \ + --id \ + --data '{ "branch": "my-feature-branch" }' \ + --access_token +TranslationsByKey: + 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 +TranslationsByLocale: + 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 +TranslationsExcludeCollection: + 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 +TranslationsIncludeCollection: + 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 +TranslationsList: + lang: CLI v2 + source: |- + phrase translations list \ + --project_id \ + --If-Modified-Since "ifModifiedSince_example" \ + --If-None-Match "ifNoneMatch_example" \ + --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 +TranslationsReviewCollection: + lang: CLI v2 + source: |- + phrase translations review-collection \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "PhraseApp*%reviewed:false%20tags:feature,center" }' \ + --access_token +TranslationsSearch: + 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 +TranslationsUnreviewCollection: + lang: CLI v2 + source: |- + phrase translations unreview-collection \ + --project_id \ + --data '{ "branch": "my-feature-branch", "q": "PhraseApp*%reviewed:true%20tags:feature,center" }' \ + --access_token +TranslationsUnverifyCollection: + 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 +TranslationsVerifyCollection: + 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 +UploadBatchesCreate: + 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 +UploadCreate: + 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 +UploadShow: + lang: CLI v2 + source: |- + phrase uploads show \ + --project_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +UploadsList: + lang: CLI v2 + source: |- + phrase uploads list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --branch "my-feature-branch" \ + --access_token +ShowUser: + lang: CLI v2 + source: |- + phrase users user \ + --access_token +VariableCreate: + lang: CLI v2 + source: |- + phrase variables create \ + --project_id \ + --data '{ "name": "MY_VARIABLE", "value": "Hello World" }' \ + --access_token +VariableDelete: + lang: CLI v2 + source: |- + phrase variables delete \ + --project_id \ + --name \ + --access_token +VariableShow: + lang: CLI v2 + source: |- + phrase variables show \ + --project_id \ + --name \ + --access_token +VariableUpdate: + lang: CLI v2 + source: |- + phrase variables update \ + --project_id \ + --name \ + --data '{ "name": "MY_VARIABLE", "value": "Hello World" }' \ + --access_token +VariablesList: + lang: CLI v2 + source: |- + phrase variables list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --access_token +VersionShow: + lang: CLI v2 + source: |- + phrase versions_history show \ + --project_id \ + --translation_id \ + --id \ + --branch "my-feature-branch" \ + --access_token +VersionsList: + 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 +WebhookDeliveriesList: + lang: CLI v2 + source: |- + phrase webhook_deliveries list \ + --project_id \ + --webhook_id \ + --response_status_codes "responseStatusCodes_example" \ + --access_token +WebhookDeliveriesRedeliver: + lang: CLI v2 + source: |- + phrase webhook_deliveries redeliver \ + --project_id \ + --webhook_id \ + --id \ + --access_token +WebhookDeliveriesShow: + lang: CLI v2 + source: |- + phrase webhook_deliveries show \ + --project_id \ + --webhook_id \ + --id \ + --access_token +WebhookCreate: + 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 +WebhookDelete: + lang: CLI v2 + source: |- + phrase webhooks delete \ + --project_id \ + --id \ + --access_token +WebhookShow: + lang: CLI v2 + source: |- + phrase webhooks show \ + --project_id \ + --id \ + --access_token +WebhookTest: + lang: CLI v2 + source: |- + phrase webhooks test \ + --project_id \ + --id \ + --access_token +WebhookUpdate: + 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 +WebhooksList: + lang: CLI v2 + source: |- + phrase webhooks list \ + --project_id \ + --page "1" \ + --per_page "25" \ + --access_token + diff --git a/openapi-generator/cli_lang.yaml b/openapi-generator/cli_lang.yaml index 5b7b4e6d..64fdb90c 100644 --- a/openapi-generator/cli_lang.yaml +++ b/openapi-generator/cli_lang.yaml @@ -5,3 +5,7 @@ packageName: phrase packageVersion: 2.66.0 templateDir: openapi-generator/templates/cli apiNameSuffix: Api +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..98c76e9c --- /dev/null +++ b/openapi-generator/templates/TEMPLATING.md @@ -0,0 +1,205 @@ +# 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 the config's `files:` key: + ```yaml + files: + cli_examples.handlebars: + destinationFilename: ../../examples/cli.yaml # relative to outputDir + templateType: SupportingFiles + ``` + NB: `destinationFilename` is relative to the generator's `-o` outputDir. The + `cli` Makefile target uses `-o tmp/cli`, so `../../examples/cli.yaml` lands at + repo root. Verify the path for whichever target runs it. +3. The generator can only write **one file per template invocation** — there is no + per-operation file output. Emit one combined file keyed by `operationId` + (PascalCase, e.g. `ScreenshotShow`). + +### Referencing generated samples back into the spec + +`x-code-samples[].source` is a plain string — a `$ref` there is ignored. But a +`$ref` as a **whole array element** resolves (the bundler expands any `$ref` it +finds, regardless of OpenAPI schema position). Both forms work and bundle + +validate cleanly: + +```yaml +x-code-samples: +- lang: Curl + source: |- ... +- "$ref": "../../examples/cli.yaml#/ScreenshotShow" # JSON-pointer into combined file +``` + +The relative depth must match the path file's nesting (`paths/a/b.yaml` → +`../../`, `paths/a/b/c.yaml` → `../../../`). + +## 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..b08dba53 --- /dev/null +++ b/openapi-generator/templates/cli/cli_examples.handlebars @@ -0,0 +1,8 @@ +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}{{operationId}}: + lang: CLI v2 + source: |- + phrase {{{vendorExtensions.[x-cli-command]}}}{{#allParams}}{{^isBodyParam}}{{#unless (eq baseName "X-PhraseApp-OTP")}} \ + --{{baseName}} {{#isBinary}}<{{baseName}}>{{/isBinary}}{{^isBinary}}{{#isPathParam}}<{{baseName}}>{{/isPathParam}}{{^isPathParam}}{{#isMap}}'{ }'{{/isMap}}{{^isMap}}{{#isBoolean}}{{{example}}}{{/isBoolean}}{{^isBoolean}}{{#example}}"{{{.}}}"{{/example}}{{^example}}<{{baseName}}>{{/example}}{{/isBoolean}}{{/isMap}}{{/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/paths/accounts/index.yaml b/paths/accounts/index.yaml index a741edeb..61fdff03 100644 --- a/paths/accounts/index.yaml +++ b/paths/accounts/index.yaml @@ -44,8 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/AccountsList" +x-cli-command: accounts list x-cli-version: '2.5' diff --git a/paths/accounts/locales.yaml b/paths/accounts/locales.yaml index b5366fce..14825620 100644 --- a/paths/accounts/locales.yaml +++ b/paths/accounts/locales.yaml @@ -45,9 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/AccountLocales" +x-cli-command: locales locales x-cli-version: '2.5' diff --git a/paths/accounts/show.yaml b/paths/accounts/show.yaml index 2599fcb8..f682b729 100644 --- a/paths/accounts/show.yaml +++ b/paths/accounts/show.yaml @@ -37,9 +37,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/AccountShow" +x-cli-command: accounts show x-cli-version: '2.5' diff --git a/paths/authorizations/create.yaml b/paths/authorizations/create.yaml index 2f471c0c..16ae7376 100644 --- a/paths/authorizations/create.yaml +++ b/paths/authorizations/create.yaml @@ -41,10 +41,7 @@ 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"}' +- "$ref": "../../examples/cli.yaml#/AuthorizationCreate" requestBody: required: true content: @@ -77,4 +74,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..a9bb8760 100644 --- a/paths/authorizations/destroy.yaml +++ b/paths/authorizations/destroy.yaml @@ -29,8 +29,6 @@ x-code-samples: curl "https://api.phrase.com/v2/authorizations/:id" \ -u USERNAME \ -X DELETE -- lang: CLI v2 - source: |- - phrase authorizations delete \ - --id +- "$ref": "../../examples/cli.yaml#/AuthorizationDelete" +x-cli-command: authorizations delete x-cli-version: '2.5' diff --git a/paths/authorizations/index.yaml b/paths/authorizations/index.yaml index e4d7092a..4f77cf7a 100644 --- a/paths/authorizations/index.yaml +++ b/paths/authorizations/index.yaml @@ -44,6 +44,6 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/authorizations" \ -u USERNAME -- lang: CLI v2 - source: phrase authorizations list +- "$ref": "../../examples/cli.yaml#/AuthorizationsList" +x-cli-command: authorizations list x-cli-version: '2.5' diff --git a/paths/authorizations/show.yaml b/paths/authorizations/show.yaml index 73a27a99..cabf3553 100644 --- a/paths/authorizations/show.yaml +++ b/paths/authorizations/show.yaml @@ -37,8 +37,6 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/authorizations/:id" \ -u USERNAME -- lang: CLI v2 - source: |- - phrase authorizations show \ - --id +- "$ref": "../../examples/cli.yaml#/AuthorizationShow" +x-cli-command: authorizations show x-cli-version: '2.5' diff --git a/paths/authorizations/update.yaml b/paths/authorizations/update.yaml index 8e859b5b..0de6d9e7 100644 --- a/paths/authorizations/update.yaml +++ b/paths/authorizations/update.yaml @@ -42,11 +42,7 @@ 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"}' +- "$ref": "../../examples/cli.yaml#/AuthorizationUpdate" requestBody: required: true content: @@ -77,4 +73,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..d2f01ff5 100644 --- a/paths/automations/activate.yaml +++ b/paths/automations/activate.yaml @@ -45,9 +45,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/AutomationActivate" +x-cli-command: automations activate diff --git a/paths/automations/create.yaml b/paths/automations/create.yaml index c1619eac..4ee4a631 100644 --- a/paths/automations/create.yaml +++ b/paths/automations/create.yaml @@ -113,9 +113,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/AutomationCreate" +x-cli-command: automations create diff --git a/paths/automations/deactivate.yaml b/paths/automations/deactivate.yaml index 4398e722..b05096c6 100644 --- a/paths/automations/deactivate.yaml +++ b/paths/automations/deactivate.yaml @@ -45,9 +45,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/AutomationDeactivate" +x-cli-command: automations deactivate diff --git a/paths/automations/destroy.yaml b/paths/automations/destroy.yaml index 17533dd4..bf8c14a7 100644 --- a/paths/automations/destroy.yaml +++ b/paths/automations/destroy.yaml @@ -32,9 +32,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/AutomationDelete" +x-cli-command: automations delete diff --git a/paths/automations/index.yaml b/paths/automations/index.yaml index ffafbfee..390def8f 100644 --- a/paths/automations/index.yaml +++ b/paths/automations/index.yaml @@ -48,10 +48,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/AutomationsList" +x-cli-command: automations list diff --git a/paths/automations/show.yaml b/paths/automations/show.yaml index 86b0f856..5f22d53c 100644 --- a/paths/automations/show.yaml +++ b/paths/automations/show.yaml @@ -41,9 +41,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/AutomationShow" +x-cli-command: automations show diff --git a/paths/automations/trigger.yaml b/paths/automations/trigger.yaml index 1796a644..f1820892 100644 --- a/paths/automations/trigger.yaml +++ b/paths/automations/trigger.yaml @@ -32,9 +32,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/AutomationTrigger" +x-cli-command: automations trigger diff --git a/paths/automations/update.yaml b/paths/automations/update.yaml index c3eaa830..bb778a6d 100644 --- a/paths/automations/update.yaml +++ b/paths/automations/update.yaml @@ -111,10 +111,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/AutomationUpdate" +x-cli-command: automations update diff --git a/paths/blacklisted_keys/create.yaml b/paths/blacklisted_keys/create.yaml index d529f808..a30b38ba 100644 --- a/paths/blacklisted_keys/create.yaml +++ b/paths/blacklisted_keys/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/BlacklistedKeyCreate" requestBody: required: true content: @@ -62,4 +57,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..00748f7a 100644 --- a/paths/blacklisted_keys/destroy.yaml +++ b/paths/blacklisted_keys/destroy.yaml @@ -30,10 +30,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/BlacklistedKeyDelete" +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..1b80207a 100644 --- a/paths/blacklisted_keys/index.yaml +++ b/paths/blacklisted_keys/index.yaml @@ -51,9 +51,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/BlacklistedKeysList" +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..2dbb9eea 100644 --- a/paths/blacklisted_keys/show.yaml +++ b/paths/blacklisted_keys/show.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/BlacklistedKeyShow" +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..5795f746 100644 --- a/paths/blacklisted_keys/update.yaml +++ b/paths/blacklisted_keys/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/BlacklistedKeyUpdate" requestBody: required: true content: @@ -62,4 +56,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..65f3f756 100644 --- a/paths/branches/compare.yaml +++ b/paths/branches/compare.yaml @@ -45,11 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchCompare" +x-cli-command: branches compare x-cli-version: '2.5' diff --git a/paths/branches/create.yaml b/paths/branches/create.yaml index 95074874..6db84675 100644 --- a/paths/branches/create.yaml +++ b/paths/branches/create.yaml @@ -49,12 +49,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchCreate" requestBody: required: true content: @@ -73,4 +68,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..6abc3782 100644 --- a/paths/branches/create_comparison.yaml +++ b/paths/branches/create_comparison.yaml @@ -29,12 +29,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchComparisonCreate" requestBody: required: true content: @@ -48,3 +43,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..4c05f188 100644 --- a/paths/branches/destroy.yaml +++ b/paths/branches/destroy.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchDelete" +x-cli-command: branches delete x-cli-version: '2.5' diff --git a/paths/branches/index.yaml b/paths/branches/index.yaml index 08836350..be8f95d5 100644 --- a/paths/branches/index.yaml +++ b/paths/branches/index.yaml @@ -48,9 +48,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchesList" +x-cli-command: branches list x-cli-version: '2.5' diff --git a/paths/branches/merge.yaml b/paths/branches/merge.yaml index a09b5be4..53c5c039 100644 --- a/paths/branches/merge.yaml +++ b/paths/branches/merge.yaml @@ -51,13 +51,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchMerge" requestBody: required: true content: @@ -74,3 +68,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..05d03dcf 100644 --- a/paths/branches/show.yaml +++ b/paths/branches/show.yaml @@ -41,10 +41,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchShow" +x-cli-command: branches show x-cli-version: '2.5' diff --git a/paths/branches/sync.yaml b/paths/branches/sync.yaml index 9317f0bb..b70dfc7e 100644 --- a/paths/branches/sync.yaml +++ b/paths/branches/sync.yaml @@ -46,13 +46,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchSync" requestBody: required: true content: @@ -69,3 +63,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..6b3c9d50 100644 --- a/paths/branches/update.yaml +++ b/paths/branches/update.yaml @@ -46,13 +46,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/BranchUpdate" requestBody: required: true content: @@ -65,4 +59,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..4c18a0ed 100644 --- a/paths/comment_reactions/create.yaml +++ b/paths/comment_reactions/create.yaml @@ -51,12 +51,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReactionCreate" +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..09036ebf 100644 --- a/paths/comment_reactions/destroy.yaml +++ b/paths/comment_reactions/destroy.yaml @@ -35,13 +35,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReactionDelete" +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..3faa98d9 100644 --- a/paths/comment_reactions/index.yaml +++ b/paths/comment_reactions/index.yaml @@ -53,12 +53,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReactionsList" +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..d7e3ea10 100644 --- a/paths/comment_reactions/show.yaml +++ b/paths/comment_reactions/show.yaml @@ -46,13 +46,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReactionShow" +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..137a0386 100644 --- a/paths/comment_replies/create.yaml +++ b/paths/comment_replies/create.yaml @@ -57,12 +57,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReplyCreate" +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..ce3046fb 100644 --- a/paths/comment_replies/destroy.yaml +++ b/paths/comment_replies/destroy.yaml @@ -35,13 +35,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReplyDelete" +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..fe242d37 100644 --- a/paths/comment_replies/index.yaml +++ b/paths/comment_replies/index.yaml @@ -71,15 +71,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/RepliesList" +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..cff7d2bc 100644 --- a/paths/comment_replies/mark_as_read.yaml +++ b/paths/comment_replies/mark_as_read.yaml @@ -35,13 +35,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReplyMarkAsRead" +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..b645a5f0 100644 --- a/paths/comment_replies/mark_as_unread.yaml +++ b/paths/comment_replies/mark_as_unread.yaml @@ -35,13 +35,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReplyMarkAsUnread" +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..700a1bac 100644 --- a/paths/comment_replies/show.yaml +++ b/paths/comment_replies/show.yaml @@ -46,13 +46,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReplyShow" +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..f0f8fdb6 100644 --- a/paths/comments/check_if_read.yaml +++ b/paths/comments/check_if_read.yaml @@ -34,12 +34,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CommentMarkCheck" +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..66e4d7ed 100644 --- a/paths/comments/create.yaml +++ b/paths/comments/create.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/CommentCreate" requestBody: required: true content: @@ -76,4 +70,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..5efda9c2 100644 --- a/paths/comments/destroy.yaml +++ b/paths/comments/destroy.yaml @@ -39,12 +39,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CommentDelete" +x-cli-command: comments delete x-cli-version: '2.5' diff --git a/paths/comments/index.yaml b/paths/comments/index.yaml index aa2240e7..99f76640 100644 --- a/paths/comments/index.yaml +++ b/paths/comments/index.yaml @@ -89,15 +89,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/CommentsList" +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..6d11952e 100644 --- a/paths/comments/mark_as_read.yaml +++ b/paths/comments/mark_as_read.yaml @@ -33,14 +33,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/CommentMarkRead" requestBody: required: true content: @@ -53,4 +46,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..78401b51 100644 --- a/paths/comments/show.yaml +++ b/paths/comments/show.yaml @@ -45,12 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CommentShow" +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..f2d10a4e 100644 --- a/paths/comments/unmark_as_read.yaml +++ b/paths/comments/unmark_as_read.yaml @@ -39,12 +39,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CommentMarkUnread" +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..93327428 100644 --- a/paths/comments/update.yaml +++ b/paths/comments/update.yaml @@ -44,14 +44,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/CommentUpdate" requestBody: required: true content: @@ -68,4 +61,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..5019c3a1 100644 --- a/paths/custom_metadata_properties/create.yaml +++ b/paths/custom_metadata_properties/create.yaml @@ -77,10 +77,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertyCreate" +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..9a5b9b6a 100644 --- a/paths/custom_metadata_properties/destroy.yaml +++ b/paths/custom_metadata_properties/destroy.yaml @@ -27,10 +27,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertiesDelete" +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..e5396cf9 100644 --- a/paths/custom_metadata_properties/index.yaml +++ b/paths/custom_metadata_properties/index.yaml @@ -68,15 +68,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertiesList" +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..670efd44 100644 --- a/paths/custom_metadata_properties/show.yaml +++ b/paths/custom_metadata_properties/show.yaml @@ -33,10 +33,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertyShow" +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..ada9931c 100644 --- a/paths/custom_metadata_properties/update.yaml +++ b/paths/custom_metadata_properties/update.yaml @@ -70,11 +70,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertyUpdate" +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..5070bd19 100644 --- a/paths/distributions/create.yaml +++ b/paths/distributions/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/DistributionCreate" requestBody: required: true content: @@ -96,7 +91,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 +109,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..85e7e5f0 100644 --- a/paths/distributions/destroy.yaml +++ b/paths/distributions/destroy.yaml @@ -30,10 +30,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/DistributionDelete" +x-cli-command: distributions delete x-cli-version: '2.5' diff --git a/paths/distributions/index.yaml b/paths/distributions/index.yaml index 08603d00..4b632ccc 100644 --- a/paths/distributions/index.yaml +++ b/paths/distributions/index.yaml @@ -45,9 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/DistributionsList" +x-cli-command: distributions list x-cli-version: '2.5' diff --git a/paths/distributions/show.yaml b/paths/distributions/show.yaml index 6040129f..0a23437c 100644 --- a/paths/distributions/show.yaml +++ b/paths/distributions/show.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/DistributionShow" +x-cli-command: distributions show x-cli-version: '2.5' diff --git a/paths/distributions/update.yaml b/paths/distributions/update.yaml index a533440d..b2e03586 100644 --- a/paths/distributions/update.yaml +++ b/paths/distributions/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/DistributionUpdate" requestBody: required: true content: @@ -88,7 +82,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 +100,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..fa2e8402 100644 --- a/paths/documents/destroy.yaml +++ b/paths/documents/destroy.yaml @@ -31,10 +31,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/DocumentDelete" +x-cli-command: documents delete x-cli-version: '2.5' diff --git a/paths/documents/index.yaml b/paths/documents/index.yaml index 718672f5..f6a96475 100644 --- a/paths/documents/index.yaml +++ b/paths/documents/index.yaml @@ -52,9 +52,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/DocumentsList" +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..655aee0d 100644 --- a/paths/figma_attachment_keys/create.yaml +++ b/paths/figma_attachment_keys/create.yaml @@ -33,12 +33,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/FigmaAttachmentAttachToKey" +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..e986ca87 100644 --- a/paths/figma_attachment_keys/destroy.yaml +++ b/paths/figma_attachment_keys/destroy.yaml @@ -32,12 +32,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/FigmaAttachmentDetachFromKey" +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..dfb06872 100644 --- a/paths/figma_attachments/create.yaml +++ b/paths/figma_attachments/create.yaml @@ -48,12 +48,7 @@ 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 + - "$ref": "../../examples/cli.yaml#/FigmaAttachmentCreate" requestBody: required: true content: @@ -72,4 +67,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..929bd57e 100644 --- a/paths/figma_attachments/destroy.yaml +++ b/paths/figma_attachments/destroy.yaml @@ -38,11 +38,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/FigmaAttachmentDelete" +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..59a7f7f1 100644 --- a/paths/figma_attachments/index.yaml +++ b/paths/figma_attachments/index.yaml @@ -52,10 +52,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/FigmaAttachmentsList" +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..754cdbf5 100644 --- a/paths/figma_attachments/show.yaml +++ b/paths/figma_attachments/show.yaml @@ -45,11 +45,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/FigmaAttachmentShow" +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..164f28ed 100644 --- a/paths/figma_attachments/update.yaml +++ b/paths/figma_attachments/update.yaml @@ -49,13 +49,7 @@ 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 + - "$ref": "../../examples/cli.yaml#/FigmaAttachmentUpdate" 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 update x-cli-version: "2.13" diff --git a/paths/formats/index.yaml b/paths/formats/index.yaml index b8aa4a98..2b651051 100644 --- a/paths/formats/index.yaml +++ b/paths/formats/index.yaml @@ -55,8 +55,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/FormatsList" +x-cli-command: formats list x-cli-version: '2.5' diff --git a/paths/glossaries/create.yaml b/paths/glossaries/create.yaml index 3c8313d0..6574d868 100644 --- a/paths/glossaries/create.yaml +++ b/paths/glossaries/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryCreate" requestBody: required: true content: @@ -74,4 +69,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..6e2c5ab1 100644 --- a/paths/glossaries/destroy.yaml +++ b/paths/glossaries/destroy.yaml @@ -30,10 +30,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryDelete" +x-cli-command: glossaries delete x-cli-version: '2.5' diff --git a/paths/glossaries/index.yaml b/paths/glossaries/index.yaml index 08c237df..1e2417cb 100644 --- a/paths/glossaries/index.yaml +++ b/paths/glossaries/index.yaml @@ -45,9 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossariesList" +x-cli-command: glossaries list x-cli-version: '2.5' diff --git a/paths/glossaries/show.yaml b/paths/glossaries/show.yaml index 6159c2f7..80251636 100644 --- a/paths/glossaries/show.yaml +++ b/paths/glossaries/show.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryShow" +x-cli-command: glossaries show x-cli-version: '2.5' diff --git a/paths/glossaries/update.yaml b/paths/glossaries/update.yaml index 3d52c0e1..bf59de4d 100644 --- a/paths/glossaries/update.yaml +++ b/paths/glossaries/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryUpdate" requestBody: required: true content: @@ -74,4 +68,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..cdebb089 100644 --- a/paths/glossary_term_translations/create.yaml +++ b/paths/glossary_term_translations/create.yaml @@ -44,14 +44,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryTermTranslationCreate" requestBody: required: true content: @@ -71,4 +64,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..d22b0fcb 100644 --- a/paths/glossary_term_translations/destroy.yaml +++ b/paths/glossary_term_translations/destroy.yaml @@ -32,12 +32,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryTermTranslationDelete" +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..0ea5e711 100644 --- a/paths/glossary_term_translations/update.yaml +++ b/paths/glossary_term_translations/update.yaml @@ -45,15 +45,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryTermTranslationUpdate" requestBody: required: true content: @@ -70,4 +62,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..ee77bfca 100644 --- a/paths/glossary_terms/create.yaml +++ b/paths/glossary_terms/create.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryTermCreate" requestBody: required: true content: @@ -76,4 +70,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..e5217b85 100644 --- a/paths/glossary_terms/destroy.yaml +++ b/paths/glossary_terms/destroy.yaml @@ -31,11 +31,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryTermDelete" +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..fb196212 100644 --- a/paths/glossary_terms/index.yaml +++ b/paths/glossary_terms/index.yaml @@ -46,10 +46,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryTermsList" +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..f000926c 100644 --- a/paths/glossary_terms/show.yaml +++ b/paths/glossary_terms/show.yaml @@ -39,11 +39,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryTermShow" +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..7c4ff563 100644 --- a/paths/glossary_terms/update.yaml +++ b/paths/glossary_terms/update.yaml @@ -44,14 +44,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/GlossaryTermUpdate" 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 update x-cli-version: '2.5' diff --git a/paths/icu/skeleton.yaml b/paths/icu/skeleton.yaml index 11b87eb0..4331b7aa 100644 --- a/paths/icu/skeleton.yaml +++ b/paths/icu/skeleton.yaml @@ -41,11 +41,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/IcuSkeleton" requestBody: required: true content: @@ -88,4 +84,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..d856247f 100644 --- a/paths/invitations/create.yaml +++ b/paths/invitations/create.yaml @@ -41,12 +41,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/InvitationCreate" requestBody: required: true content: @@ -106,4 +101,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..c5893068 100644 --- a/paths/invitations/destroy.yaml +++ b/paths/invitations/destroy.yaml @@ -29,10 +29,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/InvitationDelete" +x-cli-command: invitations delete x-cli-version: '2.5' diff --git a/paths/invitations/index.yaml b/paths/invitations/index.yaml index b3a8acd9..3a1ee5d8 100644 --- a/paths/invitations/index.yaml +++ b/paths/invitations/index.yaml @@ -44,9 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/InvitationsList" +x-cli-command: invitations list x-cli-version: '2.5' diff --git a/paths/invitations/resend.yaml b/paths/invitations/resend.yaml index e1bb4de5..6e30163a 100644 --- a/paths/invitations/resend.yaml +++ b/paths/invitations/resend.yaml @@ -40,10 +40,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/InvitationResend" +x-cli-command: invitations resend x-cli-version: '2.5' diff --git a/paths/invitations/show.yaml b/paths/invitations/show.yaml index ed35394e..79b4bbda 100644 --- a/paths/invitations/show.yaml +++ b/paths/invitations/show.yaml @@ -37,10 +37,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/InvitationShow" +x-cli-command: invitations show x-cli-version: '2.5' diff --git a/paths/invitations/update.yaml b/paths/invitations/update.yaml index 19807f82..c788a818 100644 --- a/paths/invitations/update.yaml +++ b/paths/invitations/update.yaml @@ -42,13 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/InvitationUpdate" requestBody: required: true content: @@ -100,4 +94,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..398ca05e 100644 --- a/paths/invitations/update_settings.yaml +++ b/paths/invitations/update_settings.yaml @@ -42,13 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/InvitationUpdateSettings" requestBody: required: true content: @@ -69,4 +63,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..6c4f2f4a 100644 --- a/paths/job_annotations/destroy.yaml +++ b/paths/job_annotations/destroy.yaml @@ -37,11 +37,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobAnnotationDelete" +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..85bf5562 100644 --- a/paths/job_annotations/index.yaml +++ b/paths/job_annotations/index.yaml @@ -31,10 +31,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobAnnotationsList" +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..3797486f 100644 --- a/paths/job_annotations/update.yaml +++ b/paths/job_annotations/update.yaml @@ -42,14 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobAnnotationUpdate" requestBody: required: true content: @@ -66,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_comments/create.yaml b/paths/job_comments/create.yaml index 58a055c9..44515f65 100644 --- a/paths/job_comments/create.yaml +++ b/paths/job_comments/create.yaml @@ -36,13 +36,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobCommentCreate" requestBody: required: true content: @@ -59,4 +53,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..06588135 100644 --- a/paths/job_comments/destroy.yaml +++ b/paths/job_comments/destroy.yaml @@ -27,12 +27,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobCommentDelete" +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..d2ef9683 100644 --- a/paths/job_comments/index.yaml +++ b/paths/job_comments/index.yaml @@ -46,12 +46,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobCommentsList" +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..f59aaae9 100644 --- a/paths/job_comments/show.yaml +++ b/paths/job_comments/show.yaml @@ -35,12 +35,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobCommentShow" +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..9470b22f 100644 --- a/paths/job_comments/update.yaml +++ b/paths/job_comments/update.yaml @@ -37,14 +37,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobCommentUpdate" requestBody: required: true content: @@ -61,4 +54,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..a41d80cc 100644 --- a/paths/job_locale_annotations/destroy.yaml +++ b/paths/job_locale_annotations/destroy.yaml @@ -38,12 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleAnnotationDelete" +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..3f6afdcb 100644 --- a/paths/job_locale_annotations/index.yaml +++ b/paths/job_locale_annotations/index.yaml @@ -32,11 +32,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleAnnotationsList" +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..28822dfa 100644 --- a/paths/job_locale_annotations/update.yaml +++ b/paths/job_locale_annotations/update.yaml @@ -43,15 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleAnnotationUpdate" requestBody: required: true content: @@ -68,4 +60,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..7a39934b 100644 --- a/paths/job_locales/complete.yaml +++ b/paths/job_locales/complete.yaml @@ -37,14 +37,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleComplete" requestBody: required: true content: @@ -57,4 +50,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..78eb5e3c 100644 --- a/paths/job_locales/complete_review.yaml +++ b/paths/job_locales/complete_review.yaml @@ -37,14 +37,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleCompleteReview" requestBody: required: true content: @@ -57,4 +50,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..4d79a0d1 100644 --- a/paths/job_locales/create.yaml +++ b/paths/job_locales/create.yaml @@ -36,13 +36,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocalesCreate" requestBody: required: true content: @@ -89,4 +83,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..5b6c319c 100644 --- a/paths/job_locales/destroy.yaml +++ b/paths/job_locales/destroy.yaml @@ -27,12 +27,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleDelete" +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..105cdfc5 100644 --- a/paths/job_locales/index.yaml +++ b/paths/job_locales/index.yaml @@ -43,11 +43,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocalesList" +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..d6f62cb4 100644 --- a/paths/job_locales/reopen.yaml +++ b/paths/job_locales/reopen.yaml @@ -37,14 +37,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleReopen" requestBody: required: true content: @@ -57,4 +50,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..f68e4cb4 100644 --- a/paths/job_locales/show.yaml +++ b/paths/job_locales/show.yaml @@ -36,12 +36,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleShow" +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..2708b1ed 100644 --- a/paths/job_locales/update.yaml +++ b/paths/job_locales/update.yaml @@ -37,14 +37,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLocaleUpdate" requestBody: required: true content: @@ -89,4 +82,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..02fc0f42 100644 --- a/paths/job_template_locales/create.yaml +++ b/paths/job_template_locales/create.yaml @@ -36,13 +36,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobTemplateLocalesCreate" requestBody: required: true content: @@ -89,4 +83,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..7f21dda9 100644 --- a/paths/job_template_locales/destroy.yaml +++ b/paths/job_template_locales/destroy.yaml @@ -32,12 +32,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobTemplateLocaleDelete" +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..dda1a873 100644 --- a/paths/job_template_locales/index.yaml +++ b/paths/job_template_locales/index.yaml @@ -47,11 +47,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobTemplateLocalesList" +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..9a419b5b 100644 --- a/paths/job_template_locales/show.yaml +++ b/paths/job_template_locales/show.yaml @@ -40,12 +40,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobTemplateLocaleShow" +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..4b75f92f 100644 --- a/paths/job_template_locales/update.yaml +++ b/paths/job_template_locales/update.yaml @@ -37,14 +37,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobTemplateLocaleUpdate" requestBody: required: true content: @@ -89,4 +82,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..62561bcb 100644 --- a/paths/job_templates/create.yaml +++ b/paths/job_templates/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobTemplateCreate" requestBody: required: true content: @@ -78,4 +73,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..f991b896 100644 --- a/paths/job_templates/destroy.yaml +++ b/paths/job_templates/destroy.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobTemplateDelete" +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..c7317402 100644 --- a/paths/job_templates/index.yaml +++ b/paths/job_templates/index.yaml @@ -51,10 +51,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/JobTemplatesList" +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..fdff761d 100644 --- a/paths/job_templates/show.yaml +++ b/paths/job_templates/show.yaml @@ -44,11 +44,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/JobTemplatesShow" +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..0cf1a889 100644 --- a/paths/job_templates/update.yaml +++ b/paths/job_templates/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobTemplateUpdate" requestBody: required: true content: @@ -80,4 +74,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..08d82620 100644 --- a/paths/jobs/add_keys.yaml +++ b/paths/jobs/add_keys.yaml @@ -36,13 +36,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobKeysCreate" requestBody: required: true content: @@ -62,4 +56,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..4f4e26c6 100644 --- a/paths/jobs/complete.yaml +++ b/paths/jobs/complete.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobComplete" requestBody: required: true content: @@ -62,4 +56,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..5d99e924 100644 --- a/paths/jobs/create.yaml +++ b/paths/jobs/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobCreate" requestBody: required: true content: @@ -113,4 +108,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..9a4d2162 100644 --- a/paths/jobs/destroy.yaml +++ b/paths/jobs/destroy.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobDelete" +x-cli-command: jobs delete x-cli-version: '2.5' diff --git a/paths/jobs/index.yaml b/paths/jobs/index.yaml index f54925bd..9210f30f 100644 --- a/paths/jobs/index.yaml +++ b/paths/jobs/index.yaml @@ -68,13 +68,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobsList" +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..45c66a68 100644 --- a/paths/jobs/index_account.yaml +++ b/paths/jobs/index_account.yaml @@ -49,12 +49,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobsByAccount" +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..9184c86e 100644 --- a/paths/jobs/lock.yaml +++ b/paths/jobs/lock.yaml @@ -49,11 +49,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobLock" +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..4bfafa61 100644 --- a/paths/jobs/remove_keys.yaml +++ b/paths/jobs/remove_keys.yaml @@ -25,14 +25,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobKeysDelete" requestBody: required: true content: @@ -54,3 +47,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..157457dd 100644 --- a/paths/jobs/reopen.yaml +++ b/paths/jobs/reopen.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobReopen" requestBody: required: true content: @@ -62,4 +56,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..2a641e34 100644 --- a/paths/jobs/show.yaml +++ b/paths/jobs/show.yaml @@ -41,11 +41,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobShow" +x-cli-command: jobs show x-cli-version: '2.5' diff --git a/paths/jobs/start.yaml b/paths/jobs/start.yaml index 8165f70e..43caa08a 100644 --- a/paths/jobs/start.yaml +++ b/paths/jobs/start.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobStart" requestBody: required: true content: @@ -62,4 +56,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..30a5eb80 100644 --- a/paths/jobs/unlock.yaml +++ b/paths/jobs/unlock.yaml @@ -49,11 +49,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobUnlock" +x-cli-command: jobs unlock x-cli-version: '2.5' diff --git a/paths/jobs/update.yaml b/paths/jobs/update.yaml index a7983730..d1b45b3e 100644 --- a/paths/jobs/update.yaml +++ b/paths/jobs/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/JobUpdate" requestBody: required: true content: @@ -91,4 +85,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 ac3303c3..81c7bf7d 100644 --- a/paths/key_links/create.yaml +++ b/paths/key_links/create.yaml @@ -45,3 +45,5 @@ responses: "$ref": "../../responses.yaml#/422" '429': "$ref": "../../responses.yaml#/429" + +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..40d36260 100644 --- a/paths/keys/create.yaml +++ b/paths/keys/create.yaml @@ -49,12 +49,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeyCreate" requestBody: required: true content: @@ -161,4 +156,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..0db920f5 100644 --- a/paths/keys/destroy-collection.yaml +++ b/paths/keys/destroy-collection.yaml @@ -53,12 +53,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeysDeleteCollection" +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..8382369a 100644 --- a/paths/keys/destroy.yaml +++ b/paths/keys/destroy.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeyDelete" +x-cli-command: keys delete x-cli-version: '2.5' diff --git a/paths/keys/exclude.yaml b/paths/keys/exclude.yaml index b68f7dc5..51f60d7e 100644 --- a/paths/keys/exclude.yaml +++ b/paths/keys/exclude.yaml @@ -40,12 +40,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeysExclude" requestBody: required: true content: @@ -81,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 exclude x-cli-version: '2.5' diff --git a/paths/keys/include.yaml b/paths/keys/include.yaml index 69b3b401..12e492e7 100644 --- a/paths/keys/include.yaml +++ b/paths/keys/include.yaml @@ -40,12 +40,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeysInclude" requestBody: required: true content: @@ -82,4 +77,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..19ddf3b4 100644 --- a/paths/keys/index.yaml +++ b/paths/keys/index.yaml @@ -70,14 +70,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeysList" +x-cli-command: keys list x-cli-version: '2.5' diff --git a/paths/keys/search.yaml b/paths/keys/search.yaml index e565c50b..4386f768 100644 --- a/paths/keys/search.yaml +++ b/paths/keys/search.yaml @@ -46,12 +46,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeysSearch" requestBody: required: true content: @@ -95,4 +90,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..70d43809 100644 --- a/paths/keys/show.yaml +++ b/paths/keys/show.yaml @@ -44,11 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeyShow" +x-cli-command: keys show x-cli-version: '2.5' diff --git a/paths/keys/tag.yaml b/paths/keys/tag.yaml index cc025038..73e72313 100644 --- a/paths/keys/tag.yaml +++ b/paths/keys/tag.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeysTag" requestBody: required: true content: @@ -84,4 +79,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..d5cc78cd 100644 --- a/paths/keys/untag.yaml +++ b/paths/keys/untag.yaml @@ -40,12 +40,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeysUntag" requestBody: required: true content: @@ -81,4 +76,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..7782075a 100644 --- a/paths/keys/update.yaml +++ b/paths/keys/update.yaml @@ -50,13 +50,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/KeyUpdate" requestBody: required: true content: @@ -152,4 +146,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..d25ee5d6 100644 --- a/paths/locale_downloads/create.yaml +++ b/paths/locale_downloads/create.yaml @@ -154,13 +154,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/LocaleDownloadCreate" +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..c7e560c7 100644 --- a/paths/locale_downloads/show.yaml +++ b/paths/locale_downloads/show.yaml @@ -44,11 +44,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/LocaleDownloadShow" +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..ae96edbc 100644 --- a/paths/locales/create.yaml +++ b/paths/locales/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/LocaleCreate" requestBody: required: true content: @@ -107,4 +102,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..12f15895 100644 --- a/paths/locales/destroy.yaml +++ b/paths/locales/destroy.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/LocaleDelete" +x-cli-command: locales delete x-cli-version: '2.5' diff --git a/paths/locales/download.yaml b/paths/locales/download.yaml index f17be581..cb93b7ad 100644 --- a/paths/locales/download.yaml +++ b/paths/locales/download.yaml @@ -198,14 +198,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/LocaleDownload" +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..22119bfe 100644 --- a/paths/locales/index.yaml +++ b/paths/locales/index.yaml @@ -63,10 +63,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/LocalesList" +x-cli-command: locales list x-cli-version: '2.5' diff --git a/paths/locales/show.yaml b/paths/locales/show.yaml index 7281ac65..4d6b3c29 100644 --- a/paths/locales/show.yaml +++ b/paths/locales/show.yaml @@ -44,11 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/LocaleShow" +x-cli-command: locales show x-cli-version: '2.5' diff --git a/paths/locales/update.yaml b/paths/locales/update.yaml index 9752fe8e..4a6cb513 100644 --- a/paths/locales/update.yaml +++ b/paths/locales/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/LocaleUpdate" requestBody: required: true content: @@ -106,4 +100,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..bfd33864 100644 --- a/paths/members/destroy.yaml +++ b/paths/members/destroy.yaml @@ -29,10 +29,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/MemberDelete" +x-cli-command: members delete x-cli-version: '2.5' diff --git a/paths/members/index.yaml b/paths/members/index.yaml index 5076ebd1..60d4cf29 100644 --- a/paths/members/index.yaml +++ b/paths/members/index.yaml @@ -44,9 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/MembersList" +x-cli-command: members list x-cli-version: '2.5' diff --git a/paths/members/show.yaml b/paths/members/show.yaml index 1a6331fb..2aa391bc 100644 --- a/paths/members/show.yaml +++ b/paths/members/show.yaml @@ -37,10 +37,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/MemberShow" +x-cli-command: members show x-cli-version: '2.5' diff --git a/paths/members/update.yaml b/paths/members/update.yaml index 6985d254..3f70f47b 100644 --- a/paths/members/update.yaml +++ b/paths/members/update.yaml @@ -42,13 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/MemberUpdate" requestBody: required: true content: @@ -97,4 +91,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..e66a9b6a 100644 --- a/paths/members/update_settings.yaml +++ b/paths/members/update_settings.yaml @@ -42,13 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/MemberUpdateSettings" requestBody: required: true content: @@ -69,4 +63,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..03f1c9a1 100644 --- a/paths/notification_groups/index.yaml +++ b/paths/notification_groups/index.yaml @@ -44,8 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/NotificationGroupsList" +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..cfaf5e8a 100644 --- a/paths/notification_groups/mark_all_as_read.yaml +++ b/paths/notification_groups/mark_all_as_read.yaml @@ -40,8 +40,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/NotificationGroupsMarkAllAsRead" +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..578257f6 100644 --- a/paths/notification_groups/mark_as_read.yaml +++ b/paths/notification_groups/mark_as_read.yaml @@ -39,9 +39,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/NotificationGroupsMarkAsRead" +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..9b7f9407 100644 --- a/paths/notifications/index.yaml +++ b/paths/notifications/index.yaml @@ -57,8 +57,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/NotificationsList" +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..7506c4b6 100644 --- a/paths/notifications/mark_all_as_read.yaml +++ b/paths/notifications/mark_all_as_read.yaml @@ -40,8 +40,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/NotificationsMarkAllAsRead" +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..9e3f2dfb 100644 --- a/paths/notifications/show.yaml +++ b/paths/notifications/show.yaml @@ -36,9 +36,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/NotificationsShow" +x-cli-command: notifications show x-cli-version: '2.5' diff --git a/paths/orders/confirm.yaml b/paths/orders/confirm.yaml index 347ba7ee..4960b26f 100644 --- a/paths/orders/confirm.yaml +++ b/paths/orders/confirm.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrderConfirm" requestBody: required: true content: @@ -62,4 +56,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..e0d77d30 100644 --- a/paths/orders/create.yaml +++ b/paths/orders/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrderCreate" requestBody: required: true content: @@ -123,4 +118,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..52019012 100644 --- a/paths/orders/destroy.yaml +++ b/paths/orders/destroy.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrderDelete" +x-cli-command: orders delete x-cli-version: '2.5' diff --git a/paths/orders/index.yaml b/paths/orders/index.yaml index d96b75bc..5d68d5fb 100644 --- a/paths/orders/index.yaml +++ b/paths/orders/index.yaml @@ -58,10 +58,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrdersList" +x-cli-command: orders list x-cli-version: '2.5' diff --git a/paths/orders/show.yaml b/paths/orders/show.yaml index c29d878f..a4750f7c 100644 --- a/paths/orders/show.yaml +++ b/paths/orders/show.yaml @@ -44,11 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrderShow" +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..4079c532 100644 --- a/paths/organization_job_template_locales/create.yaml +++ b/paths/organization_job_template_locales/create.yaml @@ -36,13 +36,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocalesCreate" requestBody: required: true content: @@ -90,4 +84,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..3d0db729 100644 --- a/paths/organization_job_template_locales/destroy.yaml +++ b/paths/organization_job_template_locales/destroy.yaml @@ -25,11 +25,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocaleDelete" +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..7262cd89 100644 --- a/paths/organization_job_template_locales/index.yaml +++ b/paths/organization_job_template_locales/index.yaml @@ -41,10 +41,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocalesList" +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..0bb8d91e 100644 --- a/paths/organization_job_template_locales/show.yaml +++ b/paths/organization_job_template_locales/show.yaml @@ -34,11 +34,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocaleShow" +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..a94808ef 100644 --- a/paths/organization_job_template_locales/update.yaml +++ b/paths/organization_job_template_locales/update.yaml @@ -37,14 +37,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocaleUpdate" requestBody: required: true content: @@ -89,4 +82,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..df7e9980 100644 --- a/paths/organization_job_templates/create.yaml +++ b/paths/organization_job_templates/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateCreate" requestBody: required: true content: @@ -70,4 +65,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..7997a534 100644 --- a/paths/organization_job_templates/destroy.yaml +++ b/paths/organization_job_templates/destroy.yaml @@ -31,10 +31,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateDelete" +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..648b9242 100644 --- a/paths/organization_job_templates/index.yaml +++ b/paths/organization_job_templates/index.yaml @@ -45,9 +45,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/OrganizationJobTemplatesList" +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..c0623545 100644 --- a/paths/organization_job_templates/show.yaml +++ b/paths/organization_job_templates/show.yaml @@ -38,10 +38,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/OrganizationJobTemplatesShow" +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..4b6d3d60 100644 --- a/paths/organization_job_templates/update.yaml +++ b/paths/organization_job_templates/update.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateUpdate" requestBody: required: true content: @@ -70,4 +65,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..5b1054ce 100644 --- a/paths/projects/create.yaml +++ b/paths/projects/create.yaml @@ -47,11 +47,7 @@ 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 + - "$ref": "../../examples/cli.yaml#/ProjectCreate" requestBody: required: true content: @@ -207,4 +203,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..788eaa5d 100644 --- a/paths/projects/destroy.yaml +++ b/paths/projects/destroy.yaml @@ -30,9 +30,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ProjectDelete" +x-cli-command: projects delete x-cli-version: '2.5' diff --git a/paths/projects/index.yaml b/paths/projects/index.yaml index eb1af088..c4377046 100644 --- a/paths/projects/index.yaml +++ b/paths/projects/index.yaml @@ -79,8 +79,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ProjectsList" +x-cli-command: projects list x-cli-version: '2.5' diff --git a/paths/projects/show.yaml b/paths/projects/show.yaml index 656e5dab..7c560474 100644 --- a/paths/projects/show.yaml +++ b/paths/projects/show.yaml @@ -37,9 +37,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ProjectShow" +x-cli-command: projects show x-cli-version: '2.5' diff --git a/paths/projects/update.yaml b/paths/projects/update.yaml index f1161b28..b0436bfd 100644 --- a/paths/projects/update.yaml +++ b/paths/projects/update.yaml @@ -43,12 +43,7 @@ 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 + - "$ref": "../../examples/cli.yaml#/ProjectUpdate" requestBody: required: true content: @@ -199,4 +194,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..07cafbe3 100644 --- a/paths/quality_performance_score/index.yaml +++ b/paths/quality_performance_score/index.yaml @@ -41,12 +41,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/QualityPerformanceScoreList" requestBody: required: true content: @@ -60,4 +55,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..bfcc0648 100644 --- a/paths/release_triggers/create.yaml +++ b/paths/release_triggers/create.yaml @@ -81,11 +81,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/ReleaseTriggersCreate" +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..d80ea093 100644 --- a/paths/release_triggers/destroy.yaml +++ b/paths/release_triggers/destroy.yaml @@ -24,11 +24,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReleaseTriggersDestroy" +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..76cf4efa 100644 --- a/paths/release_triggers/index.yaml +++ b/paths/release_triggers/index.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReleaseTriggersList" +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..baf78bf3 100644 --- a/paths/release_triggers/show.yaml +++ b/paths/release_triggers/show.yaml @@ -34,11 +34,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReleaseTriggersShow" +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..7c2ee5e9 100644 --- a/paths/release_triggers/update.yaml +++ b/paths/release_triggers/update.yaml @@ -81,12 +81,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/ReleaseTriggersUpdate" +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..2fa9ef47 100644 --- a/paths/releases/create.yaml +++ b/paths/releases/create.yaml @@ -43,13 +43,7 @@ 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 + - "$ref": "../../examples/cli.yaml#/ReleaseCreate" requestBody: required: true content: @@ -98,4 +92,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..fc2bb57a 100644 --- a/paths/releases/destroy.yaml +++ b/paths/releases/destroy.yaml @@ -31,11 +31,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReleaseDelete" +x-cli-command: releases delete x-cli-version: '2.5' diff --git a/paths/releases/index.yaml b/paths/releases/index.yaml index b3cb0447..9f8b02ac 100644 --- a/paths/releases/index.yaml +++ b/paths/releases/index.yaml @@ -46,10 +46,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReleasesList" +x-cli-command: releases list x-cli-version: '2.5' diff --git a/paths/releases/publish.yaml b/paths/releases/publish.yaml index a6a6ac7a..201871ca 100644 --- a/paths/releases/publish.yaml +++ b/paths/releases/publish.yaml @@ -42,11 +42,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReleasePublish" +x-cli-command: releases publish x-cli-version: '2.5' diff --git a/paths/releases/show.yaml b/paths/releases/show.yaml index 4aa70894..e66a1de4 100644 --- a/paths/releases/show.yaml +++ b/paths/releases/show.yaml @@ -39,11 +39,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReleaseShow" +x-cli-command: releases show x-cli-version: '2.5' diff --git a/paths/releases/update.yaml b/paths/releases/update.yaml index 33ad17c5..36cc001a 100644 --- a/paths/releases/update.yaml +++ b/paths/releases/update.yaml @@ -44,14 +44,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/ReleaseUpdate" requestBody: required: true content: @@ -84,4 +77,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..31e58c0e 100644 --- a/paths/repo_sync_events/index.yaml +++ b/paths/repo_sync_events/index.yaml @@ -40,10 +40,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncEventList" +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..5d975141 100644 --- a/paths/repo_sync_events/show.yaml +++ b/paths/repo_sync_events/show.yaml @@ -34,11 +34,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncEventShow" +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..80c11c41 100644 --- a/paths/repo_syncs/activate.yaml +++ b/paths/repo_syncs/activate.yaml @@ -44,9 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncActivate" +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..22d56346 100644 --- a/paths/repo_syncs/create.yaml +++ b/paths/repo_syncs/create.yaml @@ -49,12 +49,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncCreate" requestBody: required: true content: @@ -126,4 +121,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..2b35e5e3 100644 --- a/paths/repo_syncs/deactivate.yaml +++ b/paths/repo_syncs/deactivate.yaml @@ -44,9 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncDeactivate" +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..1406bce8 100644 --- a/paths/repo_syncs/export.yaml +++ b/paths/repo_syncs/export.yaml @@ -63,9 +63,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncExport" +x-cli-command: repo_syncs export diff --git a/paths/repo_syncs/import.yaml b/paths/repo_syncs/import.yaml index b816cb4d..7f3e3539 100644 --- a/paths/repo_syncs/import.yaml +++ b/paths/repo_syncs/import.yaml @@ -63,9 +63,5 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncImport" +x-cli-command: repo_syncs import diff --git a/paths/repo_syncs/index.yaml b/paths/repo_syncs/index.yaml index 767532e1..7193e216 100644 --- a/paths/repo_syncs/index.yaml +++ b/paths/repo_syncs/index.yaml @@ -43,9 +43,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncList" +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..ade68450 100644 --- a/paths/repo_syncs/show.yaml +++ b/paths/repo_syncs/show.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/RepoSyncShow" +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..242a43ec 100644 --- a/paths/reports/locales/index.yaml +++ b/paths/reports/locales/index.yaml @@ -52,11 +52,6 @@ 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 + - "$ref": "../../../examples/cli.yaml#/ReportLocalesList" +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..1c99556e 100644 --- a/paths/reports/show.yaml +++ b/paths/reports/show.yaml @@ -46,10 +46,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/ReportShow" +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..3d488553 100644 --- a/paths/screenshot_markers/create.yaml +++ b/paths/screenshot_markers/create.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotMarkerCreate" requestBody: required: true content: @@ -75,4 +69,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..5a660036 100644 --- a/paths/screenshot_markers/destroy.yaml +++ b/paths/screenshot_markers/destroy.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotMarkerDelete" +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..0640ad00 100644 --- a/paths/screenshot_markers/index.yaml +++ b/paths/screenshot_markers/index.yaml @@ -52,11 +52,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotMarkersList" +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..235d802a 100644 --- a/paths/screenshot_markers/show.yaml +++ b/paths/screenshot_markers/show.yaml @@ -45,12 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotMarkerShow" +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..d8b32004 100644 --- a/paths/screenshot_markers/update.yaml +++ b/paths/screenshot_markers/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotMarkerUpdate" requestBody: required: true content: @@ -73,4 +67,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..99c127ba 100644 --- a/paths/screenshots/create.yaml +++ b/paths/screenshots/create.yaml @@ -56,15 +56,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotCreate" requestBody: required: true content: @@ -97,4 +89,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..d3c6c2c0 100644 --- a/paths/screenshots/destroy.yaml +++ b/paths/screenshots/destroy.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotDelete" +x-cli-command: screenshots delete x-cli-version: '2.5' diff --git a/paths/screenshots/index.yaml b/paths/screenshots/index.yaml index cffab21a..a05c1bbb 100644 --- a/paths/screenshots/index.yaml +++ b/paths/screenshots/index.yaml @@ -57,10 +57,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotsList" +x-cli-command: screenshots list x-cli-version: '2.5' diff --git a/paths/screenshots/show.yaml b/paths/screenshots/show.yaml index ad73d271..11f464e9 100644 --- a/paths/screenshots/show.yaml +++ b/paths/screenshots/show.yaml @@ -44,11 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotShow" +x-cli-command: screenshots show x-cli-version: '2.5' diff --git a/paths/screenshots/update.yaml b/paths/screenshots/update.yaml index df4f3e29..1f8a24fd 100644 --- a/paths/screenshots/update.yaml +++ b/paths/screenshots/update.yaml @@ -45,13 +45,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/ScreenshotUpdate" requestBody: required: true content: @@ -77,4 +71,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..875ec9cf 100644 --- a/paths/search/in_account.yaml +++ b/paths/search/in_account.yaml @@ -47,12 +47,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/SearchInAccount" requestBody: required: true content: @@ -85,4 +80,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..714623ad 100644 --- a/paths/spaces/add_project.yaml +++ b/paths/spaces/add_project.yaml @@ -32,13 +32,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/SpacesProjectsCreate" requestBody: required: true content: @@ -53,4 +47,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..339a61ee 100644 --- a/paths/spaces/create.yaml +++ b/paths/spaces/create.yaml @@ -35,12 +35,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/SpaceCreate" requestBody: required: true content: @@ -55,4 +50,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..57f89c73 100644 --- a/paths/spaces/delete.yaml +++ b/paths/spaces/delete.yaml @@ -23,10 +23,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/SpaceDelete" +x-cli-command: spaces delete x-cli-version: '2.5' diff --git a/paths/spaces/index.yaml b/paths/spaces/index.yaml index fca3aa53..fd664fd2 100644 --- a/paths/spaces/index.yaml +++ b/paths/spaces/index.yaml @@ -40,9 +40,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/SpacesList" +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..7e18be99 100644 --- a/paths/spaces/remove_project.yaml +++ b/paths/spaces/remove_project.yaml @@ -24,11 +24,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/SpacesProjectsDelete" +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..02b15b81 100644 --- a/paths/spaces/show.yaml +++ b/paths/spaces/show.yaml @@ -33,10 +33,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/SpaceShow" +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..306b1021 100644 --- a/paths/spaces/spaces_projects.yaml +++ b/paths/spaces/spaces_projects.yaml @@ -41,10 +41,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/SpacesProjectsList" +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..dc49c352 100644 --- a/paths/spaces/update.yaml +++ b/paths/spaces/update.yaml @@ -36,13 +36,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/SpaceUpdate" requestBody: required: true content: @@ -55,4 +49,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..5cf06119 100644 --- a/paths/styleguides/create.yaml +++ b/paths/styleguides/create.yaml @@ -40,14 +40,9 @@ 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 +- "$ref": "../../examples/cli.yaml#/StyleguideCreate" requestBody: required: true content: @@ -119,7 +114,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 +127,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..fc6e5cb0 100644 --- a/paths/styleguides/destroy.yaml +++ b/paths/styleguides/destroy.yaml @@ -30,10 +30,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/StyleguideDelete" +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..e82fbd17 100644 --- a/paths/styleguides/index.yaml +++ b/paths/styleguides/index.yaml @@ -45,9 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/StyleguidesList" +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..cb50033e 100644 --- a/paths/styleguides/show.yaml +++ b/paths/styleguides/show.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/StyleguideShow" +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..db1560b6 100644 --- a/paths/styleguides/update.yaml +++ b/paths/styleguides/update.yaml @@ -41,15 +41,9 @@ 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 +- "$ref": "../../examples/cli.yaml#/StyleguideUpdate" 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 update x-cli-version: '2.5' diff --git a/paths/tags/create.yaml b/paths/tags/create.yaml index c61c116c..fb0229e1 100644 --- a/paths/tags/create.yaml +++ b/paths/tags/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TagCreate" requestBody: required: true content: @@ -66,4 +61,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..a0c26b87 100644 --- a/paths/tags/destroy.yaml +++ b/paths/tags/destroy.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TagDelete" +x-cli-command: tags delete x-cli-version: '2.5' diff --git a/paths/tags/index.yaml b/paths/tags/index.yaml index ce5855a4..dffc9919 100644 --- a/paths/tags/index.yaml +++ b/paths/tags/index.yaml @@ -68,10 +68,6 @@ 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 + - "$ref": "../../examples/cli.yaml#/TagsList" +x-cli-command: tags list x-cli-version: '2.5' diff --git a/paths/tags/show.yaml b/paths/tags/show.yaml index f54735d2..477ba910 100644 --- a/paths/tags/show.yaml +++ b/paths/tags/show.yaml @@ -50,11 +50,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TagShow" +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..dd056a84 100644 --- a/paths/teams/add_project.yaml +++ b/paths/teams/add_project.yaml @@ -32,13 +32,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamsProjectsCreate" requestBody: required: true content: @@ -53,4 +47,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..6f5ad452 100644 --- a/paths/teams/add_space.yaml +++ b/paths/teams/add_space.yaml @@ -32,13 +32,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamsSpacesCreate" requestBody: required: true content: @@ -53,4 +47,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..92805b31 100644 --- a/paths/teams/add_user.yaml +++ b/paths/teams/add_user.yaml @@ -32,13 +32,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamsUsersCreate" requestBody: required: true content: @@ -53,4 +47,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..d2ce20c7 100644 --- a/paths/teams/create.yaml +++ b/paths/teams/create.yaml @@ -35,12 +35,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamCreate" requestBody: required: true content: @@ -55,4 +50,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..b3b480c1 100644 --- a/paths/teams/delete.yaml +++ b/paths/teams/delete.yaml @@ -23,10 +23,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamDelete" +x-cli-command: teams delete x-cli-version: '2.5' diff --git a/paths/teams/index.yaml b/paths/teams/index.yaml index 94e1417b..f3fb36bd 100644 --- a/paths/teams/index.yaml +++ b/paths/teams/index.yaml @@ -40,9 +40,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamsList" +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..eb3d608c 100644 --- a/paths/teams/remove_project.yaml +++ b/paths/teams/remove_project.yaml @@ -24,11 +24,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamsProjectsDelete" +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..4c6cb9f6 100644 --- a/paths/teams/remove_space.yaml +++ b/paths/teams/remove_space.yaml @@ -24,11 +24,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamsSpacesDelete" +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..59e2b0a3 100644 --- a/paths/teams/remove_user.yaml +++ b/paths/teams/remove_user.yaml @@ -24,11 +24,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamsUsersDelete" +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..14f09714 100644 --- a/paths/teams/show.yaml +++ b/paths/teams/show.yaml @@ -33,10 +33,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamShow" +x-cli-command: teams show x-cli-version: '2.5' diff --git a/paths/teams/update.yaml b/paths/teams/update.yaml index f289d325..03c8a32d 100644 --- a/paths/teams/update.yaml +++ b/paths/teams/update.yaml @@ -36,13 +36,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TeamUpdate" requestBody: required: true content: @@ -55,4 +49,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..523b7d98 100644 --- a/paths/translations/batch_exclude.yaml +++ b/paths/translations/batch_exclude.yaml @@ -40,12 +40,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsExcludeCollection" requestBody: required: true content: @@ -83,4 +78,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..aaf5647d 100644 --- a/paths/translations/batch_include.yaml +++ b/paths/translations/batch_include.yaml @@ -40,12 +40,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsIncludeCollection" requestBody: required: true content: @@ -82,4 +77,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..c8708f2c 100644 --- a/paths/translations/batch_review.yaml +++ b/paths/translations/batch_review.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsReviewCollection" requestBody: required: true content: @@ -77,4 +72,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..e84c6424 100644 --- a/paths/translations/batch_unreview.yaml +++ b/paths/translations/batch_unreview.yaml @@ -41,12 +41,7 @@ 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 + - "$ref": "../../examples/cli.yaml#/TranslationsUnreviewCollection" requestBody: required: true content: @@ -75,4 +70,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..26ebb93f 100644 --- a/paths/translations/batch_unverify.yaml +++ b/paths/translations/batch_unverify.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsUnverifyCollection" requestBody: required: true content: @@ -84,4 +79,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..f17605f8 100644 --- a/paths/translations/batch_verify.yaml +++ b/paths/translations/batch_verify.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsVerifyCollection" requestBody: required: true content: @@ -80,4 +75,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..4888dc22 100644 --- a/paths/translations/create.yaml +++ b/paths/translations/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationCreate" requestBody: required: true content: @@ -98,4 +93,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..a96b12b7 100644 --- a/paths/translations/exclude.yaml +++ b/paths/translations/exclude.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationExclude" requestBody: required: true content: @@ -62,4 +56,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..2d8b0864 100644 --- a/paths/translations/include.yaml +++ b/paths/translations/include.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationInclude" requestBody: required: true content: @@ -62,4 +56,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..317eda21 100644 --- a/paths/translations/index.yaml +++ b/paths/translations/index.yaml @@ -100,13 +100,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsList" +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..23bcf148 100644 --- a/paths/translations/index_keys.yaml +++ b/paths/translations/index_keys.yaml @@ -81,14 +81,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsByKey" +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..59b4529f 100644 --- a/paths/translations/index_locale.yaml +++ b/paths/translations/index_locale.yaml @@ -83,14 +83,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsByLocale" +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..c1666a5e 100644 --- a/paths/translations/review.yaml +++ b/paths/translations/review.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationReview" requestBody: required: true content: @@ -62,4 +56,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..d44e7ba7 100644 --- a/paths/translations/search.yaml +++ b/paths/translations/search.yaml @@ -46,12 +46,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationsSearch" requestBody: required: true content: @@ -89,4 +84,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..f9cc465d 100644 --- a/paths/translations/show.yaml +++ b/paths/translations/show.yaml @@ -44,11 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationShow" +x-cli-command: translations show x-cli-version: '2.5' diff --git a/paths/translations/unreview.yaml b/paths/translations/unreview.yaml index d32cf8bd..23bfa569 100644 --- a/paths/translations/unreview.yaml +++ b/paths/translations/unreview.yaml @@ -42,13 +42,7 @@ 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 + - "$ref": "../../examples/cli.yaml#/TranslationUnreview" requestBody: required: true content: @@ -61,4 +55,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..42bf5360 100644 --- a/paths/translations/unverify.yaml +++ b/paths/translations/unverify.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationUnverify" requestBody: required: true content: @@ -62,4 +56,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..847bd158 100644 --- a/paths/translations/update.yaml +++ b/paths/translations/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationUpdate" requestBody: required: true content: @@ -91,4 +85,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..6634aad4 100644 --- a/paths/translations/verify.yaml +++ b/paths/translations/verify.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/TranslationVerify" requestBody: required: true content: @@ -62,4 +56,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..9787a6b7 100644 --- a/paths/upload_batches/create.yaml +++ b/paths/upload_batches/create.yaml @@ -76,15 +76,5 @@ 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 + - "$ref": "../../examples/cli.yaml#/UploadBatchesCreate" +x-cli-command: upload_batches create diff --git a/paths/uploads/create.yaml b/paths/uploads/create.yaml index d1f4ca81..cfacd961 100644 --- a/paths/uploads/create.yaml +++ b/paths/uploads/create.yaml @@ -49,18 +49,7 @@ 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 + - "$ref": "../../examples/cli.yaml#/UploadCreate" requestBody: required: true content: @@ -176,4 +165,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..c3674c00 100644 --- a/paths/uploads/index.yaml +++ b/paths/uploads/index.yaml @@ -51,10 +51,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/UploadsList" +x-cli-command: uploads list x-cli-version: '2.5' diff --git a/paths/uploads/show.yaml b/paths/uploads/show.yaml index 61495e98..0607cc56 100644 --- a/paths/uploads/show.yaml +++ b/paths/uploads/show.yaml @@ -44,11 +44,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/UploadShow" +x-cli-command: uploads show x-cli-version: '2.5' diff --git a/paths/users/user.yaml b/paths/users/user.yaml index e8fe4508..cc21947d 100644 --- a/paths/users/user.yaml +++ b/paths/users/user.yaml @@ -36,8 +36,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/ShowUser" +x-cli-command: users user x-cli-version: '2.5' diff --git a/paths/variables/create.yaml b/paths/variables/create.yaml index f88bbefb..259f3364 100644 --- a/paths/variables/create.yaml +++ b/paths/variables/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/VariableCreate" requestBody: required: true content: @@ -66,4 +61,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..eb64973e 100644 --- a/paths/variables/destroy.yaml +++ b/paths/variables/destroy.yaml @@ -30,10 +30,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/VariableDelete" +x-cli-command: variables delete x-cli-version: '2.5' diff --git a/paths/variables/index.yaml b/paths/variables/index.yaml index 638d62ad..7534eee8 100644 --- a/paths/variables/index.yaml +++ b/paths/variables/index.yaml @@ -45,9 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/VariablesList" +x-cli-command: variables list x-cli-version: '2.5' diff --git a/paths/variables/show.yaml b/paths/variables/show.yaml index 9c3be817..3ea9d3b3 100644 --- a/paths/variables/show.yaml +++ b/paths/variables/show.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/VariableShow" +x-cli-command: variables show x-cli-version: '2.5' diff --git a/paths/variables/update.yaml b/paths/variables/update.yaml index d7ebdd78..d5e0cbe0 100644 --- a/paths/variables/update.yaml +++ b/paths/variables/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/VariableUpdate" requestBody: required: true content: @@ -66,4 +60,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..e49287eb 100644 --- a/paths/versions/index.yaml +++ b/paths/versions/index.yaml @@ -59,12 +59,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/VersionsList" +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..1b9c5395 100644 --- a/paths/versions/show.yaml +++ b/paths/versions/show.yaml @@ -45,12 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/VersionShow" +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..362737b1 100644 --- a/paths/webhook_deliveries/index.yaml +++ b/paths/webhook_deliveries/index.yaml @@ -40,10 +40,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhookDeliveriesList" +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..8cc3f8d6 100644 --- a/paths/webhook_deliveries/redeliver.yaml +++ b/paths/webhook_deliveries/redeliver.yaml @@ -38,11 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhookDeliveriesRedeliver" +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..dbe86471 100644 --- a/paths/webhook_deliveries/show.yaml +++ b/paths/webhook_deliveries/show.yaml @@ -36,11 +36,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhookDeliveriesShow" +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..bd99a599 100644 --- a/paths/webhooks/create.yaml +++ b/paths/webhooks/create.yaml @@ -42,12 +42,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhookCreate" requestBody: required: true content: @@ -82,4 +77,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..3ee1c370 100644 --- a/paths/webhooks/destroy.yaml +++ b/paths/webhooks/destroy.yaml @@ -30,10 +30,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhookDelete" +x-cli-command: webhooks delete x-cli-version: '2.5' diff --git a/paths/webhooks/index.yaml b/paths/webhooks/index.yaml index 8ad7694e..fcb55d5c 100644 --- a/paths/webhooks/index.yaml +++ b/paths/webhooks/index.yaml @@ -45,9 +45,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhooksList" +x-cli-command: webhooks list x-cli-version: '2.5' diff --git a/paths/webhooks/show.yaml b/paths/webhooks/show.yaml index ee2416de..6fe1a485 100644 --- a/paths/webhooks/show.yaml +++ b/paths/webhooks/show.yaml @@ -38,10 +38,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhookShow" +x-cli-command: webhooks show x-cli-version: '2.5' diff --git a/paths/webhooks/test.yaml b/paths/webhooks/test.yaml index d94f3c06..d80012c8 100644 --- a/paths/webhooks/test.yaml +++ b/paths/webhooks/test.yaml @@ -42,10 +42,6 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhookTest" +x-cli-command: webhooks test x-cli-version: '2.5' diff --git a/paths/webhooks/update.yaml b/paths/webhooks/update.yaml index f415434c..475b7cbf 100644 --- a/paths/webhooks/update.yaml +++ b/paths/webhooks/update.yaml @@ -43,13 +43,7 @@ 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 +- "$ref": "../../examples/cli.yaml#/WebhookUpdate" 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 update x-cli-version: '2.5' From a18e8e4c100d4ad0cbc11b2dbecb4696b85838f2 Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Fri, 26 Jun 2026 14:20:06 +0200 Subject: [PATCH 2/8] docs(CLI): inject CLI samples at bundle time instead of $ref Path files no longer carry a CLI v2 x-code-sample or a $ref to one. Instead, scripts/inject-cli-examples.js appends each operation's generated sample (from examples/cli.yaml, matched on operationId) into the compiled bundle after swagger-cli runs. This removes the dangling-$ref failure mode: adding an endpoint no longer breaks bundle/validate when its example doesn't exist yet (a missing example is a no-op). `make bundle` now regenerates examples/cli.yaml (via a dedicated examples target) and injects into doc/compiled.json + tmp/compiled.yaml. - Add scripts/inject-cli-examples.js - Add openapi-generator/cli_examples_lang.yaml (examples-only generate) - Add `examples` Makefile target; wire regen+inject into `bundle` - Key examples/cli.yaml by operationIdOriginal (matches compiled operationId) - Remove CLI $ref lines from path files (keep inline Curl + x-cli-command) Co-Authored-By: Claude Opus 4.8 (1M context) --- Makefile | 8 + doc/compiled.json | 25 +- examples/cli.yaml | 580 +++++++++--------- openapi-generator/cli_examples_lang.yaml | 11 + openapi-generator/cli_lang.yaml | 4 - openapi-generator/templates/TEMPLATING.md | 46 +- .../templates/cli/cli_examples.handlebars | 2 +- paths/accounts/index.yaml | 1 - paths/accounts/locales.yaml | 1 - paths/accounts/show.yaml | 1 - paths/authorizations/create.yaml | 1 - paths/authorizations/destroy.yaml | 1 - paths/authorizations/index.yaml | 1 - paths/authorizations/show.yaml | 1 - paths/authorizations/update.yaml | 1 - paths/automations/activate.yaml | 1 - paths/automations/create.yaml | 1 - paths/automations/deactivate.yaml | 1 - paths/automations/destroy.yaml | 1 - paths/automations/index.yaml | 1 - paths/automations/show.yaml | 1 - paths/automations/trigger.yaml | 1 - paths/automations/update.yaml | 1 - paths/blacklisted_keys/create.yaml | 1 - paths/blacklisted_keys/destroy.yaml | 1 - paths/blacklisted_keys/index.yaml | 1 - paths/blacklisted_keys/show.yaml | 1 - paths/blacklisted_keys/update.yaml | 1 - paths/branches/compare.yaml | 1 - paths/branches/create.yaml | 1 - paths/branches/create_comparison.yaml | 1 - paths/branches/destroy.yaml | 1 - paths/branches/index.yaml | 1 - paths/branches/merge.yaml | 1 - paths/branches/show.yaml | 1 - paths/branches/sync.yaml | 1 - paths/branches/update.yaml | 1 - paths/comment_reactions/create.yaml | 1 - paths/comment_reactions/destroy.yaml | 1 - paths/comment_reactions/index.yaml | 1 - paths/comment_reactions/show.yaml | 1 - paths/comment_replies/create.yaml | 1 - paths/comment_replies/destroy.yaml | 1 - paths/comment_replies/index.yaml | 1 - paths/comment_replies/mark_as_read.yaml | 1 - paths/comment_replies/mark_as_unread.yaml | 1 - paths/comment_replies/show.yaml | 1 - paths/comments/check_if_read.yaml | 1 - paths/comments/create.yaml | 1 - paths/comments/destroy.yaml | 1 - paths/comments/index.yaml | 1 - paths/comments/mark_as_read.yaml | 1 - paths/comments/show.yaml | 1 - paths/comments/unmark_as_read.yaml | 1 - paths/comments/update.yaml | 1 - paths/custom_metadata_properties/create.yaml | 1 - paths/custom_metadata_properties/destroy.yaml | 1 - paths/custom_metadata_properties/index.yaml | 1 - paths/custom_metadata_properties/show.yaml | 1 - paths/custom_metadata_properties/update.yaml | 1 - paths/distributions/create.yaml | 1 - paths/distributions/destroy.yaml | 1 - paths/distributions/index.yaml | 1 - paths/distributions/show.yaml | 1 - paths/distributions/update.yaml | 1 - paths/documents/destroy.yaml | 1 - paths/documents/index.yaml | 1 - paths/figma_attachment_keys/create.yaml | 1 - paths/figma_attachment_keys/destroy.yaml | 1 - paths/figma_attachments/create.yaml | 1 - paths/figma_attachments/destroy.yaml | 1 - paths/figma_attachments/index.yaml | 1 - paths/figma_attachments/show.yaml | 1 - paths/figma_attachments/update.yaml | 1 - paths/formats/index.yaml | 1 - paths/glossaries/create.yaml | 1 - paths/glossaries/destroy.yaml | 1 - paths/glossaries/index.yaml | 1 - paths/glossaries/show.yaml | 1 - paths/glossaries/update.yaml | 1 - paths/glossary_term_translations/create.yaml | 1 - paths/glossary_term_translations/destroy.yaml | 1 - paths/glossary_term_translations/update.yaml | 1 - paths/glossary_terms/create.yaml | 1 - paths/glossary_terms/destroy.yaml | 1 - paths/glossary_terms/index.yaml | 1 - paths/glossary_terms/show.yaml | 1 - paths/glossary_terms/update.yaml | 1 - paths/icu/skeleton.yaml | 1 - paths/invitations/create.yaml | 1 - paths/invitations/destroy.yaml | 1 - paths/invitations/index.yaml | 1 - paths/invitations/resend.yaml | 1 - paths/invitations/show.yaml | 1 - paths/invitations/update.yaml | 1 - paths/invitations/update_settings.yaml | 1 - paths/job_annotations/destroy.yaml | 1 - paths/job_annotations/index.yaml | 1 - paths/job_annotations/update.yaml | 1 - paths/job_comments/create.yaml | 1 - paths/job_comments/destroy.yaml | 1 - paths/job_comments/index.yaml | 1 - paths/job_comments/show.yaml | 1 - paths/job_comments/update.yaml | 1 - paths/job_locale_annotations/destroy.yaml | 1 - paths/job_locale_annotations/index.yaml | 1 - paths/job_locale_annotations/update.yaml | 1 - paths/job_locales/complete.yaml | 1 - paths/job_locales/complete_review.yaml | 1 - paths/job_locales/create.yaml | 1 - paths/job_locales/destroy.yaml | 1 - paths/job_locales/index.yaml | 1 - paths/job_locales/reopen.yaml | 1 - paths/job_locales/show.yaml | 1 - paths/job_locales/update.yaml | 1 - paths/job_template_locales/create.yaml | 1 - paths/job_template_locales/destroy.yaml | 1 - paths/job_template_locales/index.yaml | 1 - paths/job_template_locales/show.yaml | 1 - paths/job_template_locales/update.yaml | 1 - paths/job_templates/create.yaml | 1 - paths/job_templates/destroy.yaml | 1 - paths/job_templates/index.yaml | 1 - paths/job_templates/show.yaml | 1 - paths/job_templates/update.yaml | 1 - paths/jobs/add_keys.yaml | 1 - paths/jobs/complete.yaml | 1 - paths/jobs/create.yaml | 1 - paths/jobs/destroy.yaml | 1 - paths/jobs/index.yaml | 1 - paths/jobs/index_account.yaml | 1 - paths/jobs/lock.yaml | 1 - paths/jobs/remove_keys.yaml | 1 - paths/jobs/reopen.yaml | 1 - paths/jobs/show.yaml | 1 - paths/jobs/start.yaml | 1 - paths/jobs/unlock.yaml | 1 - paths/jobs/update.yaml | 1 - paths/keys/create.yaml | 1 - paths/keys/destroy-collection.yaml | 1 - paths/keys/destroy.yaml | 1 - paths/keys/exclude.yaml | 1 - paths/keys/include.yaml | 1 - paths/keys/index.yaml | 1 - paths/keys/search.yaml | 1 - paths/keys/show.yaml | 1 - paths/keys/tag.yaml | 1 - paths/keys/untag.yaml | 1 - paths/keys/update.yaml | 1 - paths/locale_downloads/create.yaml | 1 - paths/locale_downloads/show.yaml | 1 - paths/locales/create.yaml | 1 - paths/locales/destroy.yaml | 1 - paths/locales/download.yaml | 1 - paths/locales/index.yaml | 1 - paths/locales/show.yaml | 1 - paths/locales/update.yaml | 1 - paths/members/destroy.yaml | 1 - paths/members/index.yaml | 1 - paths/members/show.yaml | 1 - paths/members/update.yaml | 1 - paths/members/update_settings.yaml | 1 - paths/notification_groups/index.yaml | 1 - .../notification_groups/mark_all_as_read.yaml | 1 - paths/notification_groups/mark_as_read.yaml | 1 - paths/notifications/index.yaml | 1 - paths/notifications/mark_all_as_read.yaml | 1 - paths/notifications/show.yaml | 1 - paths/orders/confirm.yaml | 1 - paths/orders/create.yaml | 1 - paths/orders/destroy.yaml | 1 - paths/orders/index.yaml | 1 - paths/orders/show.yaml | 1 - .../create.yaml | 1 - .../destroy.yaml | 1 - .../index.yaml | 1 - .../show.yaml | 1 - .../update.yaml | 1 - paths/organization_job_templates/create.yaml | 1 - paths/organization_job_templates/destroy.yaml | 1 - paths/organization_job_templates/index.yaml | 1 - paths/organization_job_templates/show.yaml | 1 - paths/organization_job_templates/update.yaml | 1 - paths/projects/create.yaml | 1 - paths/projects/destroy.yaml | 1 - paths/projects/index.yaml | 1 - paths/projects/show.yaml | 1 - paths/projects/update.yaml | 1 - paths/quality_performance_score/index.yaml | 1 - paths/release_triggers/create.yaml | 1 - paths/release_triggers/destroy.yaml | 1 - paths/release_triggers/index.yaml | 1 - paths/release_triggers/show.yaml | 1 - paths/release_triggers/update.yaml | 1 - paths/releases/create.yaml | 1 - paths/releases/destroy.yaml | 1 - paths/releases/index.yaml | 1 - paths/releases/publish.yaml | 1 - paths/releases/show.yaml | 1 - paths/releases/update.yaml | 1 - paths/repo_sync_events/index.yaml | 1 - paths/repo_sync_events/show.yaml | 1 - paths/repo_syncs/activate.yaml | 1 - paths/repo_syncs/create.yaml | 1 - paths/repo_syncs/deactivate.yaml | 1 - paths/repo_syncs/export.yaml | 1 - paths/repo_syncs/import.yaml | 1 - paths/repo_syncs/index.yaml | 1 - paths/repo_syncs/show.yaml | 1 - paths/reports/locales/index.yaml | 1 - paths/reports/show.yaml | 1 - paths/screenshot_markers/create.yaml | 1 - paths/screenshot_markers/destroy.yaml | 1 - paths/screenshot_markers/index.yaml | 1 - paths/screenshot_markers/show.yaml | 1 - paths/screenshot_markers/update.yaml | 1 - paths/screenshots/create.yaml | 1 - paths/screenshots/destroy.yaml | 1 - paths/screenshots/index.yaml | 1 - paths/screenshots/show.yaml | 1 - paths/screenshots/update.yaml | 1 - paths/search/in_account.yaml | 1 - paths/spaces/add_project.yaml | 1 - paths/spaces/create.yaml | 1 - paths/spaces/delete.yaml | 1 - paths/spaces/index.yaml | 1 - paths/spaces/remove_project.yaml | 1 - paths/spaces/show.yaml | 1 - paths/spaces/spaces_projects.yaml | 1 - paths/spaces/update.yaml | 1 - paths/styleguides/create.yaml | 1 - paths/styleguides/destroy.yaml | 1 - paths/styleguides/index.yaml | 1 - paths/styleguides/show.yaml | 1 - paths/styleguides/update.yaml | 1 - paths/tags/create.yaml | 1 - paths/tags/destroy.yaml | 1 - paths/tags/index.yaml | 1 - paths/tags/show.yaml | 1 - paths/teams/add_project.yaml | 1 - paths/teams/add_space.yaml | 1 - paths/teams/add_user.yaml | 1 - paths/teams/create.yaml | 1 - paths/teams/delete.yaml | 1 - paths/teams/index.yaml | 1 - paths/teams/remove_project.yaml | 1 - paths/teams/remove_space.yaml | 1 - paths/teams/remove_user.yaml | 1 - paths/teams/show.yaml | 1 - paths/teams/update.yaml | 1 - paths/translations/batch_exclude.yaml | 1 - paths/translations/batch_include.yaml | 1 - paths/translations/batch_review.yaml | 1 - paths/translations/batch_unreview.yaml | 1 - paths/translations/batch_unverify.yaml | 1 - paths/translations/batch_verify.yaml | 1 - paths/translations/create.yaml | 1 - paths/translations/exclude.yaml | 1 - paths/translations/include.yaml | 1 - paths/translations/index.yaml | 1 - paths/translations/index_keys.yaml | 1 - paths/translations/index_locale.yaml | 1 - paths/translations/review.yaml | 1 - paths/translations/search.yaml | 1 - paths/translations/show.yaml | 1 - paths/translations/unreview.yaml | 1 - paths/translations/unverify.yaml | 1 - paths/translations/update.yaml | 1 - paths/translations/verify.yaml | 1 - paths/upload_batches/create.yaml | 1 - paths/uploads/create.yaml | 1 - paths/uploads/index.yaml | 1 - paths/uploads/show.yaml | 1 - paths/users/user.yaml | 1 - paths/variables/create.yaml | 1 - paths/variables/destroy.yaml | 1 - paths/variables/index.yaml | 1 - paths/variables/show.yaml | 1 - paths/variables/update.yaml | 1 - paths/versions/index.yaml | 1 - paths/versions/show.yaml | 1 - paths/webhook_deliveries/index.yaml | 1 - paths/webhook_deliveries/redeliver.yaml | 1 - paths/webhook_deliveries/show.yaml | 1 - paths/webhooks/create.yaml | 1 - paths/webhooks/destroy.yaml | 1 - paths/webhooks/index.yaml | 1 - paths/webhooks/show.yaml | 1 - paths/webhooks/test.yaml | 1 - paths/webhooks/update.yaml | 1 - scripts/inject-cli-examples.js | 59 ++ 291 files changed, 416 insertions(+), 602 deletions(-) create mode 100644 openapi-generator/cli_examples_lang.yaml create mode 100644 scripts/inject-cli-examples.js diff --git a/Makefile b/Makefile index 2976566b..5f76b312 100644 --- a/Makefile +++ b/Makefile @@ -14,8 +14,16 @@ lint: make bundle bash ./lint.sh bundle: + npx swagger-cli bundle -t yaml -w 300 main.yaml > tmp/compiled.yaml + make examples 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). +# Requires tmp/compiled.yaml to exist (produced by `make bundle`). +examples: + 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 diff --git a/doc/compiled.json b/doc/compiled.json index 53012add..0eb020d8 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -31526,6 +31526,10 @@ { "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" @@ -31591,7 +31595,13 @@ "$ref": "#/components/responses/429" } }, - "x-cli-command": "linked_keys index" + "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", @@ -31669,7 +31679,13 @@ "$ref": "#/components/responses/429" } }, - "x-cli-command": "linked_keys create" + "x-cli-command": "linked_keys create", + "x-code-samples": [ + { + "lang": "CLI v2", + "source": "phrase linked_keys create \\\n --project_id \\\n --id \\\n --data '{ \"child_key_ids\": [\"child_key_id1\",\"child_key_id2\"] }' \\\n --access_token " + } + ] } }, "/projects/{project_id}/keys/{id}/key_links/{child_key_id}": { @@ -31740,6 +31756,10 @@ { "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" @@ -32473,4 +32493,3 @@ } } } - diff --git a/examples/cli.yaml b/examples/cli.yaml index 277e665c..9a4c2531 100644 --- a/examples/cli.yaml +++ b/examples/cli.yaml @@ -1,91 +1,91 @@ -AccountShow: +account/show: lang: CLI v2 source: |- phrase accounts show \ --id \ --access_token -AccountsList: +accounts/list: lang: CLI v2 source: |- phrase accounts list \ --page "1" \ --per_page "25" \ --access_token -AuthorizationCreate: +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 -AuthorizationDelete: +authorization/delete: lang: CLI v2 source: |- phrase authorizations delete \ --id \ --access_token -AuthorizationShow: +authorization/show: lang: CLI v2 source: |- phrase authorizations show \ --id \ --access_token -AuthorizationUpdate: +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 -AuthorizationsList: +authorizations/list: lang: CLI v2 source: |- phrase authorizations list \ --page "1" \ --per_page "25" \ --access_token -AutomationActivate: +automation/activate: lang: CLI v2 source: |- phrase automations activate \ --account_id \ --id \ --access_token -AutomationCreate: +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 -AutomationDeactivate: +automation/deactivate: lang: CLI v2 source: |- phrase automations deactivate \ --account_id \ --id \ --access_token -AutomationDelete: +automation/delete: lang: CLI v2 source: |- phrase automations delete \ --account_id \ --id \ --access_token -AutomationShow: +automation/show: lang: CLI v2 source: |- phrase automations show \ --account_id \ --id \ --access_token -AutomationTrigger: +automation/trigger: lang: CLI v2 source: |- phrase automations trigger \ --account_id \ --id \ --access_token -AutomationUpdate: +automation/update: lang: CLI v2 source: |- phrase automations update \ @@ -93,7 +93,7 @@ AutomationUpdate: --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 -AutomationsList: +automations/list: lang: CLI v2 source: |- phrase automations list \ @@ -101,28 +101,28 @@ AutomationsList: --page "1" \ --per_page "25" \ --access_token -BlacklistedKeyCreate: +blacklisted_key/create: lang: CLI v2 source: |- phrase blacklisted_keys create \ --project_id \ --data '{ "name": "date.formats.*" }' \ --access_token -BlacklistedKeyDelete: +blacklisted_key/delete: lang: CLI v2 source: |- phrase blacklisted_keys delete \ --project_id \ --id \ --access_token -BlacklistedKeyShow: +blacklisted_key/show: lang: CLI v2 source: |- phrase blacklisted_keys show \ --project_id \ --id \ --access_token -BlacklistedKeyUpdate: +blacklisted_key/update: lang: CLI v2 source: |- phrase blacklisted_keys update \ @@ -130,7 +130,7 @@ BlacklistedKeyUpdate: --id \ --data '{ "name": "date.formats.*" }' \ --access_token -BlacklistedKeysList: +blacklisted_keys/list: lang: CLI v2 source: |- phrase blacklisted_keys list \ @@ -139,14 +139,14 @@ BlacklistedKeysList: --per_page "25" \ --branch "my-feature-branch" \ --access_token -BranchCompare: +branch/compare: lang: CLI v2 source: |- phrase branches compare \ --project_id \ --name \ --access_token -BranchComparisonCreate: +branch/comparison/create: lang: CLI v2 source: |- phrase branches comparison_create \ @@ -154,21 +154,21 @@ BranchComparisonCreate: --name \ --data '{ "direction": "merge" }' \ --access_token -BranchCreate: +branch/create: lang: CLI v2 source: |- phrase branches create \ --project_id \ --data '{ "name": "my-branch", "base": "parent-branch" }' \ --access_token -BranchDelete: +branch/delete: lang: CLI v2 source: |- phrase branches delete \ --project_id \ --name \ --access_token -BranchMerge: +branch/merge: lang: CLI v2 source: |- phrase branches merge \ @@ -176,14 +176,14 @@ BranchMerge: --name \ --data '{ "strategy": "use_main" }' \ --access_token -BranchShow: +branch/show: lang: CLI v2 source: |- phrase branches show \ --project_id \ --name \ --access_token -BranchSync: +branch/sync: lang: CLI v2 source: |- phrase branches sync \ @@ -191,7 +191,7 @@ BranchSync: --name \ --data '{ "strategy": "use_main" }' \ --access_token -BranchUpdate: +branch/update: lang: CLI v2 source: |- phrase branches update \ @@ -199,7 +199,7 @@ BranchUpdate: --name \ --data '{ "name": "my-branch" }' \ --access_token -BranchesList: +branches/list: lang: CLI v2 source: |- phrase branches list \ @@ -207,7 +207,7 @@ BranchesList: --page "1" \ --per_page "25" \ --access_token -ReactionCreate: +reaction/create: lang: CLI v2 source: |- phrase comment_reactions create \ @@ -217,7 +217,7 @@ ReactionCreate: --branch "my-feature-branch" \ --emoji "👍" \ --access_token -ReactionDelete: +reaction/delete: lang: CLI v2 source: |- phrase comment_reactions delete \ @@ -227,7 +227,7 @@ ReactionDelete: --id \ --branch "my-feature-branch" \ --access_token -ReactionShow: +reaction/show: lang: CLI v2 source: |- phrase comment_reactions show \ @@ -237,7 +237,7 @@ ReactionShow: --id \ --branch "my-feature-branch" \ --access_token -ReactionsList: +reactions/list: lang: CLI v2 source: |- phrase comment_reactions list \ @@ -248,7 +248,7 @@ ReactionsList: --per_page "25" \ --branch "my-feature-branch" \ --access_token -RepliesList: +replies/list: lang: CLI v2 source: |- phrase comment_replies list \ @@ -262,7 +262,7 @@ RepliesList: --filters "["read","unread"]" \ --order "desc" \ --access_token -ReplyCreate: +reply/create: lang: CLI v2 source: |- phrase comment_replies create \ @@ -271,7 +271,7 @@ ReplyCreate: --comment_id \ --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ --access_token -ReplyDelete: +reply/delete: lang: CLI v2 source: |- phrase comment_replies delete \ @@ -281,7 +281,7 @@ ReplyDelete: --id \ --branch "my-feature-branch" \ --access_token -ReplyMarkAsRead: +reply/mark_as_read: lang: CLI v2 source: |- phrase comment_replies mark_as_read \ @@ -291,7 +291,7 @@ ReplyMarkAsRead: --id \ --branch "my-feature-branch" \ --access_token -ReplyMarkAsUnread: +reply/mark_as_unread: lang: CLI v2 source: |- phrase comment_replies mark_as_unread \ @@ -301,7 +301,7 @@ ReplyMarkAsUnread: --id \ --branch "my-feature-branch" \ --access_token -ReplyShow: +reply/show: lang: CLI v2 source: |- phrase comment_replies show \ @@ -311,7 +311,7 @@ ReplyShow: --id \ --branch "my-feature-branch" \ --access_token -CommentCreate: +comment/create: lang: CLI v2 source: |- phrase comments create \ @@ -319,7 +319,7 @@ CommentCreate: --key_id \ --data '{ "message": "Some message...", "branch": "my-feature-branch", "locale_ids": ["someId","someOtherId"] }' \ --access_token -CommentDelete: +comment/delete: lang: CLI v2 source: |- phrase comments delete \ @@ -328,7 +328,7 @@ CommentDelete: --id \ --branch "my-feature-branch" \ --access_token -CommentMarkCheck: +comment/mark/check: lang: CLI v2 source: |- phrase comments mark_check \ @@ -337,7 +337,7 @@ CommentMarkCheck: --id \ --branch "my-feature-branch" \ --access_token -CommentMarkRead: +comment/mark/read: lang: CLI v2 source: |- phrase comments mark_read \ @@ -346,7 +346,7 @@ CommentMarkRead: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -CommentMarkUnread: +comment/mark/unread: lang: CLI v2 source: |- phrase comments mark_unread \ @@ -355,7 +355,7 @@ CommentMarkUnread: --id \ --branch "my-feature-branch" \ --access_token -CommentShow: +comment/show: lang: CLI v2 source: |- phrase comments show \ @@ -364,7 +364,7 @@ CommentShow: --id \ --branch "my-feature-branch" \ --access_token -CommentUpdate: +comment/update: lang: CLI v2 source: |- phrase comments update \ @@ -373,7 +373,7 @@ CommentUpdate: --id \ --data '{ "branch": "my-feature-branch", "message": "Some message..." }' \ --access_token -CommentsList: +comments/list: lang: CLI v2 source: |- phrase comments list \ @@ -387,14 +387,14 @@ CommentsList: --filters "["read","unread"]" \ --order "desc" \ --access_token -CustomMetadataPropertiesDelete: +custom_metadata_properties/delete: lang: CLI v2 source: |- phrase custom_metadata delete \ --account_id \ --id \ --access_token -CustomMetadataPropertiesList: +custom_metadata_properties/list: lang: CLI v2 source: |- phrase custom_metadata list \ @@ -407,21 +407,21 @@ CustomMetadataPropertiesList: --sort "updated_at" \ --order "desc" \ --access_token -CustomMetadataPropertyCreate: +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 -CustomMetadataPropertyShow: +custom_metadata_property/show: lang: CLI v2 source: |- phrase custom_metadata show \ --account_id \ --id \ --access_token -CustomMetadataPropertyUpdate: +custom_metadata_property/update: lang: CLI v2 source: |- phrase custom_metadata update \ @@ -429,28 +429,28 @@ CustomMetadataPropertyUpdate: --id \ --data '{ "name": "Fruit", "project_ids": ["abcd1234cdef1234abcd1234cdef1234","abcd1234cdef1234abcd1234cdef4321"], "description": "A healthy snack for all ages", "value_options": ["Apple","Banana","Coconut"] }' \ --access_token -DistributionCreate: +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 -DistributionDelete: +distribution/delete: lang: CLI v2 source: |- phrase distributions delete \ --account_id \ --id \ --access_token -DistributionShow: +distribution/show: lang: CLI v2 source: |- phrase distributions show \ --account_id \ --id \ --access_token -DistributionUpdate: +distribution/update: lang: CLI v2 source: |- phrase distributions update \ @@ -458,7 +458,7 @@ DistributionUpdate: --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 -DistributionsList: +distributions/list: lang: CLI v2 source: |- phrase distributions list \ @@ -466,14 +466,14 @@ DistributionsList: --page "1" \ --per_page "25" \ --access_token -DocumentDelete: +document/delete: lang: CLI v2 source: |- phrase documents delete \ --project_id \ --id \ --access_token -DocumentsList: +documents/list: lang: CLI v2 source: |- phrase documents list \ @@ -482,7 +482,7 @@ DocumentsList: --per_page "25" \ --q "invoice" \ --access_token -FigmaAttachmentCreate: +figma_attachment/create: lang: CLI v2 source: |- phrase figma_attachments create \ @@ -490,7 +490,7 @@ FigmaAttachmentCreate: --branch "my-feature-branch" \ --data '{ "branch": "my-feature-branch", "url": "https://figma.com/file/xxxxx/sample" }' \ --access_token -FigmaAttachmentDelete: +figma_attachment/delete: lang: CLI v2 source: |- phrase figma_attachments delete \ @@ -498,7 +498,7 @@ FigmaAttachmentDelete: --id \ --branch "my-feature-branch" \ --access_token -FigmaAttachmentShow: +figma_attachment/show: lang: CLI v2 source: |- phrase figma_attachments show \ @@ -506,7 +506,7 @@ FigmaAttachmentShow: --id \ --branch "my-feature-branch" \ --access_token -FigmaAttachmentUpdate: +figma_attachment/update: lang: CLI v2 source: |- phrase figma_attachments update \ @@ -515,7 +515,7 @@ FigmaAttachmentUpdate: --branch "my-feature-branch" \ --data '{ "branch": "my-feature-branch", "url": "https://figma.com/file/xxxxx/sample" }' \ --access_token -FigmaAttachmentsList: +figma_attachments/list: lang: CLI v2 source: |- phrase figma_attachments list \ @@ -524,12 +524,12 @@ FigmaAttachmentsList: --per_page "25" \ --branch "my-feature-branch" \ --access_token -FormatsList: +formats/list: lang: CLI v2 source: |- phrase formats list \ --access_token -GlossariesList: +glossaries/list: lang: CLI v2 source: |- phrase glossaries list \ @@ -537,28 +537,28 @@ GlossariesList: --page "1" \ --per_page "25" \ --access_token -GlossaryCreate: +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 -GlossaryDelete: +glossary/delete: lang: CLI v2 source: |- phrase glossaries delete \ --account_id \ --id \ --access_token -GlossaryShow: +glossary/show: lang: CLI v2 source: |- phrase glossaries show \ --account_id \ --id \ --access_token -GlossaryUpdate: +glossary/update: lang: CLI v2 source: |- phrase glossaries update \ @@ -566,7 +566,7 @@ GlossaryUpdate: --id \ --data '{ "name": "My glossary", "project_ids": "abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235", "space_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ --access_token -GlossaryTermTranslationCreate: +glossary_term_translation/create: lang: CLI v2 source: |- phrase glossary_term_translations create \ @@ -575,7 +575,7 @@ GlossaryTermTranslationCreate: --term_id \ --data '{ "locale_code": "en-US", "content": "My translated term" }' \ --access_token -GlossaryTermTranslationDelete: +glossary_term_translation/delete: lang: CLI v2 source: |- phrase glossary_term_translations delete \ @@ -584,7 +584,7 @@ GlossaryTermTranslationDelete: --term_id \ --id \ --access_token -GlossaryTermTranslationUpdate: +glossary_term_translation/update: lang: CLI v2 source: |- phrase glossary_term_translations update \ @@ -594,7 +594,7 @@ GlossaryTermTranslationUpdate: --id \ --data '{ "locale_code": "en-US", "content": "My translated term" }' \ --access_token -GlossaryTermCreate: +glossary_term/create: lang: CLI v2 source: |- phrase glossary_terms create \ @@ -602,7 +602,7 @@ GlossaryTermCreate: --glossary_id \ --data '{ "term": "MyCompany", "description": "Use this when refering to our company", "translatable": true, "case_sensitive": true }' \ --access_token -GlossaryTermDelete: +glossary_term/delete: lang: CLI v2 source: |- phrase glossary_terms delete \ @@ -610,7 +610,7 @@ GlossaryTermDelete: --glossary_id \ --id \ --access_token -GlossaryTermShow: +glossary_term/show: lang: CLI v2 source: |- phrase glossary_terms show \ @@ -618,7 +618,7 @@ GlossaryTermShow: --glossary_id \ --id \ --access_token -GlossaryTermUpdate: +glossary_term/update: lang: CLI v2 source: |- phrase glossary_terms update \ @@ -627,7 +627,7 @@ GlossaryTermUpdate: --id \ --data '{ "term": "MyCompany", "description": "Use this when refering to our company", "translatable": true, "case_sensitive": true }' \ --access_token -GlossaryTermsList: +glossary_terms/list: lang: CLI v2 source: |- phrase glossary_terms list \ @@ -636,41 +636,41 @@ GlossaryTermsList: --page "1" \ --per_page "25" \ --access_token -IcuSkeleton: +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 -InvitationCreate: +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 -InvitationDelete: +invitation/delete: lang: CLI v2 source: |- phrase invitations delete \ --account_id \ --id \ --access_token -InvitationResend: +invitation/resend: lang: CLI v2 source: |- phrase invitations resend \ --account_id \ --id \ --access_token -InvitationShow: +invitation/show: lang: CLI v2 source: |- phrase invitations show \ --account_id \ --id \ --access_token -InvitationUpdate: +invitation/update: lang: CLI v2 source: |- phrase invitations update \ @@ -678,7 +678,7 @@ InvitationUpdate: --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 -InvitationUpdateSettings: +invitation/update_settings: lang: CLI v2 source: |- phrase invitations update_settings \ @@ -686,7 +686,7 @@ InvitationUpdateSettings: --id \ --data '{ "project_role": "Developer", "locale_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ --access_token -InvitationsList: +invitations/list: lang: CLI v2 source: |- phrase invitations list \ @@ -694,7 +694,7 @@ InvitationsList: --page "1" \ --per_page "25" \ --access_token -JobAnnotationDelete: +job_annotation/delete: lang: CLI v2 source: |- phrase job_annotations delete \ @@ -703,7 +703,7 @@ JobAnnotationDelete: --id \ --branch "my-feature-branch" \ --access_token -JobAnnotationUpdate: +job_annotation/update: lang: CLI v2 source: |- phrase job_annotations update \ @@ -712,7 +712,7 @@ JobAnnotationUpdate: --id \ --data '{ "value": "Some value...", "branch": "my-feature-branch" }' \ --access_token -JobAnnotationsList: +job_annotations/list: lang: CLI v2 source: |- phrase job_annotations list \ @@ -720,7 +720,7 @@ JobAnnotationsList: --job_id \ --branch "my-feature-branch" \ --access_token -JobLocaleAnnotationDelete: +job_locale_annotation/delete: lang: CLI v2 source: |- phrase job_annotations delete \ @@ -730,7 +730,7 @@ JobLocaleAnnotationDelete: --id \ --branch "my-feature-branch" \ --access_token -JobLocaleAnnotationUpdate: +job_locale_annotation/update: lang: CLI v2 source: |- phrase job_annotations update \ @@ -740,7 +740,7 @@ JobLocaleAnnotationUpdate: --id \ --data '{ "value": "Some value...", "branch": "my-feature-branch" }' \ --access_token -JobLocaleAnnotationsList: +job_locale_annotations/list: lang: CLI v2 source: |- phrase job_annotations list \ @@ -749,7 +749,7 @@ JobLocaleAnnotationsList: --job_locale_id \ --branch "my-feature-branch" \ --access_token -JobCommentCreate: +job_comment/create: lang: CLI v2 source: |- phrase job_comments create \ @@ -757,7 +757,7 @@ JobCommentCreate: --job_id \ --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ --access_token -JobCommentDelete: +job_comment/delete: lang: CLI v2 source: |- phrase job_comments delete \ @@ -766,7 +766,7 @@ JobCommentDelete: --id \ --branch "my-feature-branch" \ --access_token -JobCommentShow: +job_comment/show: lang: CLI v2 source: |- phrase job_comments show \ @@ -775,7 +775,7 @@ JobCommentShow: --id \ --branch "my-feature-branch" \ --access_token -JobCommentUpdate: +job_comment/update: lang: CLI v2 source: |- phrase job_comments update \ @@ -784,7 +784,7 @@ JobCommentUpdate: --id \ --data '{ "message": "Some message...", "branch": "my-feature-branch" }' \ --access_token -JobCommentsList: +job_comments/list: lang: CLI v2 source: |- phrase job_comments list \ @@ -793,7 +793,7 @@ JobCommentsList: --branch "my-feature-branch" \ --order "desc" \ --access_token -JobLocaleComplete: +job_locale/complete: lang: CLI v2 source: |- phrase job_locales complete \ @@ -802,7 +802,7 @@ JobLocaleComplete: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -JobLocaleCompleteReview: +job_locale/complete_review: lang: CLI v2 source: |- phrase job_locales complete_review \ @@ -811,7 +811,7 @@ JobLocaleCompleteReview: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -JobLocaleDelete: +job_locale/delete: lang: CLI v2 source: |- phrase job_locales delete \ @@ -820,7 +820,7 @@ JobLocaleDelete: --id \ --branch "my-feature-branch" \ --access_token -JobLocaleReopen: +job_locale/reopen: lang: CLI v2 source: |- phrase job_locales reopen \ @@ -829,7 +829,7 @@ JobLocaleReopen: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -JobLocaleShow: +job_locale/show: lang: CLI v2 source: |- phrase job_locales show \ @@ -839,7 +839,7 @@ JobLocaleShow: --branch "my-feature-branch" \ --include_annotations true \ --access_token -JobLocaleUpdate: +job_locale/update: lang: CLI v2 source: |- phrase job_locales update \ @@ -848,7 +848,7 @@ JobLocaleUpdate: --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 -JobLocalesCreate: +job_locales/create: lang: CLI v2 source: |- phrase job_locales create \ @@ -856,7 +856,7 @@ JobLocalesCreate: --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 -JobLocalesList: +job_locales/list: lang: CLI v2 source: |- phrase job_locales list \ @@ -867,7 +867,7 @@ JobLocalesList: --branch "my-feature-branch" \ --include_annotations true \ --access_token -JobTemplateLocaleDelete: +job_template_locale/delete: lang: CLI v2 source: |- phrase job_template_locales delete \ @@ -876,7 +876,7 @@ JobTemplateLocaleDelete: --job_template_locale_id \ --branch "my-feature-branch" \ --access_token -JobTemplateLocaleShow: +job_template_locale/show: lang: CLI v2 source: |- phrase job_template_locales show \ @@ -885,7 +885,7 @@ JobTemplateLocaleShow: --job_template_locale_id \ --branch "my-feature-branch" \ --access_token -JobTemplateLocaleUpdate: +job_template_locale/update: lang: CLI v2 source: |- phrase job_template_locales update \ @@ -894,7 +894,7 @@ JobTemplateLocaleUpdate: --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 -JobTemplateLocalesCreate: +job_template_locales/create: lang: CLI v2 source: |- phrase job_template_locales create \ @@ -902,7 +902,7 @@ JobTemplateLocalesCreate: --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 -JobTemplateLocalesList: +job_template_locales/list: lang: CLI v2 source: |- phrase job_template_locales list \ @@ -912,14 +912,14 @@ JobTemplateLocalesList: --per_page "25" \ --branch "my-feature-branch" \ --access_token -JobTemplateCreate: +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 -JobTemplateDelete: +job_template/delete: lang: CLI v2 source: |- phrase job_templates delete \ @@ -927,7 +927,7 @@ JobTemplateDelete: --id \ --branch "my-feature-branch" \ --access_token -JobTemplateUpdate: +job_template/update: lang: CLI v2 source: |- phrase job_templates update \ @@ -935,7 +935,7 @@ JobTemplateUpdate: --id \ --data '{ "branch": "my-feature-branch", "name": "template", "briefing": "text", "autotranslate": true, "source_locale_id": "abcd1234cdef1234abcd1234cdef1234" }' \ --access_token -JobTemplatesList: +job_templates/list: lang: CLI v2 source: |- phrase job_templates list \ @@ -944,7 +944,7 @@ JobTemplatesList: --per_page "25" \ --branch "my-feature-branch" \ --access_token -JobTemplatesShow: +job_templates/show: lang: CLI v2 source: |- phrase job_templates show \ @@ -952,7 +952,7 @@ JobTemplatesShow: --id \ --branch "my-feature-branch" \ --access_token -JobComplete: +job/complete: lang: CLI v2 source: |- phrase jobs complete \ @@ -960,14 +960,14 @@ JobComplete: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -JobCreate: +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 -JobDelete: +job/delete: lang: CLI v2 source: |- phrase jobs delete \ @@ -975,7 +975,7 @@ JobDelete: --id \ --branch "my-feature-branch" \ --access_token -JobKeysCreate: +job/keys/create: lang: CLI v2 source: |- phrase jobs keys_create \ @@ -983,7 +983,7 @@ JobKeysCreate: --id \ --data '{ "branch": "my-feature-branch", "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ --access_token -JobKeysDelete: +job/keys/delete: lang: CLI v2 source: |- phrase jobs keys_delete \ @@ -991,7 +991,7 @@ JobKeysDelete: --id \ --data '{ "branch": "my-feature-branch", "translation_key_ids": ["abcd1234cdef1234abcd1234cdef1234"] }' \ --access_token -JobLock: +job/lock: lang: CLI v2 source: |- phrase jobs lock \ @@ -999,7 +999,7 @@ JobLock: --id \ --branch "my-feature-branch" \ --access_token -JobReopen: +job/reopen: lang: CLI v2 source: |- phrase jobs reopen \ @@ -1007,7 +1007,7 @@ JobReopen: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -JobShow: +job/show: lang: CLI v2 source: |- phrase jobs show \ @@ -1017,7 +1017,7 @@ JobShow: --include_annotations true \ --omit_translation_keys true \ --access_token -JobStart: +job/start: lang: CLI v2 source: |- phrase jobs start \ @@ -1025,7 +1025,7 @@ JobStart: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -JobUnlock: +job/unlock: lang: CLI v2 source: |- phrase jobs unlock \ @@ -1033,7 +1033,7 @@ JobUnlock: --id \ --branch "my-feature-branch" \ --access_token -JobUpdate: +job/update: lang: CLI v2 source: |- phrase jobs update \ @@ -1041,7 +1041,7 @@ JobUpdate: --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 -JobsByAccount: +jobs/by_account: lang: CLI v2 source: |- phrase jobs by_account \ @@ -1053,7 +1053,7 @@ JobsByAccount: --state "completed" \ --updated_since "2013-02-21T00:00:00.000Z" \ --access_token -JobsList: +jobs/list: lang: CLI v2 source: |- phrase jobs list \ @@ -1068,14 +1068,14 @@ JobsList: --key_id "abcd1234cdef1234abcd1234cdef1234" \ --updated_since "2013-02-21T00:00:00.000Z" \ --access_token -KeyCreate: +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 -KeyDelete: +key/delete: lang: CLI v2 source: |- phrase keys delete \ @@ -1083,7 +1083,7 @@ KeyDelete: --id \ --branch "my-feature-branch" \ --access_token -KeyShow: +key/show: lang: CLI v2 source: |- phrase keys show \ @@ -1091,7 +1091,7 @@ KeyShow: --id \ --branch "my-feature-branch" \ --access_token -KeyUpdate: +key/update: lang: CLI v2 source: |- phrase keys update \ @@ -1099,7 +1099,7 @@ KeyUpdate: --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 -KeysDeleteCollection: +keys/delete-collection: lang: CLI v2 source: |- phrase keys delete-collection \ @@ -1108,21 +1108,21 @@ KeysDeleteCollection: --q "mykey* translated:true" \ --locale_id "abcd1234abcd1234abcd1234abcd1234" \ --access_token -KeysExclude: +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 -KeysInclude: +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 -KeysList: +keys/list: lang: CLI v2 source: |- phrase keys list \ @@ -1135,7 +1135,7 @@ KeysList: --q "mykey* translated:true" \ --locale_id "abcd1234abcd1234abcd1234abcd1234" \ --access_token -KeysSearch: +keys/search: lang: CLI v2 source: |- phrase keys search \ @@ -1144,21 +1144,21 @@ KeysSearch: --per_page "25" \ --data '{ "branch": "my-feature-branch", "sort": "updated_at", "order": "desc", "q": "mykey* translated:true", "locale_id": "abcd1234abcd1234abcd1234abcd1234" }' \ --access_token -KeysTag: +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 -KeysUntag: +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 -FigmaAttachmentAttachToKey: +figma_attachment/attach_to_key: lang: CLI v2 source: |- phrase keys_figma_attachments attach_to_key \ @@ -1167,7 +1167,7 @@ FigmaAttachmentAttachToKey: --id \ --branch "my-feature-branch" \ --access_token -FigmaAttachmentDetachFromKey: +figma_attachment/detach_from_key: lang: CLI v2 source: |- phrase keys_figma_attachments detach_from_key \ @@ -1176,7 +1176,7 @@ FigmaAttachmentDetachFromKey: --id \ --branch "my-feature-branch" \ --access_token -KeyLinksBatchDestroy: +key_links/batch_destroy: lang: CLI v2 source: |- phrase linked_keys batch_destroy \ @@ -1184,7 +1184,7 @@ KeyLinksBatchDestroy: --id \ --data '{ "child_key_ids": ["feature.subtitle","nav.home"], "unlink_parent": null, "strategy": "null" }' \ --access_token -KeyLinksCreate: +key_links/create: lang: CLI v2 source: |- phrase linked_keys create \ @@ -1192,7 +1192,7 @@ KeyLinksCreate: --id \ --data '{ "child_key_ids": ["child_key_id1","child_key_id2"] }' \ --access_token -KeyLinksDestroy: +key_links/destroy: lang: CLI v2 source: |- phrase linked_keys destroy \ @@ -1200,14 +1200,14 @@ KeyLinksDestroy: --id \ --child_key_id \ --access_token -KeyLinksIndex: +key_links/index: lang: CLI v2 source: |- phrase linked_keys index \ --project_id \ --id \ --access_token -LocaleDownloadCreate: +locale_download/create: lang: CLI v2 source: |- phrase locale_downloads create \ @@ -1217,7 +1217,7 @@ LocaleDownloadCreate: --If-None-Match "ifNoneMatch_example" \ --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 -LocaleDownloadShow: +locale_download/show: lang: CLI v2 source: |- phrase locale_downloads show \ @@ -1227,7 +1227,7 @@ LocaleDownloadShow: --If-Modified-Since "ifModifiedSince_example" \ --If-None-Match "ifNoneMatch_example" \ --access_token -AccountLocales: +account/locales: lang: CLI v2 source: |- phrase locales locales \ @@ -1235,14 +1235,14 @@ AccountLocales: --page "1" \ --per_page "25" \ --access_token -LocaleCreate: +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 -LocaleDelete: +locale/delete: lang: CLI v2 source: |- phrase locales delete \ @@ -1250,7 +1250,7 @@ LocaleDelete: --id \ --branch "my-feature-branch" \ --access_token -LocaleDownload: +locale/download: lang: CLI v2 source: |- phrase locales download \ @@ -1282,7 +1282,7 @@ LocaleDownload: --locale_ids "["de","en"]" \ --updated_since "2023-01-01T00:00:00Z" \ --access_token -LocaleShow: +locale/show: lang: CLI v2 source: |- phrase locales show \ @@ -1290,7 +1290,7 @@ LocaleShow: --id \ --branch "my-feature-branch" \ --access_token -LocaleUpdate: +locale/update: lang: CLI v2 source: |- phrase locales update \ @@ -1298,7 +1298,7 @@ LocaleUpdate: --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 -LocalesList: +locales/list: lang: CLI v2 source: |- phrase locales list \ @@ -1309,21 +1309,21 @@ LocalesList: --branch "my-feature-branch" \ --q "name:en" \ --access_token -MemberDelete: +member/delete: lang: CLI v2 source: |- phrase members delete \ --account_id \ --id \ --access_token -MemberShow: +member/show: lang: CLI v2 source: |- phrase members show \ --account_id \ --id \ --access_token -MemberUpdate: +member/update: lang: CLI v2 source: |- phrase members update \ @@ -1331,7 +1331,7 @@ MemberUpdate: --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 -MemberUpdateSettings: +member/update_settings: lang: CLI v2 source: |- phrase members update_settings \ @@ -1339,7 +1339,7 @@ MemberUpdateSettings: --id \ --data '{ "project_role": "Developer", "locale_ids": ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"] }' \ --access_token -MembersList: +members/list: lang: CLI v2 source: |- phrase members list \ @@ -1347,25 +1347,25 @@ MembersList: --page "1" \ --per_page "25" \ --access_token -NotificationGroupsList: +notification_groups/list: lang: CLI v2 source: |- phrase notification_groups list \ --page "1" \ --per_page "25" \ --access_token -NotificationGroupsMarkAllAsRead: +notification_groups/mark_all_as_read: lang: CLI v2 source: |- phrase notification_groups mark_all_as_read \ --access_token -NotificationGroupsMarkAsRead: +notification_groups/mark_as_read: lang: CLI v2 source: |- phrase notification_groups mark_as_read \ --id \ --access_token -NotificationsList: +notifications/list: lang: CLI v2 source: |- phrase notifications list \ @@ -1374,18 +1374,18 @@ NotificationsList: --unseen true \ --last_days "7" \ --access_token -NotificationsMarkAllAsRead: +notifications/mark_all_as_read: lang: CLI v2 source: |- phrase notifications mark_all_as_read \ --access_token -NotificationsShow: +notifications/show: lang: CLI v2 source: |- phrase notifications show \ --id \ --access_token -OrderConfirm: +order/confirm: lang: CLI v2 source: |- phrase orders confirm \ @@ -1393,14 +1393,14 @@ OrderConfirm: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -OrderCreate: +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 -OrderDelete: +order/delete: lang: CLI v2 source: |- phrase orders delete \ @@ -1408,7 +1408,7 @@ OrderDelete: --id \ --branch "my-feature-branch" \ --access_token -OrderShow: +order/show: lang: CLI v2 source: |- phrase orders show \ @@ -1416,7 +1416,7 @@ OrderShow: --id \ --branch "my-feature-branch" \ --access_token -OrdersList: +orders/list: lang: CLI v2 source: |- phrase orders list \ @@ -1426,7 +1426,7 @@ OrdersList: --branch "my-feature-branch" \ --translation_id "abcd1234cdef1234abcd1234cdef1234" \ --access_token -OrganizationJobTemplateLocaleDelete: +organization_job_template_locale/delete: lang: CLI v2 source: |- phrase organization_job_template_locales delete \ @@ -1434,7 +1434,7 @@ OrganizationJobTemplateLocaleDelete: --job_template_id \ --job_template_locale_id \ --access_token -OrganizationJobTemplateLocaleShow: +organization_job_template_locale/show: lang: CLI v2 source: |- phrase organization_job_template_locales show \ @@ -1442,7 +1442,7 @@ OrganizationJobTemplateLocaleShow: --job_template_id \ --job_template_locale_id \ --access_token -OrganizationJobTemplateLocaleUpdate: +organization_job_template_locale/update: lang: CLI v2 source: |- phrase organization_job_template_locales update \ @@ -1451,7 +1451,7 @@ OrganizationJobTemplateLocaleUpdate: --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 -OrganizationJobTemplateLocalesCreate: +organization_job_template_locales/create: lang: CLI v2 source: |- phrase organization_job_template_locales create \ @@ -1459,7 +1459,7 @@ OrganizationJobTemplateLocalesCreate: --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 -OrganizationJobTemplateLocalesList: +organization_job_template_locales/list: lang: CLI v2 source: |- phrase organization_job_template_locales list \ @@ -1468,21 +1468,21 @@ OrganizationJobTemplateLocalesList: --page "1" \ --per_page "25" \ --access_token -OrganizationJobTemplateCreate: +organization_job_template/create: lang: CLI v2 source: |- phrase organization_job_templates create \ --account_id \ --data '{ "name": "template", "briefing": "text", "autotranslate": true }' \ --access_token -OrganizationJobTemplateDelete: +organization_job_template/delete: lang: CLI v2 source: |- phrase organization_job_templates delete \ --account_id \ --id \ --access_token -OrganizationJobTemplateUpdate: +organization_job_template/update: lang: CLI v2 source: |- phrase organization_job_templates update \ @@ -1490,7 +1490,7 @@ OrganizationJobTemplateUpdate: --id \ --data '{ "name": "template", "briefing": "text", "autotranslate": true }' \ --access_token -OrganizationJobTemplatesList: +organization_job_templates/list: lang: CLI v2 source: |- phrase organization_job_templates list \ @@ -1498,39 +1498,39 @@ OrganizationJobTemplatesList: --page "1" \ --per_page "25" \ --access_token -OrganizationJobTemplatesShow: +organization_job_templates/show: lang: CLI v2 source: |- phrase organization_job_templates show \ --account_id \ --id \ --access_token -ProjectCreate: +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 -ProjectDelete: +project/delete: lang: CLI v2 source: |- phrase projects delete \ --id \ --access_token -ProjectShow: +project/show: lang: CLI v2 source: |- phrase projects show \ --id \ --access_token -ProjectUpdate: +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 -ProjectsList: +projects/list: lang: CLI v2 source: |- phrase projects list \ @@ -1541,14 +1541,14 @@ ProjectsList: --filters "favorites" \ --q "name:android" \ --access_token -QualityPerformanceScoreList: +quality_performance_score/list: lang: CLI v2 source: |- phrase quality_performance_score list \ --project_id \ --data '{ "translation_ids": null }' \ --access_token -ReleaseTriggersCreate: +release_triggers/create: lang: CLI v2 source: |- phrase release_triggers create \ @@ -1556,7 +1556,7 @@ ReleaseTriggersCreate: --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 -ReleaseTriggersDestroy: +release_triggers/destroy: lang: CLI v2 source: |- phrase release_triggers destroy \ @@ -1564,14 +1564,14 @@ ReleaseTriggersDestroy: --distribution_id \ --id \ --access_token -ReleaseTriggersList: +release_triggers/list: lang: CLI v2 source: |- phrase release_triggers list \ --account_id \ --distribution_id \ --access_token -ReleaseTriggersShow: +release_triggers/show: lang: CLI v2 source: |- phrase release_triggers show \ @@ -1579,7 +1579,7 @@ ReleaseTriggersShow: --distribution_id \ --id \ --access_token -ReleaseTriggersUpdate: +release_triggers/update: lang: CLI v2 source: |- phrase release_triggers update \ @@ -1588,7 +1588,7 @@ ReleaseTriggersUpdate: --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 -ReleaseCreate: +release/create: lang: CLI v2 source: |- phrase releases create \ @@ -1596,7 +1596,7 @@ ReleaseCreate: --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 -ReleaseDelete: +release/delete: lang: CLI v2 source: |- phrase releases delete \ @@ -1604,7 +1604,7 @@ ReleaseDelete: --distribution_id \ --id \ --access_token -ReleasePublish: +release/publish: lang: CLI v2 source: |- phrase releases publish \ @@ -1612,7 +1612,7 @@ ReleasePublish: --distribution_id \ --id \ --access_token -ReleaseShow: +release/show: lang: CLI v2 source: |- phrase releases show \ @@ -1620,7 +1620,7 @@ ReleaseShow: --distribution_id \ --id \ --access_token -ReleaseUpdate: +release/update: lang: CLI v2 source: |- phrase releases update \ @@ -1629,7 +1629,7 @@ ReleaseUpdate: --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 -ReleasesList: +releases/list: lang: CLI v2 source: |- phrase releases list \ @@ -1638,14 +1638,14 @@ ReleasesList: --page "1" \ --per_page "25" \ --access_token -RepoSyncEventList: +repo_sync_event/list: lang: CLI v2 source: |- phrase repo_sync_events list \ --account_id \ --id \ --access_token -RepoSyncEventShow: +repo_sync_event/show: lang: CLI v2 source: |- phrase repo_sync_events show \ @@ -1653,28 +1653,28 @@ RepoSyncEventShow: --repo_sync_id \ --id \ --access_token -RepoSyncActivate: +repo_sync/activate: lang: CLI v2 source: |- phrase repo_syncs activate \ --account_id \ --id \ --access_token -RepoSyncCreate: +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 -RepoSyncDeactivate: +repo_sync/deactivate: lang: CLI v2 source: |- phrase repo_syncs deactivate \ --account_id \ --id \ --access_token -RepoSyncExport: +repo_sync/export: lang: CLI v2 source: |- phrase repo_syncs export \ @@ -1682,7 +1682,7 @@ RepoSyncExport: --id \ --data '{ "pr_branch": "my-feature-branch", "branch": "my-strings-branch" }' \ --access_token -RepoSyncImport: +repo_sync/import: lang: CLI v2 source: |- phrase repo_syncs import \ @@ -1690,20 +1690,20 @@ RepoSyncImport: --id \ --data '{ "repository_branch": "my-feature-branch", "branch": "my-strings-branch" }' \ --access_token -RepoSyncList: +repo_sync/list: lang: CLI v2 source: |- phrase repo_syncs list \ --account_id \ --access_token -RepoSyncShow: +repo_sync/show: lang: CLI v2 source: |- phrase repo_syncs show \ --account_id \ --id \ --access_token -ReportLocalesList: +report/locales/list: lang: CLI v2 source: |- phrase reports locales_list \ @@ -1714,14 +1714,14 @@ ReportLocalesList: --tag "tag_example" \ --branch "my-feature-branch" \ --access_token -ReportShow: +report/show: lang: CLI v2 source: |- phrase reports show \ --project_id \ --branch "my-feature-branch" \ --access_token -ScreenshotMarkerCreate: +screenshot_marker/create: lang: CLI v2 source: |- phrase screenshot_markers create \ @@ -1729,7 +1729,7 @@ ScreenshotMarkerCreate: --screenshot_id \ --data '{ "branch": "my-feature-branch", "key_id": "abcd1234abcd1234abcd1234abcd1234", "presentation": "{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }" }' \ --access_token -ScreenshotMarkerDelete: +screenshot_marker/delete: lang: CLI v2 source: |- phrase screenshot_markers delete \ @@ -1737,7 +1737,7 @@ ScreenshotMarkerDelete: --screenshot_id \ --branch "my-feature-branch" \ --access_token -ScreenshotMarkerShow: +screenshot_marker/show: lang: CLI v2 source: |- phrase screenshot_markers show \ @@ -1746,7 +1746,7 @@ ScreenshotMarkerShow: --id \ --branch "my-feature-branch" \ --access_token -ScreenshotMarkerUpdate: +screenshot_marker/update: lang: CLI v2 source: |- phrase screenshot_markers update \ @@ -1754,7 +1754,7 @@ ScreenshotMarkerUpdate: --screenshot_id \ --data '{ "branch": "my-feature-branch", "key_id": "abcd1234abcd1234abcd1234abcd1234", "presentation": "{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }" }' \ --access_token -ScreenshotMarkersList: +screenshot_markers/list: lang: CLI v2 source: |- phrase screenshot_markers list \ @@ -1764,7 +1764,7 @@ ScreenshotMarkersList: --per_page "25" \ --branch "my-feature-branch" \ --access_token -ScreenshotCreate: +screenshot/create: lang: CLI v2 source: |- phrase screenshots create \ @@ -1774,7 +1774,7 @@ ScreenshotCreate: --name "name_example" \ --description "description_example" \ --access_token -ScreenshotDelete: +screenshot/delete: lang: CLI v2 source: |- phrase screenshots delete \ @@ -1782,7 +1782,13 @@ ScreenshotDelete: --id \ --branch "my-feature-branch" \ --access_token -ScreenshotShow: +screenshot/ping: + lang: CLI v2 + source: |- + phrase screenshots ping \ + --project_id \ + --access_token +screenshot/show: lang: CLI v2 source: |- phrase screenshots show \ @@ -1790,7 +1796,7 @@ ScreenshotShow: --id \ --branch "my-feature-branch" \ --access_token -ScreenshotUpdate: +screenshot/update: lang: CLI v2 source: |- phrase screenshots update \ @@ -1798,7 +1804,7 @@ ScreenshotUpdate: --id \ --data '{ "branch": "my-feature-branch", "name": "A screenshot name", "description": "A screenshot description", "filename": "" }' \ --access_token -ScreenshotsList: +screenshots/list: lang: CLI v2 source: |- phrase screenshots list \ @@ -1808,35 +1814,35 @@ ScreenshotsList: --branch "my-feature-branch" \ --key_id "abcd1234cdef1234abcd1234cdef1234" \ --access_token -SearchInAccount: +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 -SpaceCreate: +space/create: lang: CLI v2 source: |- phrase spaces create \ --account_id \ --data '{ "name": "My Android Projects" }' \ --access_token -SpaceDelete: +space/delete: lang: CLI v2 source: |- phrase spaces delete \ --account_id \ --id \ --access_token -SpaceShow: +space/show: lang: CLI v2 source: |- phrase spaces show \ --account_id \ --id \ --access_token -SpaceUpdate: +space/update: lang: CLI v2 source: |- phrase spaces update \ @@ -1844,7 +1850,7 @@ SpaceUpdate: --id \ --data '{ "name": "My Android Projects" }' \ --access_token -SpacesList: +spaces/list: lang: CLI v2 source: |- phrase spaces list \ @@ -1852,7 +1858,7 @@ SpacesList: --page "1" \ --per_page "25" \ --access_token -SpacesProjectsCreate: +spaces/projects/create: lang: CLI v2 source: |- phrase spaces projects_create \ @@ -1860,7 +1866,7 @@ SpacesProjectsCreate: --space_id \ --data '{ "id": "a4b3c2d1" }' \ --access_token -SpacesProjectsDelete: +spaces/projects/delete: lang: CLI v2 source: |- phrase spaces projects_delete \ @@ -1868,7 +1874,7 @@ SpacesProjectsDelete: --space_id \ --id \ --access_token -SpacesProjectsList: +spaces/projects/list: lang: CLI v2 source: |- phrase spaces projects_list \ @@ -1877,28 +1883,28 @@ SpacesProjectsList: --page "1" \ --per_page "25" \ --access_token -StyleguideCreate: +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 -StyleguideDelete: +styleguide/delete: lang: CLI v2 source: |- phrase style_guides delete \ --project_id \ --id \ --access_token -StyleguideShow: +styleguide/show: lang: CLI v2 source: |- phrase style_guides show \ --project_id \ --id \ --access_token -StyleguideUpdate: +styleguide/update: lang: CLI v2 source: |- phrase style_guides update \ @@ -1906,7 +1912,7 @@ StyleguideUpdate: --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 -StyleguidesList: +styleguides/list: lang: CLI v2 source: |- phrase style_guides list \ @@ -1914,14 +1920,14 @@ StyleguidesList: --page "1" \ --per_page "25" \ --access_token -TagCreate: +tag/create: lang: CLI v2 source: |- phrase tags create \ --project_id \ --data '{ "branch": "my-feature-branch", "name": "my-feature" }' \ --access_token -TagDelete: +tag/delete: lang: CLI v2 source: |- phrase tags delete \ @@ -1929,7 +1935,7 @@ TagDelete: --name \ --branch "my-feature-branch" \ --access_token -TagShow: +tag/show: lang: CLI v2 source: |- phrase tags show \ @@ -1938,7 +1944,7 @@ TagShow: --omit_statistics true \ --branch "my-feature-branch" \ --access_token -TagsList: +tags/list: lang: CLI v2 source: |- phrase tags list \ @@ -1950,28 +1956,28 @@ TagsList: --branch "my-feature-branch" \ --q "feature" \ --access_token -TeamCreate: +team/create: lang: CLI v2 source: |- phrase teams create \ --account_id \ --data '{ "name": "German Translators" }' \ --access_token -TeamDelete: +team/delete: lang: CLI v2 source: |- phrase teams delete \ --account_id \ --id \ --access_token -TeamShow: +team/show: lang: CLI v2 source: |- phrase teams show \ --account_id \ --id \ --access_token -TeamUpdate: +team/update: lang: CLI v2 source: |- phrase teams update \ @@ -1979,7 +1985,7 @@ TeamUpdate: --id \ --data '{ "name": "German Translators" }' \ --access_token -TeamsList: +teams/list: lang: CLI v2 source: |- phrase teams list \ @@ -1987,7 +1993,7 @@ TeamsList: --page "1" \ --per_page "25" \ --access_token -TeamsProjectsCreate: +teams/projects/create: lang: CLI v2 source: |- phrase teams projects_create \ @@ -1995,7 +2001,7 @@ TeamsProjectsCreate: --team_id \ --data '{ "id": "a4b3c2d1" }' \ --access_token -TeamsProjectsDelete: +teams/projects/delete: lang: CLI v2 source: |- phrase teams projects_delete \ @@ -2003,7 +2009,7 @@ TeamsProjectsDelete: --team_id \ --id \ --access_token -TeamsSpacesCreate: +teams/spaces/create: lang: CLI v2 source: |- phrase teams spaces_create \ @@ -2011,7 +2017,7 @@ TeamsSpacesCreate: --team_id \ --data '{ "id": "a4b3c2d1" }' \ --access_token -TeamsSpacesDelete: +teams/spaces/delete: lang: CLI v2 source: |- phrase teams spaces_delete \ @@ -2019,7 +2025,7 @@ TeamsSpacesDelete: --team_id \ --id \ --access_token -TeamsUsersCreate: +teams/users/create: lang: CLI v2 source: |- phrase teams users_create \ @@ -2027,7 +2033,7 @@ TeamsUsersCreate: --team_id \ --data '{ "id": "a4b3c2d1" }' \ --access_token -TeamsUsersDelete: +teams/users/delete: lang: CLI v2 source: |- phrase teams users_delete \ @@ -2035,14 +2041,14 @@ TeamsUsersDelete: --team_id \ --id \ --access_token -TranslationCreate: +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 -TranslationExclude: +translation/exclude: lang: CLI v2 source: |- phrase translations exclude \ @@ -2050,7 +2056,7 @@ TranslationExclude: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -TranslationInclude: +translation/include: lang: CLI v2 source: |- phrase translations include \ @@ -2058,7 +2064,7 @@ TranslationInclude: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -TranslationReview: +translation/review: lang: CLI v2 source: |- phrase translations review \ @@ -2066,7 +2072,7 @@ TranslationReview: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -TranslationShow: +translation/show: lang: CLI v2 source: |- phrase translations show \ @@ -2074,7 +2080,7 @@ TranslationShow: --id \ --branch "my-feature-branch" \ --access_token -TranslationUnreview: +translation/unreview: lang: CLI v2 source: |- phrase translations unreview \ @@ -2082,7 +2088,7 @@ TranslationUnreview: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -TranslationUnverify: +translation/unverify: lang: CLI v2 source: |- phrase translations unverify \ @@ -2090,7 +2096,7 @@ TranslationUnverify: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -TranslationUpdate: +translation/update: lang: CLI v2 source: |- phrase translations update \ @@ -2098,7 +2104,7 @@ TranslationUpdate: --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 -TranslationVerify: +translation/verify: lang: CLI v2 source: |- phrase translations verify \ @@ -2106,7 +2112,7 @@ TranslationVerify: --id \ --data '{ "branch": "my-feature-branch" }' \ --access_token -TranslationsByKey: +translations/by_key: lang: CLI v2 source: |- phrase translations by_key \ @@ -2119,7 +2125,7 @@ TranslationsByKey: --order "desc" \ --q "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" \ --access_token -TranslationsByLocale: +translations/by_locale: lang: CLI v2 source: |- phrase translations by_locale \ @@ -2132,21 +2138,21 @@ TranslationsByLocale: --order "desc" \ --q "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" \ --access_token -TranslationsExcludeCollection: +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 -TranslationsIncludeCollection: +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 -TranslationsList: +translations/list: lang: CLI v2 source: |- phrase translations list \ @@ -2162,14 +2168,14 @@ TranslationsList: --order "desc" \ --q "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" \ --access_token -TranslationsReviewCollection: +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 -TranslationsSearch: +translations/search: lang: CLI v2 source: |- phrase translations search \ @@ -2178,35 +2184,35 @@ TranslationsSearch: --per_page "25" \ --data '{ "branch": "my-feature-branch", "sort": "updated_at", "order": "desc", "q": "PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center" }' \ --access_token -TranslationsUnreviewCollection: +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 -TranslationsUnverifyCollection: +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 -TranslationsVerifyCollection: +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 -UploadBatchesCreate: +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 -UploadCreate: +upload/create: lang: CLI v2 source: |- phrase uploads create \ @@ -2235,7 +2241,7 @@ UploadCreate: --translation_key_prefix "translationKeyPrefix_example" \ --skip_automated_job_creation true \ --access_token -UploadShow: +upload/show: lang: CLI v2 source: |- phrase uploads show \ @@ -2243,7 +2249,7 @@ UploadShow: --id \ --branch "my-feature-branch" \ --access_token -UploadsList: +uploads/list: lang: CLI v2 source: |- phrase uploads list \ @@ -2252,33 +2258,33 @@ UploadsList: --per_page "25" \ --branch "my-feature-branch" \ --access_token -ShowUser: +show/user: lang: CLI v2 source: |- phrase users user \ --access_token -VariableCreate: +variable/create: lang: CLI v2 source: |- phrase variables create \ --project_id \ --data '{ "name": "MY_VARIABLE", "value": "Hello World" }' \ --access_token -VariableDelete: +variable/delete: lang: CLI v2 source: |- phrase variables delete \ --project_id \ --name \ --access_token -VariableShow: +variable/show: lang: CLI v2 source: |- phrase variables show \ --project_id \ --name \ --access_token -VariableUpdate: +variable/update: lang: CLI v2 source: |- phrase variables update \ @@ -2286,7 +2292,7 @@ VariableUpdate: --name \ --data '{ "name": "MY_VARIABLE", "value": "Hello World" }' \ --access_token -VariablesList: +variables/list: lang: CLI v2 source: |- phrase variables list \ @@ -2294,7 +2300,7 @@ VariablesList: --page "1" \ --per_page "25" \ --access_token -VersionShow: +version/show: lang: CLI v2 source: |- phrase versions_history show \ @@ -2303,7 +2309,7 @@ VersionShow: --id \ --branch "my-feature-branch" \ --access_token -VersionsList: +versions/list: lang: CLI v2 source: |- phrase versions_history list \ @@ -2314,7 +2320,7 @@ VersionsList: --branch "my-feature-branch" \ --only_content_updates true \ --access_token -WebhookDeliveriesList: +webhook_deliveries/list: lang: CLI v2 source: |- phrase webhook_deliveries list \ @@ -2322,7 +2328,7 @@ WebhookDeliveriesList: --webhook_id \ --response_status_codes "responseStatusCodes_example" \ --access_token -WebhookDeliveriesRedeliver: +webhook_deliveries/redeliver: lang: CLI v2 source: |- phrase webhook_deliveries redeliver \ @@ -2330,7 +2336,7 @@ WebhookDeliveriesRedeliver: --webhook_id \ --id \ --access_token -WebhookDeliveriesShow: +webhook_deliveries/show: lang: CLI v2 source: |- phrase webhook_deliveries show \ @@ -2338,35 +2344,35 @@ WebhookDeliveriesShow: --webhook_id \ --id \ --access_token -WebhookCreate: +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 -WebhookDelete: +webhook/delete: lang: CLI v2 source: |- phrase webhooks delete \ --project_id \ --id \ --access_token -WebhookShow: +webhook/show: lang: CLI v2 source: |- phrase webhooks show \ --project_id \ --id \ --access_token -WebhookTest: +webhook/test: lang: CLI v2 source: |- phrase webhooks test \ --project_id \ --id \ --access_token -WebhookUpdate: +webhook/update: lang: CLI v2 source: |- phrase webhooks update \ @@ -2374,7 +2380,7 @@ WebhookUpdate: --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 -WebhooksList: +webhooks/list: lang: CLI v2 source: |- phrase webhooks list \ 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/cli_lang.yaml b/openapi-generator/cli_lang.yaml index 64fdb90c..5b7b4e6d 100644 --- a/openapi-generator/cli_lang.yaml +++ b/openapi-generator/cli_lang.yaml @@ -5,7 +5,3 @@ packageName: phrase packageVersion: 2.66.0 templateDir: openapi-generator/templates/cli apiNameSuffix: Api -files: - cli_examples.handlebars: - destinationFilename: ../../examples/cli.yaml - templateType: SupportingFiles diff --git a/openapi-generator/templates/TEMPLATING.md b/openapi-generator/templates/TEMPLATING.md index 98c76e9c..b7ffe726 100644 --- a/openapi-generator/templates/TEMPLATING.md +++ b/openapi-generator/templates/TEMPLATING.md @@ -127,36 +127,34 @@ 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 the config's `files:` key: +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 ``` - NB: `destinationFilename` is relative to the generator's `-o` outputDir. The - `cli` Makefile target uses `-o tmp/cli`, so `../../examples/cli.yaml` lands at - repo root. Verify the path for whichever target runs it. -3. The generator can only write **one file per template invocation** — there is no - per-operation file output. Emit one combined file keyed by `operationId` - (PascalCase, e.g. `ScreenshotShow`). - -### Referencing generated samples back into the spec - -`x-code-samples[].source` is a plain string — a `$ref` there is ignored. But a -`$ref` as a **whole array element** resolves (the bundler expands any `$ref` it -finds, regardless of OpenAPI schema position). Both forms work and bundle + -validate cleanly: - -```yaml -x-code-samples: -- lang: Curl - source: |- ... -- "$ref": "../../examples/cli.yaml#/ScreenshotShow" # JSON-pointer into combined file -``` - -The relative depth must match the path file's nesting (`paths/a/b.yaml` → -`../../`, `paths/a/b/c.yaml` → `../../../`). + `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`): bundle YAML → `make examples` (regenerates +`examples/cli.yaml`) → bundle JSON+YAML → inject into both. The generator ignores +`x-code-samples`, so the injected samples in `tmp/compiled.yaml` do not affect a +subsequent `make examples`. ## When the template genuinely can't compute something diff --git a/openapi-generator/templates/cli/cli_examples.handlebars b/openapi-generator/templates/cli/cli_examples.handlebars index b08dba53..7a3ed281 100644 --- a/openapi-generator/templates/cli/cli_examples.handlebars +++ b/openapi-generator/templates/cli/cli_examples.handlebars @@ -1,4 +1,4 @@ -{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}{{operationId}}: +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}{{operationIdOriginal}}: lang: CLI v2 source: |- phrase {{{vendorExtensions.[x-cli-command]}}}{{#allParams}}{{^isBodyParam}}{{#unless (eq baseName "X-PhraseApp-OTP")}} \ diff --git a/paths/accounts/index.yaml b/paths/accounts/index.yaml index 61fdff03..0bb0de5b 100644 --- a/paths/accounts/index.yaml +++ b/paths/accounts/index.yaml @@ -44,6 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/AccountsList" x-cli-command: accounts list x-cli-version: '2.5' diff --git a/paths/accounts/locales.yaml b/paths/accounts/locales.yaml index 14825620..2e290ec5 100644 --- a/paths/accounts/locales.yaml +++ b/paths/accounts/locales.yaml @@ -45,6 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:id/locales" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/AccountLocales" x-cli-command: locales locales x-cli-version: '2.5' diff --git a/paths/accounts/show.yaml b/paths/accounts/show.yaml index f682b729..0a43f4ef 100644 --- a/paths/accounts/show.yaml +++ b/paths/accounts/show.yaml @@ -37,6 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/AccountShow" x-cli-command: accounts show x-cli-version: '2.5' diff --git a/paths/authorizations/create.yaml b/paths/authorizations/create.yaml index 16ae7376..a479b76b 100644 --- a/paths/authorizations/create.yaml +++ b/paths/authorizations/create.yaml @@ -41,7 +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' -- "$ref": "../../examples/cli.yaml#/AuthorizationCreate" requestBody: required: true content: diff --git a/paths/authorizations/destroy.yaml b/paths/authorizations/destroy.yaml index a9bb8760..1ea251ec 100644 --- a/paths/authorizations/destroy.yaml +++ b/paths/authorizations/destroy.yaml @@ -29,6 +29,5 @@ x-code-samples: curl "https://api.phrase.com/v2/authorizations/:id" \ -u USERNAME \ -X DELETE -- "$ref": "../../examples/cli.yaml#/AuthorizationDelete" x-cli-command: authorizations delete x-cli-version: '2.5' diff --git a/paths/authorizations/index.yaml b/paths/authorizations/index.yaml index 4f77cf7a..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 -- "$ref": "../../examples/cli.yaml#/AuthorizationsList" x-cli-command: authorizations list x-cli-version: '2.5' diff --git a/paths/authorizations/show.yaml b/paths/authorizations/show.yaml index cabf3553..6ab07b4f 100644 --- a/paths/authorizations/show.yaml +++ b/paths/authorizations/show.yaml @@ -37,6 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/authorizations/:id" \ -u USERNAME -- "$ref": "../../examples/cli.yaml#/AuthorizationShow" x-cli-command: authorizations show x-cli-version: '2.5' diff --git a/paths/authorizations/update.yaml b/paths/authorizations/update.yaml index 0de6d9e7..417d2fff 100644 --- a/paths/authorizations/update.yaml +++ b/paths/authorizations/update.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/AuthorizationUpdate" requestBody: required: true content: diff --git a/paths/automations/activate.yaml b/paths/automations/activate.yaml index d2f01ff5..85728c58 100644 --- a/paths/automations/activate.yaml +++ b/paths/automations/activate.yaml @@ -45,5 +45,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/AutomationActivate" x-cli-command: automations activate diff --git a/paths/automations/create.yaml b/paths/automations/create.yaml index 4ee4a631..293ec062 100644 --- a/paths/automations/create.yaml +++ b/paths/automations/create.yaml @@ -113,5 +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' -- "$ref": "../../examples/cli.yaml#/AutomationCreate" x-cli-command: automations create diff --git a/paths/automations/deactivate.yaml b/paths/automations/deactivate.yaml index b05096c6..1e4de6d1 100644 --- a/paths/automations/deactivate.yaml +++ b/paths/automations/deactivate.yaml @@ -45,5 +45,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/AutomationDeactivate" x-cli-command: automations deactivate diff --git a/paths/automations/destroy.yaml b/paths/automations/destroy.yaml index bf8c14a7..36b39632 100644 --- a/paths/automations/destroy.yaml +++ b/paths/automations/destroy.yaml @@ -32,5 +32,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/AutomationDelete" x-cli-command: automations delete diff --git a/paths/automations/index.yaml b/paths/automations/index.yaml index 390def8f..01a0988b 100644 --- a/paths/automations/index.yaml +++ b/paths/automations/index.yaml @@ -48,5 +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 -- "$ref": "../../examples/cli.yaml#/AutomationsList" x-cli-command: automations list diff --git a/paths/automations/show.yaml b/paths/automations/show.yaml index 5f22d53c..79535754 100644 --- a/paths/automations/show.yaml +++ b/paths/automations/show.yaml @@ -41,5 +41,4 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/automations/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/AutomationShow" x-cli-command: automations show diff --git a/paths/automations/trigger.yaml b/paths/automations/trigger.yaml index f1820892..f61c83f2 100644 --- a/paths/automations/trigger.yaml +++ b/paths/automations/trigger.yaml @@ -32,5 +32,4 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/AutomationTrigger" x-cli-command: automations trigger diff --git a/paths/automations/update.yaml b/paths/automations/update.yaml index bb778a6d..6892b18f 100644 --- a/paths/automations/update.yaml +++ b/paths/automations/update.yaml @@ -111,5 +111,4 @@ x-code-samples: -X PATCH \ -d '{"name":"Schedule Automation - Weekly","tag_ids":["5","6"],time_zone:"UTC"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/AutomationUpdate" x-cli-command: automations update diff --git a/paths/blacklisted_keys/create.yaml b/paths/blacklisted_keys/create.yaml index a30b38ba..4c160330 100644 --- a/paths/blacklisted_keys/create.yaml +++ b/paths/blacklisted_keys/create.yaml @@ -42,7 +42,6 @@ x-code-samples: -X POST \ -d '{"name":"date.formats.*"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/BlacklistedKeyCreate" requestBody: required: true content: diff --git a/paths/blacklisted_keys/destroy.yaml b/paths/blacklisted_keys/destroy.yaml index 00748f7a..5b152832 100644 --- a/paths/blacklisted_keys/destroy.yaml +++ b/paths/blacklisted_keys/destroy.yaml @@ -30,6 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/blacklisted_keys/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/BlacklistedKeyDelete" 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 1b80207a..a500df41 100644 --- a/paths/blacklisted_keys/index.yaml +++ b/paths/blacklisted_keys/index.yaml @@ -51,6 +51,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/blacklisted_keys" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/BlacklistedKeysList" 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 2dbb9eea..c92a9368 100644 --- a/paths/blacklisted_keys/show.yaml +++ b/paths/blacklisted_keys/show.yaml @@ -38,6 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/blacklisted_keys/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/BlacklistedKeyShow" 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 5795f746..77237dea 100644 --- a/paths/blacklisted_keys/update.yaml +++ b/paths/blacklisted_keys/update.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"name":"date.formats.*"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/BlacklistedKeyUpdate" requestBody: required: true content: diff --git a/paths/branches/compare.yaml b/paths/branches/compare.yaml index 65f3f756..864f1edb 100644 --- a/paths/branches/compare.yaml +++ b/paths/branches/compare.yaml @@ -45,6 +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 -- "$ref": "../../examples/cli.yaml#/BranchCompare" x-cli-command: branches compare x-cli-version: '2.5' diff --git a/paths/branches/create.yaml b/paths/branches/create.yaml index 6db84675..165a1208 100644 --- a/paths/branches/create.yaml +++ b/paths/branches/create.yaml @@ -49,7 +49,6 @@ x-code-samples: -X POST \ -d '{"name":"my-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/BranchCreate" requestBody: required: true content: diff --git a/paths/branches/create_comparison.yaml b/paths/branches/create_comparison.yaml index 6abc3782..e587be79 100644 --- a/paths/branches/create_comparison.yaml +++ b/paths/branches/create_comparison.yaml @@ -29,7 +29,6 @@ x-code-samples: -X POST \ -d '{"direction":"merge"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/BranchComparisonCreate" requestBody: required: true content: diff --git a/paths/branches/destroy.yaml b/paths/branches/destroy.yaml index 4c05f188..e4ec0352 100644 --- a/paths/branches/destroy.yaml +++ b/paths/branches/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/branches/:name" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/BranchDelete" x-cli-command: branches delete x-cli-version: '2.5' diff --git a/paths/branches/index.yaml b/paths/branches/index.yaml index be8f95d5..02e274ad 100644 --- a/paths/branches/index.yaml +++ b/paths/branches/index.yaml @@ -48,6 +48,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/branches" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/BranchesList" x-cli-command: branches list x-cli-version: '2.5' diff --git a/paths/branches/merge.yaml b/paths/branches/merge.yaml index 53c5c039..82b1b11b 100644 --- a/paths/branches/merge.yaml +++ b/paths/branches/merge.yaml @@ -51,7 +51,6 @@ x-code-samples: -X PATCH \ -d '{"strategy":"use_main"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/BranchMerge" requestBody: required: true content: diff --git a/paths/branches/show.yaml b/paths/branches/show.yaml index 05d03dcf..0ce4004e 100644 --- a/paths/branches/show.yaml +++ b/paths/branches/show.yaml @@ -41,6 +41,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/branches/:name" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/BranchShow" x-cli-command: branches show x-cli-version: '2.5' diff --git a/paths/branches/sync.yaml b/paths/branches/sync.yaml index b70dfc7e..e9611618 100644 --- a/paths/branches/sync.yaml +++ b/paths/branches/sync.yaml @@ -46,7 +46,6 @@ x-code-samples: -X PATCH \ -d '{"strategy":"use_main"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/BranchSync" requestBody: required: true content: diff --git a/paths/branches/update.yaml b/paths/branches/update.yaml index 6b3c9d50..6607674a 100644 --- a/paths/branches/update.yaml +++ b/paths/branches/update.yaml @@ -46,7 +46,6 @@ x-code-samples: -X PATCH \ -d '{"name":"my-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/BranchUpdate" requestBody: required: true content: diff --git a/paths/comment_reactions/create.yaml b/paths/comment_reactions/create.yaml index 4c18a0ed..afec1df5 100644 --- a/paths/comment_reactions/create.yaml +++ b/paths/comment_reactions/create.yaml @@ -51,6 +51,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch", "emoji": "👍"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReactionCreate" 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 09036ebf..42e5da00 100644 --- a/paths/comment_reactions/destroy.yaml +++ b/paths/comment_reactions/destroy.yaml @@ -35,6 +35,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReactionDelete" 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 3faa98d9..30a744b5 100644 --- a/paths/comment_reactions/index.yaml +++ b/paths/comment_reactions/index.yaml @@ -53,6 +53,5 @@ x-code-samples: -X GET \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReactionsList" 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 d7e3ea10..e48d2418 100644 --- a/paths/comment_reactions/show.yaml +++ b/paths/comment_reactions/show.yaml @@ -46,6 +46,5 @@ x-code-samples: -X GET \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReactionShow" 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 137a0386..2952d10b 100644 --- a/paths/comment_replies/create.yaml +++ b/paths/comment_replies/create.yaml @@ -57,6 +57,5 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch", "message":"Some message..."}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReplyCreate" 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 ce3046fb..68a2d08e 100644 --- a/paths/comment_replies/destroy.yaml +++ b/paths/comment_replies/destroy.yaml @@ -35,6 +35,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReplyDelete" 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 fe242d37..7efe0511 100644 --- a/paths/comment_replies/index.yaml +++ b/paths/comment_replies/index.yaml @@ -71,6 +71,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X GET \ -H 'Content-Type: application/json' - - "$ref": "../../examples/cli.yaml#/RepliesList" 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 cff7d2bc..cda032a7 100644 --- a/paths/comment_replies/mark_as_read.yaml +++ b/paths/comment_replies/mark_as_read.yaml @@ -35,6 +35,5 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReplyMarkAsRead" 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 b645a5f0..7697f653 100644 --- a/paths/comment_replies/mark_as_unread.yaml +++ b/paths/comment_replies/mark_as_unread.yaml @@ -35,6 +35,5 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReplyMarkAsUnread" 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 700a1bac..998f15d8 100644 --- a/paths/comment_replies/show.yaml +++ b/paths/comment_replies/show.yaml @@ -46,6 +46,5 @@ x-code-samples: -X GET \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReplyShow" 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 f0f8fdb6..26d96c49 100644 --- a/paths/comments/check_if_read.yaml +++ b/paths/comments/check_if_read.yaml @@ -34,6 +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 -- "$ref": "../../examples/cli.yaml#/CommentMarkCheck" x-cli-command: comments mark_check x-cli-version: '2.5' diff --git a/paths/comments/create.yaml b/paths/comments/create.yaml index 66e4d7ed..be4a0716 100644 --- a/paths/comments/create.yaml +++ b/paths/comments/create.yaml @@ -43,7 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch", "message":"Some message...", "locale_ids": ["someId"]}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/CommentCreate" requestBody: required: true content: diff --git a/paths/comments/destroy.yaml b/paths/comments/destroy.yaml index 5efda9c2..caff317f 100644 --- a/paths/comments/destroy.yaml +++ b/paths/comments/destroy.yaml @@ -39,6 +39,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/CommentDelete" x-cli-command: comments delete x-cli-version: '2.5' diff --git a/paths/comments/index.yaml b/paths/comments/index.yaml index 99f76640..d0c6ba61 100644 --- a/paths/comments/index.yaml +++ b/paths/comments/index.yaml @@ -89,6 +89,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X GET \ -H 'Content-Type: application/json' - - "$ref": "../../examples/cli.yaml#/CommentsList" 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 6d11952e..65a6558c 100644 --- a/paths/comments/mark_as_read.yaml +++ b/paths/comments/mark_as_read.yaml @@ -33,7 +33,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/CommentMarkRead" requestBody: required: true content: diff --git a/paths/comments/show.yaml b/paths/comments/show.yaml index 78401b51..9af23bf2 100644 --- a/paths/comments/show.yaml +++ b/paths/comments/show.yaml @@ -45,6 +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 -- "$ref": "../../examples/cli.yaml#/CommentShow" 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 f2d10a4e..a42ec859 100644 --- a/paths/comments/unmark_as_read.yaml +++ b/paths/comments/unmark_as_read.yaml @@ -39,6 +39,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/CommentMarkUnread" x-cli-command: comments mark_unread x-cli-version: '2.5' diff --git a/paths/comments/update.yaml b/paths/comments/update.yaml index 93327428..a80a1d42 100644 --- a/paths/comments/update.yaml +++ b/paths/comments/update.yaml @@ -44,7 +44,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","message":"Some message..."}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/CommentUpdate" requestBody: required: true content: diff --git a/paths/custom_metadata_properties/create.yaml b/paths/custom_metadata_properties/create.yaml index 5019c3a1..b28df3da 100644 --- a/paths/custom_metadata_properties/create.yaml +++ b/paths/custom_metadata_properties/create.yaml @@ -77,6 +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' -- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertyCreate" 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 9a5b9b6a..81a735ed 100644 --- a/paths/custom_metadata_properties/destroy.yaml +++ b/paths/custom_metadata_properties/destroy.yaml @@ -27,6 +27,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertiesDelete" 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 e5396cf9..959ec203 100644 --- a/paths/custom_metadata_properties/index.yaml +++ b/paths/custom_metadata_properties/index.yaml @@ -68,6 +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 -- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertiesList" 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 670efd44..c6addeb3 100644 --- a/paths/custom_metadata_properties/show.yaml +++ b/paths/custom_metadata_properties/show.yaml @@ -33,6 +33,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/custom_metadata/properties/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertyShow" 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 ada9931c..0e3017e5 100644 --- a/paths/custom_metadata_properties/update.yaml +++ b/paths/custom_metadata_properties/update.yaml @@ -70,6 +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' -- "$ref": "../../examples/cli.yaml#/CustomMetadataPropertyUpdate" x-cli-command: custom_metadata update x-cli-version: '2.9' diff --git a/paths/distributions/create.yaml b/paths/distributions/create.yaml index 5070bd19..1153316b 100644 --- a/paths/distributions/create.yaml +++ b/paths/distributions/create.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/DistributionCreate" requestBody: required: true content: diff --git a/paths/distributions/destroy.yaml b/paths/distributions/destroy.yaml index 85e7e5f0..1483a970 100644 --- a/paths/distributions/destroy.yaml +++ b/paths/distributions/destroy.yaml @@ -30,6 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/DistributionDelete" x-cli-command: distributions delete x-cli-version: '2.5' diff --git a/paths/distributions/index.yaml b/paths/distributions/index.yaml index 4b632ccc..9d46b74d 100644 --- a/paths/distributions/index.yaml +++ b/paths/distributions/index.yaml @@ -45,6 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/DistributionsList" x-cli-command: distributions list x-cli-version: '2.5' diff --git a/paths/distributions/show.yaml b/paths/distributions/show.yaml index 0a23437c..fed1d869 100644 --- a/paths/distributions/show.yaml +++ b/paths/distributions/show.yaml @@ -38,6 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/DistributionShow" x-cli-command: distributions show x-cli-version: '2.5' diff --git a/paths/distributions/update.yaml b/paths/distributions/update.yaml index b2e03586..9b34942a 100644 --- a/paths/distributions/update.yaml +++ b/paths/distributions/update.yaml @@ -43,7 +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' -- "$ref": "../../examples/cli.yaml#/DistributionUpdate" requestBody: required: true content: diff --git a/paths/documents/destroy.yaml b/paths/documents/destroy.yaml index fa2e8402..ee16d8c5 100644 --- a/paths/documents/destroy.yaml +++ b/paths/documents/destroy.yaml @@ -31,6 +31,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/DocumentDelete" x-cli-command: documents delete x-cli-version: '2.5' diff --git a/paths/documents/index.yaml b/paths/documents/index.yaml index f6a96475..ef58ca3f 100644 --- a/paths/documents/index.yaml +++ b/paths/documents/index.yaml @@ -52,6 +52,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/documents?project_id=asdf" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/DocumentsList" 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 655aee0d..ed72a30f 100644 --- a/paths/figma_attachment_keys/create.yaml +++ b/paths/figma_attachment_keys/create.yaml @@ -33,6 +33,5 @@ x-code-samples: -F branch=my-feature-branch \ -F id=key_id \ -H 'Content-Type: application/json' - - "$ref": "../../examples/cli.yaml#/FigmaAttachmentAttachToKey" 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 e986ca87..d7534c91 100644 --- a/paths/figma_attachment_keys/destroy.yaml +++ b/paths/figma_attachment_keys/destroy.yaml @@ -32,6 +32,5 @@ x-code-samples: -X DELETE \ -F branch=my-feature-branch \ -H 'Content-Type: application/json' - - "$ref": "../../examples/cli.yaml#/FigmaAttachmentDetachFromKey" 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 dfb06872..7645aeea 100644 --- a/paths/figma_attachments/create.yaml +++ b/paths/figma_attachments/create.yaml @@ -48,7 +48,6 @@ x-code-samples: -X POST \ -F branch=my-feature-branch \ -F url=https://figma.com/file/xxxxx/sample \ - - "$ref": "../../examples/cli.yaml#/FigmaAttachmentCreate" requestBody: required: true content: diff --git a/paths/figma_attachments/destroy.yaml b/paths/figma_attachments/destroy.yaml index 929bd57e..8abd8984 100644 --- a/paths/figma_attachments/destroy.yaml +++ b/paths/figma_attachments/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' - - "$ref": "../../examples/cli.yaml#/FigmaAttachmentDelete" 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 59a7f7f1..d2dff6cd 100644 --- a/paths/figma_attachments/index.yaml +++ b/paths/figma_attachments/index.yaml @@ -52,6 +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 - - "$ref": "../../examples/cli.yaml#/FigmaAttachmentsList" 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 754cdbf5..4c67f8fe 100644 --- a/paths/figma_attachments/show.yaml +++ b/paths/figma_attachments/show.yaml @@ -45,6 +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 - - "$ref": "../../examples/cli.yaml#/FigmaAttachmentShow" 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 164f28ed..dbea75b8 100644 --- a/paths/figma_attachments/update.yaml +++ b/paths/figma_attachments/update.yaml @@ -49,7 +49,6 @@ x-code-samples: -X PATCH \ -F branch=my-feature-branch \ -F url=https://figma.com/file/xxxxx/sample \ - - "$ref": "../../examples/cli.yaml#/FigmaAttachmentUpdate" requestBody: required: true content: diff --git a/paths/formats/index.yaml b/paths/formats/index.yaml index 2b651051..fb829edf 100644 --- a/paths/formats/index.yaml +++ b/paths/formats/index.yaml @@ -55,6 +55,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/formats" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/FormatsList" x-cli-command: formats list x-cli-version: '2.5' diff --git a/paths/glossaries/create.yaml b/paths/glossaries/create.yaml index 6574d868..6d2e2f3f 100644 --- a/paths/glossaries/create.yaml +++ b/paths/glossaries/create.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/GlossaryCreate" requestBody: required: true content: diff --git a/paths/glossaries/destroy.yaml b/paths/glossaries/destroy.yaml index 6e2c5ab1..6c3b1d18 100644 --- a/paths/glossaries/destroy.yaml +++ b/paths/glossaries/destroy.yaml @@ -30,6 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/GlossaryDelete" x-cli-command: glossaries delete x-cli-version: '2.5' diff --git a/paths/glossaries/index.yaml b/paths/glossaries/index.yaml index 1e2417cb..6c30c011 100644 --- a/paths/glossaries/index.yaml +++ b/paths/glossaries/index.yaml @@ -45,6 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/glossaries" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/GlossariesList" x-cli-command: glossaries list x-cli-version: '2.5' diff --git a/paths/glossaries/show.yaml b/paths/glossaries/show.yaml index 80251636..1f477c2e 100644 --- a/paths/glossaries/show.yaml +++ b/paths/glossaries/show.yaml @@ -38,6 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/GlossaryShow" x-cli-command: glossaries show x-cli-version: '2.5' diff --git a/paths/glossaries/update.yaml b/paths/glossaries/update.yaml index bf59de4d..3ad8c113 100644 --- a/paths/glossaries/update.yaml +++ b/paths/glossaries/update.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"name":"My glossary","project_ids":"abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235","space_ids":["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"]}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/GlossaryUpdate" requestBody: required: true content: diff --git a/paths/glossary_term_translations/create.yaml b/paths/glossary_term_translations/create.yaml index cdebb089..f8baf8c0 100644 --- a/paths/glossary_term_translations/create.yaml +++ b/paths/glossary_term_translations/create.yaml @@ -44,7 +44,6 @@ x-code-samples: -X POST \ -d '{"locale_code":"en-US","content":"My translated term"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/GlossaryTermTranslationCreate" requestBody: required: true content: diff --git a/paths/glossary_term_translations/destroy.yaml b/paths/glossary_term_translations/destroy.yaml index d22b0fcb..73440637 100644 --- a/paths/glossary_term_translations/destroy.yaml +++ b/paths/glossary_term_translations/destroy.yaml @@ -32,6 +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 -- "$ref": "../../examples/cli.yaml#/GlossaryTermTranslationDelete" 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 0ea5e711..ec17fd19 100644 --- a/paths/glossary_term_translations/update.yaml +++ b/paths/glossary_term_translations/update.yaml @@ -45,7 +45,6 @@ x-code-samples: -X PATCH \ -d '{"locale_code":"en-US","content":"My translated term"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/GlossaryTermTranslationUpdate" requestBody: required: true content: diff --git a/paths/glossary_terms/create.yaml b/paths/glossary_terms/create.yaml index ee77bfca..af1162df 100644 --- a/paths/glossary_terms/create.yaml +++ b/paths/glossary_terms/create.yaml @@ -43,7 +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' -- "$ref": "../../examples/cli.yaml#/GlossaryTermCreate" requestBody: required: true content: diff --git a/paths/glossary_terms/destroy.yaml b/paths/glossary_terms/destroy.yaml index e5217b85..30952a7d 100644 --- a/paths/glossary_terms/destroy.yaml +++ b/paths/glossary_terms/destroy.yaml @@ -31,6 +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 -- "$ref": "../../examples/cli.yaml#/GlossaryTermDelete" 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 fb196212..49aeac17 100644 --- a/paths/glossary_terms/index.yaml +++ b/paths/glossary_terms/index.yaml @@ -46,6 +46,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/glossaries/:glossary_id/terms" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/GlossaryTermsList" 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 f000926c..7409afad 100644 --- a/paths/glossary_terms/show.yaml +++ b/paths/glossary_terms/show.yaml @@ -39,6 +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 -- "$ref": "../../examples/cli.yaml#/GlossaryTermShow" 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 7c4ff563..ee98d83e 100644 --- a/paths/glossary_terms/update.yaml +++ b/paths/glossary_terms/update.yaml @@ -44,7 +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' -- "$ref": "../../examples/cli.yaml#/GlossaryTermUpdate" requestBody: required: true content: diff --git a/paths/icu/skeleton.yaml b/paths/icu/skeleton.yaml index 4331b7aa..c5cbff65 100644 --- a/paths/icu/skeleton.yaml +++ b/paths/icu/skeleton.yaml @@ -41,7 +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' -- "$ref": "../../examples/cli.yaml#/IcuSkeleton" requestBody: required: true content: diff --git a/paths/invitations/create.yaml b/paths/invitations/create.yaml index d856247f..9c7390ba 100644 --- a/paths/invitations/create.yaml +++ b/paths/invitations/create.yaml @@ -41,7 +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' -- "$ref": "../../examples/cli.yaml#/InvitationCreate" requestBody: required: true content: diff --git a/paths/invitations/destroy.yaml b/paths/invitations/destroy.yaml index c5893068..5a0c86fe 100644 --- a/paths/invitations/destroy.yaml +++ b/paths/invitations/destroy.yaml @@ -29,6 +29,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/invitations/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/InvitationDelete" x-cli-command: invitations delete x-cli-version: '2.5' diff --git a/paths/invitations/index.yaml b/paths/invitations/index.yaml index 3a1ee5d8..fd328d8c 100644 --- a/paths/invitations/index.yaml +++ b/paths/invitations/index.yaml @@ -44,6 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/invitations" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/InvitationsList" x-cli-command: invitations list x-cli-version: '2.5' diff --git a/paths/invitations/resend.yaml b/paths/invitations/resend.yaml index 6e30163a..ed468907 100644 --- a/paths/invitations/resend.yaml +++ b/paths/invitations/resend.yaml @@ -40,6 +40,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/invitations/:id/resend" \ -u USERNAME_OR_ACCESS_TOKEN \ -X POST -- "$ref": "../../examples/cli.yaml#/InvitationResend" x-cli-command: invitations resend x-cli-version: '2.5' diff --git a/paths/invitations/show.yaml b/paths/invitations/show.yaml index 79b4bbda..53cbf32c 100644 --- a/paths/invitations/show.yaml +++ b/paths/invitations/show.yaml @@ -37,6 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/invitations/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/InvitationShow" x-cli-command: invitations show x-cli-version: '2.5' diff --git a/paths/invitations/update.yaml b/paths/invitations/update.yaml index c788a818..bed0e2c4 100644 --- a/paths/invitations/update.yaml +++ b/paths/invitations/update.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/InvitationUpdate" requestBody: required: true content: diff --git a/paths/invitations/update_settings.yaml b/paths/invitations/update_settings.yaml index 398ca05e..48e4bfdd 100644 --- a/paths/invitations/update_settings.yaml +++ b/paths/invitations/update_settings.yaml @@ -42,7 +42,6 @@ x-code-samples: -X PATCH \ -d '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/InvitationUpdateSettings" requestBody: required: true content: diff --git a/paths/job_annotations/destroy.yaml b/paths/job_annotations/destroy.yaml index 6c4f2f4a..64474f63 100644 --- a/paths/job_annotations/destroy.yaml +++ b/paths/job_annotations/destroy.yaml @@ -37,6 +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 -- "$ref": "../../examples/cli.yaml#/JobAnnotationDelete" 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 85bf5562..b6b754ee 100644 --- a/paths/job_annotations/index.yaml +++ b/paths/job_annotations/index.yaml @@ -31,6 +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 -- "$ref": "../../examples/cli.yaml#/JobAnnotationsList" 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 3797486f..4f3dcd8b 100644 --- a/paths/job_annotations/update.yaml +++ b/paths/job_annotations/update.yaml @@ -42,7 +42,6 @@ x-code-samples: -X PATCH \ -d '{"value":"Some value..."}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobAnnotationUpdate" requestBody: required: true content: diff --git a/paths/job_comments/create.yaml b/paths/job_comments/create.yaml index 44515f65..866938e3 100644 --- a/paths/job_comments/create.yaml +++ b/paths/job_comments/create.yaml @@ -36,7 +36,6 @@ x-code-samples: -X POST \ -d '{"message":"Some message..."}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobCommentCreate" requestBody: required: true content: diff --git a/paths/job_comments/destroy.yaml b/paths/job_comments/destroy.yaml index 06588135..447d7036 100644 --- a/paths/job_comments/destroy.yaml +++ b/paths/job_comments/destroy.yaml @@ -27,6 +27,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobCommentDelete" 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 d2ef9683..e2d92c65 100644 --- a/paths/job_comments/index.yaml +++ b/paths/job_comments/index.yaml @@ -46,6 +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 -- "$ref": "../../examples/cli.yaml#/JobCommentsList" 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 f59aaae9..b45108d6 100644 --- a/paths/job_comments/show.yaml +++ b/paths/job_comments/show.yaml @@ -35,6 +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 -- "$ref": "../../examples/cli.yaml#/JobCommentShow" 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 9470b22f..d9311f43 100644 --- a/paths/job_comments/update.yaml +++ b/paths/job_comments/update.yaml @@ -37,7 +37,6 @@ x-code-samples: -X PATCH \ -d '{"message":"Some message..."}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobCommentUpdate" requestBody: required: true content: diff --git a/paths/job_locale_annotations/destroy.yaml b/paths/job_locale_annotations/destroy.yaml index a41d80cc..ce59d5dd 100644 --- a/paths/job_locale_annotations/destroy.yaml +++ b/paths/job_locale_annotations/destroy.yaml @@ -38,6 +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 -- "$ref": "../../examples/cli.yaml#/JobLocaleAnnotationDelete" 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 3f6afdcb..233b12ed 100644 --- a/paths/job_locale_annotations/index.yaml +++ b/paths/job_locale_annotations/index.yaml @@ -32,6 +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 -- "$ref": "../../examples/cli.yaml#/JobLocaleAnnotationsList" 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 28822dfa..9cf62293 100644 --- a/paths/job_locale_annotations/update.yaml +++ b/paths/job_locale_annotations/update.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"value":"Some value..."}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobLocaleAnnotationUpdate" requestBody: required: true content: diff --git a/paths/job_locales/complete.yaml b/paths/job_locales/complete.yaml index 7a39934b..0bf4e45c 100644 --- a/paths/job_locales/complete.yaml +++ b/paths/job_locales/complete.yaml @@ -37,7 +37,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobLocaleComplete" requestBody: required: true content: diff --git a/paths/job_locales/complete_review.yaml b/paths/job_locales/complete_review.yaml index 78eb5e3c..335d2e81 100644 --- a/paths/job_locales/complete_review.yaml +++ b/paths/job_locales/complete_review.yaml @@ -37,7 +37,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobLocaleCompleteReview" requestBody: required: true content: diff --git a/paths/job_locales/create.yaml b/paths/job_locales/create.yaml index 4d79a0d1..d59d0f1f 100644 --- a/paths/job_locales/create.yaml +++ b/paths/job_locales/create.yaml @@ -36,7 +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' -- "$ref": "../../examples/cli.yaml#/JobLocalesCreate" requestBody: required: true content: diff --git a/paths/job_locales/destroy.yaml b/paths/job_locales/destroy.yaml index 5b6c319c..dcf83310 100644 --- a/paths/job_locales/destroy.yaml +++ b/paths/job_locales/destroy.yaml @@ -27,6 +27,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobLocaleDelete" 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 105cdfc5..7f791668 100644 --- a/paths/job_locales/index.yaml +++ b/paths/job_locales/index.yaml @@ -43,6 +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 -- "$ref": "../../examples/cli.yaml#/JobLocalesList" 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 d6f62cb4..f0cdcfc4 100644 --- a/paths/job_locales/reopen.yaml +++ b/paths/job_locales/reopen.yaml @@ -37,7 +37,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobLocaleReopen" requestBody: required: true content: diff --git a/paths/job_locales/show.yaml b/paths/job_locales/show.yaml index f68e4cb4..54f64f1c 100644 --- a/paths/job_locales/show.yaml +++ b/paths/job_locales/show.yaml @@ -36,6 +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 -- "$ref": "../../examples/cli.yaml#/JobLocaleShow" 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 2708b1ed..5abf765b 100644 --- a/paths/job_locales/update.yaml +++ b/paths/job_locales/update.yaml @@ -37,7 +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' -- "$ref": "../../examples/cli.yaml#/JobLocaleUpdate" requestBody: required: true content: diff --git a/paths/job_template_locales/create.yaml b/paths/job_template_locales/create.yaml index 02fc0f42..3cf8559c 100644 --- a/paths/job_template_locales/create.yaml +++ b/paths/job_template_locales/create.yaml @@ -36,7 +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' -- "$ref": "../../examples/cli.yaml#/JobTemplateLocalesCreate" requestBody: required: true content: diff --git a/paths/job_template_locales/destroy.yaml b/paths/job_template_locales/destroy.yaml index 7f21dda9..1a4d66a1 100644 --- a/paths/job_template_locales/destroy.yaml +++ b/paths/job_template_locales/destroy.yaml @@ -32,6 +32,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobTemplateLocaleDelete" 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 dda1a873..6c19d328 100644 --- a/paths/job_template_locales/index.yaml +++ b/paths/job_template_locales/index.yaml @@ -47,6 +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 -- "$ref": "../../examples/cli.yaml#/JobTemplateLocalesList" 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 9a419b5b..94c50ea8 100644 --- a/paths/job_template_locales/show.yaml +++ b/paths/job_template_locales/show.yaml @@ -40,6 +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 -- "$ref": "../../examples/cli.yaml#/JobTemplateLocaleShow" 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 4b75f92f..bdfa0b0c 100644 --- a/paths/job_template_locales/update.yaml +++ b/paths/job_template_locales/update.yaml @@ -37,7 +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' -- "$ref": "../../examples/cli.yaml#/JobTemplateLocaleUpdate" requestBody: required: true content: diff --git a/paths/job_templates/create.yaml b/paths/job_templates/create.yaml index 62561bcb..981ed08d 100644 --- a/paths/job_templates/create.yaml +++ b/paths/job_templates/create.yaml @@ -42,7 +42,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","name":"template","briefing":"text"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobTemplateCreate" requestBody: required: true content: diff --git a/paths/job_templates/destroy.yaml b/paths/job_templates/destroy.yaml index f991b896..3f97b8e9 100644 --- a/paths/job_templates/destroy.yaml +++ b/paths/job_templates/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobTemplateDelete" 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 c7317402..eb8516e7 100644 --- a/paths/job_templates/index.yaml +++ b/paths/job_templates/index.yaml @@ -51,6 +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 - - "$ref": "../../examples/cli.yaml#/JobTemplatesList" 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 fdff761d..14e2bfc9 100644 --- a/paths/job_templates/show.yaml +++ b/paths/job_templates/show.yaml @@ -44,6 +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 - - "$ref": "../../examples/cli.yaml#/JobTemplatesShow" 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 0cf1a889..20b19a7e 100644 --- a/paths/job_templates/update.yaml +++ b/paths/job_templates/update.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","name":"template","briefing":"text"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobTemplateUpdate" requestBody: required: true content: diff --git a/paths/jobs/add_keys.yaml b/paths/jobs/add_keys.yaml index 08d82620..8f07d15e 100644 --- a/paths/jobs/add_keys.yaml +++ b/paths/jobs/add_keys.yaml @@ -36,7 +36,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","translation_key_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobKeysCreate" requestBody: required: true content: diff --git a/paths/jobs/complete.yaml b/paths/jobs/complete.yaml index 4f4e26c6..504f0049 100644 --- a/paths/jobs/complete.yaml +++ b/paths/jobs/complete.yaml @@ -43,7 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobComplete" requestBody: required: true content: diff --git a/paths/jobs/create.yaml b/paths/jobs/create.yaml index 5d99e924..4801ead9 100644 --- a/paths/jobs/create.yaml +++ b/paths/jobs/create.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/JobCreate" requestBody: required: true content: diff --git a/paths/jobs/destroy.yaml b/paths/jobs/destroy.yaml index 9a4d2162..1ac23a52 100644 --- a/paths/jobs/destroy.yaml +++ b/paths/jobs/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobDelete" x-cli-command: jobs delete x-cli-version: '2.5' diff --git a/paths/jobs/index.yaml b/paths/jobs/index.yaml index 9210f30f..90be47eb 100644 --- a/paths/jobs/index.yaml +++ b/paths/jobs/index.yaml @@ -68,6 +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 -- "$ref": "../../examples/cli.yaml#/JobsList" 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 45c66a68..a932375f 100644 --- a/paths/jobs/index_account.yaml +++ b/paths/jobs/index_account.yaml @@ -49,6 +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 -- "$ref": "../../examples/cli.yaml#/JobsByAccount" x-cli-command: jobs by_account x-cli-version: '2.5' diff --git a/paths/jobs/lock.yaml b/paths/jobs/lock.yaml index 9184c86e..9de2751c 100644 --- a/paths/jobs/lock.yaml +++ b/paths/jobs/lock.yaml @@ -49,6 +49,5 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobLock" 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 4bfafa61..75aea2ad 100644 --- a/paths/jobs/remove_keys.yaml +++ b/paths/jobs/remove_keys.yaml @@ -25,7 +25,6 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch","translation_key_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobKeysDelete" requestBody: required: true content: diff --git a/paths/jobs/reopen.yaml b/paths/jobs/reopen.yaml index 157457dd..4e5445e6 100644 --- a/paths/jobs/reopen.yaml +++ b/paths/jobs/reopen.yaml @@ -43,7 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobReopen" requestBody: required: true content: diff --git a/paths/jobs/show.yaml b/paths/jobs/show.yaml index 2a641e34..1c2d36dd 100644 --- a/paths/jobs/show.yaml +++ b/paths/jobs/show.yaml @@ -41,6 +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 -- "$ref": "../../examples/cli.yaml#/JobShow" x-cli-command: jobs show x-cli-version: '2.5' diff --git a/paths/jobs/start.yaml b/paths/jobs/start.yaml index 43caa08a..f5abd8f0 100644 --- a/paths/jobs/start.yaml +++ b/paths/jobs/start.yaml @@ -43,7 +43,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobStart" requestBody: required: true content: diff --git a/paths/jobs/unlock.yaml b/paths/jobs/unlock.yaml index 30a5eb80..0cbd37c9 100644 --- a/paths/jobs/unlock.yaml +++ b/paths/jobs/unlock.yaml @@ -49,6 +49,5 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch"' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/JobUnlock" x-cli-command: jobs unlock x-cli-version: '2.5' diff --git a/paths/jobs/update.yaml b/paths/jobs/update.yaml index d1b45b3e..d7203317 100644 --- a/paths/jobs/update.yaml +++ b/paths/jobs/update.yaml @@ -43,7 +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' -- "$ref": "../../examples/cli.yaml#/JobUpdate" requestBody: required: true content: diff --git a/paths/keys/create.yaml b/paths/keys/create.yaml index 40d36260..888b7f00 100644 --- a/paths/keys/create.yaml +++ b/paths/keys/create.yaml @@ -49,7 +49,6 @@ x-code-samples: -F max_characters_allowed=140 \ -F screenshot=@/path/to/my/screenshot.png \ -F custom_metadata[property]=value -- "$ref": "../../examples/cli.yaml#/KeyCreate" requestBody: required: true content: diff --git a/paths/keys/destroy-collection.yaml b/paths/keys/destroy-collection.yaml index 0db920f5..a9000496 100644 --- a/paths/keys/destroy-collection.yaml +++ b/paths/keys/destroy-collection.yaml @@ -53,6 +53,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch","q":"mykey* translated:true","locale_id":"abcd1234abcd1234abcd1234abcd1234"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/KeysDeleteCollection" x-cli-command: keys delete-collection x-cli-version: '2.5' diff --git a/paths/keys/destroy.yaml b/paths/keys/destroy.yaml index 8382369a..c2e742ad 100644 --- a/paths/keys/destroy.yaml +++ b/paths/keys/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/KeyDelete" x-cli-command: keys delete x-cli-version: '2.5' diff --git a/paths/keys/exclude.yaml b/paths/keys/exclude.yaml index 51f60d7e..e20d2c64 100644 --- a/paths/keys/exclude.yaml +++ b/paths/keys/exclude.yaml @@ -40,7 +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' -- "$ref": "../../examples/cli.yaml#/KeysExclude" requestBody: required: true content: diff --git a/paths/keys/include.yaml b/paths/keys/include.yaml index 12e492e7..b83a1fde 100644 --- a/paths/keys/include.yaml +++ b/paths/keys/include.yaml @@ -40,7 +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' -- "$ref": "../../examples/cli.yaml#/KeysInclude" requestBody: required: true content: diff --git a/paths/keys/index.yaml b/paths/keys/index.yaml index 19ddf3b4..4404600d 100644 --- a/paths/keys/index.yaml +++ b/paths/keys/index.yaml @@ -70,6 +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 -- "$ref": "../../examples/cli.yaml#/KeysList" x-cli-command: keys list x-cli-version: '2.5' diff --git a/paths/keys/search.yaml b/paths/keys/search.yaml index 4386f768..388c473e 100644 --- a/paths/keys/search.yaml +++ b/paths/keys/search.yaml @@ -46,7 +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' -- "$ref": "../../examples/cli.yaml#/KeysSearch" requestBody: required: true content: diff --git a/paths/keys/show.yaml b/paths/keys/show.yaml index 70d43809..16a6ef58 100644 --- a/paths/keys/show.yaml +++ b/paths/keys/show.yaml @@ -44,6 +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 -- "$ref": "../../examples/cli.yaml#/KeyShow" x-cli-command: keys show x-cli-version: '2.5' diff --git a/paths/keys/tag.yaml b/paths/keys/tag.yaml index 73e72313..7b209a22 100644 --- a/paths/keys/tag.yaml +++ b/paths/keys/tag.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/KeysTag" requestBody: required: true content: diff --git a/paths/keys/untag.yaml b/paths/keys/untag.yaml index d5cc78cd..96b38021 100644 --- a/paths/keys/untag.yaml +++ b/paths/keys/untag.yaml @@ -40,7 +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' -- "$ref": "../../examples/cli.yaml#/KeysUntag" requestBody: required: true content: diff --git a/paths/keys/update.yaml b/paths/keys/update.yaml index 7782075a..7a232bf5 100644 --- a/paths/keys/update.yaml +++ b/paths/keys/update.yaml @@ -50,7 +50,6 @@ x-code-samples: -F max_characters_allowed=140 \ -F screenshot=@/path/to/my/screenshot.png \ -F custom_metadata[property]=value -- "$ref": "../../examples/cli.yaml#/KeyUpdate" requestBody: required: true content: diff --git a/paths/locale_downloads/create.yaml b/paths/locale_downloads/create.yaml index d25ee5d6..55dc74ed 100644 --- a/paths/locale_downloads/create.yaml +++ b/paths/locale_downloads/create.yaml @@ -154,6 +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' - - "$ref": "../../examples/cli.yaml#/LocaleDownloadCreate" 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 c7e560c7..c1d98851 100644 --- a/paths/locale_downloads/show.yaml +++ b/paths/locale_downloads/show.yaml @@ -44,6 +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 - - "$ref": "../../examples/cli.yaml#/LocaleDownloadShow" 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 ae96edbc..45559519 100644 --- a/paths/locales/create.yaml +++ b/paths/locales/create.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/LocaleCreate" requestBody: required: true content: diff --git a/paths/locales/destroy.yaml b/paths/locales/destroy.yaml index 12f15895..76a99c1a 100644 --- a/paths/locales/destroy.yaml +++ b/paths/locales/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/LocaleDelete" x-cli-command: locales delete x-cli-version: '2.5' diff --git a/paths/locales/download.yaml b/paths/locales/download.yaml index cb93b7ad..1eddbb8f 100644 --- a/paths/locales/download.yaml +++ b/paths/locales/download.yaml @@ -198,6 +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 - - "$ref": "../../examples/cli.yaml#/LocaleDownload" x-cli-command: locales download x-cli-version: "2.6.4" diff --git a/paths/locales/index.yaml b/paths/locales/index.yaml index 22119bfe..0e591c03 100644 --- a/paths/locales/index.yaml +++ b/paths/locales/index.yaml @@ -63,6 +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 -- "$ref": "../../examples/cli.yaml#/LocalesList" x-cli-command: locales list x-cli-version: '2.5' diff --git a/paths/locales/show.yaml b/paths/locales/show.yaml index 4d6b3c29..d8218819 100644 --- a/paths/locales/show.yaml +++ b/paths/locales/show.yaml @@ -44,6 +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 -- "$ref": "../../examples/cli.yaml#/LocaleShow" x-cli-command: locales show x-cli-version: '2.5' diff --git a/paths/locales/update.yaml b/paths/locales/update.yaml index 4a6cb513..3b153533 100644 --- a/paths/locales/update.yaml +++ b/paths/locales/update.yaml @@ -43,7 +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' -- "$ref": "../../examples/cli.yaml#/LocaleUpdate" requestBody: required: true content: diff --git a/paths/members/destroy.yaml b/paths/members/destroy.yaml index bfd33864..6dd352be 100644 --- a/paths/members/destroy.yaml +++ b/paths/members/destroy.yaml @@ -29,6 +29,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/members/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/MemberDelete" x-cli-command: members delete x-cli-version: '2.5' diff --git a/paths/members/index.yaml b/paths/members/index.yaml index 60d4cf29..fec43cc6 100644 --- a/paths/members/index.yaml +++ b/paths/members/index.yaml @@ -44,6 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/members" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/MembersList" x-cli-command: members list x-cli-version: '2.5' diff --git a/paths/members/show.yaml b/paths/members/show.yaml index 2aa391bc..252dc63f 100644 --- a/paths/members/show.yaml +++ b/paths/members/show.yaml @@ -37,6 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/members/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/MemberShow" x-cli-command: members show x-cli-version: '2.5' diff --git a/paths/members/update.yaml b/paths/members/update.yaml index 3f70f47b..ab0de64f 100644 --- a/paths/members/update.yaml +++ b/paths/members/update.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/MemberUpdate" requestBody: required: true content: diff --git a/paths/members/update_settings.yaml b/paths/members/update_settings.yaml index e66a9b6a..f5657464 100644 --- a/paths/members/update_settings.yaml +++ b/paths/members/update_settings.yaml @@ -42,7 +42,6 @@ x-code-samples: -X PATCH \ -d '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/MemberUpdateSettings" requestBody: required: true content: diff --git a/paths/notification_groups/index.yaml b/paths/notification_groups/index.yaml index 03f1c9a1..f5f2b22c 100644 --- a/paths/notification_groups/index.yaml +++ b/paths/notification_groups/index.yaml @@ -44,6 +44,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/notification_groups" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/NotificationGroupsList" 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 cfaf5e8a..28603294 100644 --- a/paths/notification_groups/mark_all_as_read.yaml +++ b/paths/notification_groups/mark_all_as_read.yaml @@ -40,6 +40,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X PATCH \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/NotificationGroupsMarkAllAsRead" 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 578257f6..ae4ce58e 100644 --- a/paths/notification_groups/mark_as_read.yaml +++ b/paths/notification_groups/mark_as_read.yaml @@ -39,6 +39,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X PATCH \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/NotificationGroupsMarkAsRead" 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 9b7f9407..bd6ff283 100644 --- a/paths/notifications/index.yaml +++ b/paths/notifications/index.yaml @@ -57,6 +57,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/notifications" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/NotificationsList" 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 7506c4b6..9a622261 100644 --- a/paths/notifications/mark_all_as_read.yaml +++ b/paths/notifications/mark_all_as_read.yaml @@ -40,6 +40,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/NotificationsMarkAllAsRead" 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 9e3f2dfb..4b7c7676 100644 --- a/paths/notifications/show.yaml +++ b/paths/notifications/show.yaml @@ -36,6 +36,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/notification/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/NotificationsShow" x-cli-command: notifications show x-cli-version: '2.5' diff --git a/paths/orders/confirm.yaml b/paths/orders/confirm.yaml index 4960b26f..c5cdc5f4 100644 --- a/paths/orders/confirm.yaml +++ b/paths/orders/confirm.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/OrderConfirm" requestBody: required: true content: diff --git a/paths/orders/create.yaml b/paths/orders/create.yaml index e0d77d30..5d148563 100644 --- a/paths/orders/create.yaml +++ b/paths/orders/create.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/OrderCreate" requestBody: required: true content: diff --git a/paths/orders/destroy.yaml b/paths/orders/destroy.yaml index 52019012..e497eca1 100644 --- a/paths/orders/destroy.yaml +++ b/paths/orders/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/OrderDelete" x-cli-command: orders delete x-cli-version: '2.5' diff --git a/paths/orders/index.yaml b/paths/orders/index.yaml index 5d68d5fb..794d0194 100644 --- a/paths/orders/index.yaml +++ b/paths/orders/index.yaml @@ -58,6 +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 -- "$ref": "../../examples/cli.yaml#/OrdersList" x-cli-command: orders list x-cli-version: '2.5' diff --git a/paths/orders/show.yaml b/paths/orders/show.yaml index a4750f7c..2a0fd742 100644 --- a/paths/orders/show.yaml +++ b/paths/orders/show.yaml @@ -44,6 +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 -- "$ref": "../../examples/cli.yaml#/OrderShow" 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 4079c532..806e7a5a 100644 --- a/paths/organization_job_template_locales/create.yaml +++ b/paths/organization_job_template_locales/create.yaml @@ -36,7 +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' -- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocalesCreate" requestBody: required: true content: diff --git a/paths/organization_job_template_locales/destroy.yaml b/paths/organization_job_template_locales/destroy.yaml index 3d0db729..46ab87a0 100644 --- a/paths/organization_job_template_locales/destroy.yaml +++ b/paths/organization_job_template_locales/destroy.yaml @@ -25,6 +25,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocaleDelete" 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 7262cd89..eb22d4db 100644 --- a/paths/organization_job_template_locales/index.yaml +++ b/paths/organization_job_template_locales/index.yaml @@ -41,6 +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 -- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocalesList" 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 0bb8d91e..45ed927e 100644 --- a/paths/organization_job_template_locales/show.yaml +++ b/paths/organization_job_template_locales/show.yaml @@ -34,6 +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 -- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocaleShow" 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 a94808ef..40cd1dae 100644 --- a/paths/organization_job_template_locales/update.yaml +++ b/paths/organization_job_template_locales/update.yaml @@ -37,7 +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' -- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateLocaleUpdate" requestBody: required: true content: diff --git a/paths/organization_job_templates/create.yaml b/paths/organization_job_templates/create.yaml index df7e9980..d4539620 100644 --- a/paths/organization_job_templates/create.yaml +++ b/paths/organization_job_templates/create.yaml @@ -42,7 +42,6 @@ x-code-samples: -X POST \ -d '{"name":"template","briefing":"text"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateCreate" requestBody: required: true content: diff --git a/paths/organization_job_templates/destroy.yaml b/paths/organization_job_templates/destroy.yaml index 7997a534..0495090a 100644 --- a/paths/organization_job_templates/destroy.yaml +++ b/paths/organization_job_templates/destroy.yaml @@ -31,6 +31,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateDelete" 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 648b9242..e6cba999 100644 --- a/paths/organization_job_templates/index.yaml +++ b/paths/organization_job_templates/index.yaml @@ -45,6 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/job_templates" \ -u USERNAME_OR_ACCESS_TOKEN - - "$ref": "../../examples/cli.yaml#/OrganizationJobTemplatesList" 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 c0623545..9e414f5a 100644 --- a/paths/organization_job_templates/show.yaml +++ b/paths/organization_job_templates/show.yaml @@ -38,6 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/job_templates/:id" \ -u USERNAME_OR_ACCESS_TOKEN - - "$ref": "../../examples/cli.yaml#/OrganizationJobTemplatesShow" 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 4b6d3d60..269461fd 100644 --- a/paths/organization_job_templates/update.yaml +++ b/paths/organization_job_templates/update.yaml @@ -42,7 +42,6 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X PATCH \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/OrganizationJobTemplateUpdate" requestBody: required: true content: diff --git a/paths/projects/create.yaml b/paths/projects/create.yaml index 5b1054ce..69b97b6b 100644 --- a/paths/projects/create.yaml +++ b/paths/projects/create.yaml @@ -47,7 +47,6 @@ x-code-samples: -F name=My%20Android%20Project \ -F main_format=yml \ -F shares_translation_memory=true - - "$ref": "../../examples/cli.yaml#/ProjectCreate" requestBody: required: true content: diff --git a/paths/projects/destroy.yaml b/paths/projects/destroy.yaml index 788eaa5d..34379813 100644 --- a/paths/projects/destroy.yaml +++ b/paths/projects/destroy.yaml @@ -30,6 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/ProjectDelete" x-cli-command: projects delete x-cli-version: '2.5' diff --git a/paths/projects/index.yaml b/paths/projects/index.yaml index c4377046..d5589d01 100644 --- a/paths/projects/index.yaml +++ b/paths/projects/index.yaml @@ -79,6 +79,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/ProjectsList" x-cli-command: projects list x-cli-version: '2.5' diff --git a/paths/projects/show.yaml b/paths/projects/show.yaml index 7c560474..8f28d569 100644 --- a/paths/projects/show.yaml +++ b/paths/projects/show.yaml @@ -37,6 +37,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/ProjectShow" x-cli-command: projects show x-cli-version: '2.5' diff --git a/paths/projects/update.yaml b/paths/projects/update.yaml index b0436bfd..2ac2971f 100644 --- a/paths/projects/update.yaml +++ b/paths/projects/update.yaml @@ -43,7 +43,6 @@ x-code-samples: -F name=My%20Android%20Project \ -F main_format=yml \ -F shares_translation_memory=true - - "$ref": "../../examples/cli.yaml#/ProjectUpdate" requestBody: required: true content: diff --git a/paths/quality_performance_score/index.yaml b/paths/quality_performance_score/index.yaml index 07cafbe3..b659d1a7 100644 --- a/paths/quality_performance_score/index.yaml +++ b/paths/quality_performance_score/index.yaml @@ -41,7 +41,6 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -d '{"translation_ids":["translation_id_1", "translation_id_2"]}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/QualityPerformanceScoreList" requestBody: required: true content: diff --git a/paths/release_triggers/create.yaml b/paths/release_triggers/create.yaml index bfcc0648..4348b9eb 100644 --- a/paths/release_triggers/create.yaml +++ b/paths/release_triggers/create.yaml @@ -81,6 +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' - - "$ref": "../../examples/cli.yaml#/ReleaseTriggersCreate" 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 d80ea093..2e17f578 100644 --- a/paths/release_triggers/destroy.yaml +++ b/paths/release_triggers/destroy.yaml @@ -24,6 +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 -- "$ref": "../../examples/cli.yaml#/ReleaseTriggersDestroy" 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 76cf4efa..f04592cd 100644 --- a/paths/release_triggers/index.yaml +++ b/paths/release_triggers/index.yaml @@ -38,6 +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 -- "$ref": "../../examples/cli.yaml#/ReleaseTriggersList" 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 baf78bf3..30f4ed67 100644 --- a/paths/release_triggers/show.yaml +++ b/paths/release_triggers/show.yaml @@ -34,6 +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 -- "$ref": "../../examples/cli.yaml#/ReleaseTriggersShow" 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 7c2ee5e9..8d7877e9 100644 --- a/paths/release_triggers/update.yaml +++ b/paths/release_triggers/update.yaml @@ -81,6 +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' - - "$ref": "../../examples/cli.yaml#/ReleaseTriggersUpdate" x-cli-command: release_triggers update x-cli-version: "2.28" diff --git a/paths/releases/create.yaml b/paths/releases/create.yaml index 2fa9ef47..5aea334c 100644 --- a/paths/releases/create.yaml +++ b/paths/releases/create.yaml @@ -43,7 +43,6 @@ x-code-samples: -X POST \ -d '{"description":"My first Release","platforms":["android","ios"],"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' - - "$ref": "../../examples/cli.yaml#/ReleaseCreate" requestBody: required: true content: diff --git a/paths/releases/destroy.yaml b/paths/releases/destroy.yaml index fc2bb57a..5353f059 100644 --- a/paths/releases/destroy.yaml +++ b/paths/releases/destroy.yaml @@ -31,6 +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 -- "$ref": "../../examples/cli.yaml#/ReleaseDelete" x-cli-command: releases delete x-cli-version: '2.5' diff --git a/paths/releases/index.yaml b/paths/releases/index.yaml index 9f8b02ac..ba72e3a6 100644 --- a/paths/releases/index.yaml +++ b/paths/releases/index.yaml @@ -46,6 +46,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:distribution_id/releases" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/ReleasesList" x-cli-command: releases list x-cli-version: '2.5' diff --git a/paths/releases/publish.yaml b/paths/releases/publish.yaml index 201871ca..14bc3ad2 100644 --- a/paths/releases/publish.yaml +++ b/paths/releases/publish.yaml @@ -42,6 +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 -- "$ref": "../../examples/cli.yaml#/ReleasePublish" x-cli-command: releases publish x-cli-version: '2.5' diff --git a/paths/releases/show.yaml b/paths/releases/show.yaml index e66a1de4..fccd0ecf 100644 --- a/paths/releases/show.yaml +++ b/paths/releases/show.yaml @@ -39,6 +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 -- "$ref": "../../examples/cli.yaml#/ReleaseShow" x-cli-command: releases show x-cli-version: '2.5' diff --git a/paths/releases/update.yaml b/paths/releases/update.yaml index 36cc001a..ad4780ab 100644 --- a/paths/releases/update.yaml +++ b/paths/releases/update.yaml @@ -44,7 +44,6 @@ x-code-samples: -X PATCH \ -d '{"description":"My first Release","platforms":["android","ios"],"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ReleaseUpdate" requestBody: required: true content: diff --git a/paths/repo_sync_events/index.yaml b/paths/repo_sync_events/index.yaml index 31e58c0e..996aba41 100644 --- a/paths/repo_sync_events/index.yaml +++ b/paths/repo_sync_events/index.yaml @@ -40,6 +40,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs/56ef78/events"\ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/RepoSyncEventList" 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 5d975141..8d41eb08 100644 --- a/paths/repo_sync_events/show.yaml +++ b/paths/repo_sync_events/show.yaml @@ -34,6 +34,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs/56ef78/events/78dfgj"\ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/RepoSyncEventShow" 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 80c11c41..5319cc24 100644 --- a/paths/repo_syncs/activate.yaml +++ b/paths/repo_syncs/activate.yaml @@ -44,6 +44,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/RepoSyncActivate" 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 22d56346..16a6d0fd 100644 --- a/paths/repo_syncs/create.yaml +++ b/paths/repo_syncs/create.yaml @@ -49,7 +49,6 @@ x-code-samples: "repo_name": "my-org/my-repo", "base_branch": "main" }' -- "$ref": "../../examples/cli.yaml#/RepoSyncCreate" requestBody: required: true content: diff --git a/paths/repo_syncs/deactivate.yaml b/paths/repo_syncs/deactivate.yaml index 2b35e5e3..1b4d7d95 100644 --- a/paths/repo_syncs/deactivate.yaml +++ b/paths/repo_syncs/deactivate.yaml @@ -44,6 +44,5 @@ x-code-samples: -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/RepoSyncDeactivate" 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 1406bce8..2c0eb79b 100644 --- a/paths/repo_syncs/export.yaml +++ b/paths/repo_syncs/export.yaml @@ -63,5 +63,4 @@ x-code-samples: -X POST \ -H 'Content-Type: application/json' \ -d '{"pr_branch":"my-feature-branch", "branch":"my-strings-branch"}' -- "$ref": "../../examples/cli.yaml#/RepoSyncExport" x-cli-command: repo_syncs export diff --git a/paths/repo_syncs/import.yaml b/paths/repo_syncs/import.yaml index 7f3e3539..668610b8 100644 --- a/paths/repo_syncs/import.yaml +++ b/paths/repo_syncs/import.yaml @@ -63,5 +63,4 @@ x-code-samples: -X POST \ -d '{"repository_branch":"my-feature-branch", "branch":"my-strings-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/RepoSyncImport" x-cli-command: repo_syncs import diff --git a/paths/repo_syncs/index.yaml b/paths/repo_syncs/index.yaml index 7193e216..cfa576ca 100644 --- a/paths/repo_syncs/index.yaml +++ b/paths/repo_syncs/index.yaml @@ -43,6 +43,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs"\ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/RepoSyncList" 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 ade68450..164abe84 100644 --- a/paths/repo_syncs/show.yaml +++ b/paths/repo_syncs/show.yaml @@ -38,6 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/ab12cd34/repo_syncs/56ef78"\ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/RepoSyncShow" 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 242a43ec..e0387a79 100644 --- a/paths/reports/locales/index.yaml +++ b/paths/reports/locales/index.yaml @@ -52,6 +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 - - "$ref": "../../../examples/cli.yaml#/ReportLocalesList" x-cli-command: reports locales_list x-cli-version: "2.13" diff --git a/paths/reports/show.yaml b/paths/reports/show.yaml index 1c99556e..b7ec54fb 100644 --- a/paths/reports/show.yaml +++ b/paths/reports/show.yaml @@ -46,6 +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 - - "$ref": "../../examples/cli.yaml#/ReportShow" 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 3d488553..10d2cfe5 100644 --- a/paths/screenshot_markers/create.yaml +++ b/paths/screenshot_markers/create.yaml @@ -43,7 +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' -- "$ref": "../../examples/cli.yaml#/ScreenshotMarkerCreate" requestBody: required: true content: diff --git a/paths/screenshot_markers/destroy.yaml b/paths/screenshot_markers/destroy.yaml index 5a660036..455d8a7e 100644 --- a/paths/screenshot_markers/destroy.yaml +++ b/paths/screenshot_markers/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ScreenshotMarkerDelete" 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 0640ad00..b37a4331 100644 --- a/paths/screenshot_markers/index.yaml +++ b/paths/screenshot_markers/index.yaml @@ -52,6 +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 -- "$ref": "../../examples/cli.yaml#/ScreenshotMarkersList" 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 235d802a..7306f068 100644 --- a/paths/screenshot_markers/show.yaml +++ b/paths/screenshot_markers/show.yaml @@ -45,6 +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 -- "$ref": "../../examples/cli.yaml#/ScreenshotMarkerShow" 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 d8b32004..cee520e6 100644 --- a/paths/screenshot_markers/update.yaml +++ b/paths/screenshot_markers/update.yaml @@ -43,7 +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' -- "$ref": "../../examples/cli.yaml#/ScreenshotMarkerUpdate" requestBody: required: true content: diff --git a/paths/screenshots/create.yaml b/paths/screenshots/create.yaml index 99c127ba..284e4792 100644 --- a/paths/screenshots/create.yaml +++ b/paths/screenshots/create.yaml @@ -56,7 +56,6 @@ x-code-samples: -F name=home_screen \ -F description="Main landing page hero section" \ -F filename=@/path/to/home_screen.png -- "$ref": "../../examples/cli.yaml#/ScreenshotCreate" requestBody: required: true content: diff --git a/paths/screenshots/destroy.yaml b/paths/screenshots/destroy.yaml index d3c6c2c0..6f5bbdab 100644 --- a/paths/screenshots/destroy.yaml +++ b/paths/screenshots/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/ScreenshotDelete" x-cli-command: screenshots delete x-cli-version: '2.5' diff --git a/paths/screenshots/index.yaml b/paths/screenshots/index.yaml index a05c1bbb..8f4e9705 100644 --- a/paths/screenshots/index.yaml +++ b/paths/screenshots/index.yaml @@ -57,6 +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 -- "$ref": "../../examples/cli.yaml#/ScreenshotsList" x-cli-command: screenshots list x-cli-version: '2.5' diff --git a/paths/screenshots/show.yaml b/paths/screenshots/show.yaml index 11f464e9..921e56f3 100644 --- a/paths/screenshots/show.yaml +++ b/paths/screenshots/show.yaml @@ -44,6 +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 -- "$ref": "../../examples/cli.yaml#/ScreenshotShow" x-cli-command: screenshots show x-cli-version: '2.5' diff --git a/paths/screenshots/update.yaml b/paths/screenshots/update.yaml index 1f8a24fd..477ed2e4 100644 --- a/paths/screenshots/update.yaml +++ b/paths/screenshots/update.yaml @@ -45,7 +45,6 @@ x-code-samples: -F name=A%20screenshot%20name \ -F description=A%20screenshot%20description \ -F filename=@/path/to/my/screenshot.png -- "$ref": "../../examples/cli.yaml#/ScreenshotUpdate" requestBody: required: true content: diff --git a/paths/search/in_account.yaml b/paths/search/in_account.yaml index 875ec9cf..613502d9 100644 --- a/paths/search/in_account.yaml +++ b/paths/search/in_account.yaml @@ -47,7 +47,6 @@ x-code-samples: -F locale_code=localecode \ -F page=1 \ -F per_page=25 \ -- "$ref": "../../examples/cli.yaml#/SearchInAccount" requestBody: required: true content: diff --git a/paths/spaces/add_project.yaml b/paths/spaces/add_project.yaml index 714623ad..5b52bc97 100644 --- a/paths/spaces/add_project.yaml +++ b/paths/spaces/add_project.yaml @@ -32,7 +32,6 @@ x-code-samples: -X POST \ -d '{"id":"a4b3c2d1"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/SpacesProjectsCreate" requestBody: required: true content: diff --git a/paths/spaces/create.yaml b/paths/spaces/create.yaml index 339a61ee..67c4ce71 100644 --- a/paths/spaces/create.yaml +++ b/paths/spaces/create.yaml @@ -35,7 +35,6 @@ x-code-samples: -X POST \ -d '{"name":"My Android Projects"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/SpaceCreate" requestBody: required: true content: diff --git a/paths/spaces/delete.yaml b/paths/spaces/delete.yaml index 57f89c73..bc14923e 100644 --- a/paths/spaces/delete.yaml +++ b/paths/spaces/delete.yaml @@ -23,6 +23,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/spaces/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/SpaceDelete" x-cli-command: spaces delete x-cli-version: '2.5' diff --git a/paths/spaces/index.yaml b/paths/spaces/index.yaml index fd664fd2..328ee318 100644 --- a/paths/spaces/index.yaml +++ b/paths/spaces/index.yaml @@ -40,6 +40,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/spaces" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/SpacesList" 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 7e18be99..bfc8c196 100644 --- a/paths/spaces/remove_project.yaml +++ b/paths/spaces/remove_project.yaml @@ -24,6 +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 -- "$ref": "../../examples/cli.yaml#/SpacesProjectsDelete" x-cli-command: spaces projects_delete x-cli-version: '2.5' diff --git a/paths/spaces/show.yaml b/paths/spaces/show.yaml index 02b15b81..f02c381b 100644 --- a/paths/spaces/show.yaml +++ b/paths/spaces/show.yaml @@ -33,6 +33,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/spaces/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/SpaceShow" 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 306b1021..6097703f 100644 --- a/paths/spaces/spaces_projects.yaml +++ b/paths/spaces/spaces_projects.yaml @@ -41,6 +41,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/spaces/:space_id/projects" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/SpacesProjectsList" x-cli-command: spaces projects_list x-cli-version: '2.5' diff --git a/paths/spaces/update.yaml b/paths/spaces/update.yaml index dc49c352..ea734a9f 100644 --- a/paths/spaces/update.yaml +++ b/paths/spaces/update.yaml @@ -36,7 +36,6 @@ x-code-samples: -X PATCH \ -d '{"name":"My Android Projects"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/SpaceUpdate" requestBody: required: true content: diff --git a/paths/styleguides/create.yaml b/paths/styleguides/create.yaml index 5cf06119..4bf1a215 100644 --- a/paths/styleguides/create.yaml +++ b/paths/styleguides/create.yaml @@ -42,7 +42,6 @@ x-code-samples: -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":"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' -- "$ref": "../../examples/cli.yaml#/StyleguideCreate" requestBody: required: true content: diff --git a/paths/styleguides/destroy.yaml b/paths/styleguides/destroy.yaml index fc6e5cb0..029afc04 100644 --- a/paths/styleguides/destroy.yaml +++ b/paths/styleguides/destroy.yaml @@ -30,6 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/styleguides/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/StyleguideDelete" x-cli-command: style_guides delete x-cli-version: '2.5' diff --git a/paths/styleguides/index.yaml b/paths/styleguides/index.yaml index e82fbd17..f73bae09 100644 --- a/paths/styleguides/index.yaml +++ b/paths/styleguides/index.yaml @@ -45,6 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/styleguides" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/StyleguidesList" x-cli-command: style_guides list x-cli-version: '2.5' diff --git a/paths/styleguides/show.yaml b/paths/styleguides/show.yaml index cb50033e..983a244e 100644 --- a/paths/styleguides/show.yaml +++ b/paths/styleguides/show.yaml @@ -38,6 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/styleguides/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/StyleguideShow" x-cli-command: style_guides show x-cli-version: '2.5' diff --git a/paths/styleguides/update.yaml b/paths/styleguides/update.yaml index db1560b6..298e3cc7 100644 --- a/paths/styleguides/update.yaml +++ b/paths/styleguides/update.yaml @@ -43,7 +43,6 @@ x-code-samples: -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":"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' -- "$ref": "../../examples/cli.yaml#/StyleguideUpdate" requestBody: required: true content: diff --git a/paths/tags/create.yaml b/paths/tags/create.yaml index fb0229e1..ae19945a 100644 --- a/paths/tags/create.yaml +++ b/paths/tags/create.yaml @@ -42,7 +42,6 @@ x-code-samples: -X POST \ -d '{"branch":"my-feature-branch","name":"my-feature"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TagCreate" requestBody: required: true content: diff --git a/paths/tags/destroy.yaml b/paths/tags/destroy.yaml index a0c26b87..ec827750 100644 --- a/paths/tags/destroy.yaml +++ b/paths/tags/destroy.yaml @@ -38,6 +38,5 @@ x-code-samples: -X DELETE \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TagDelete" x-cli-command: tags delete x-cli-version: '2.5' diff --git a/paths/tags/index.yaml b/paths/tags/index.yaml index dffc9919..eb62624d 100644 --- a/paths/tags/index.yaml +++ b/paths/tags/index.yaml @@ -68,6 +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 - - "$ref": "../../examples/cli.yaml#/TagsList" x-cli-command: tags list x-cli-version: '2.5' diff --git a/paths/tags/show.yaml b/paths/tags/show.yaml index 477ba910..3704c2bc 100644 --- a/paths/tags/show.yaml +++ b/paths/tags/show.yaml @@ -50,6 +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 -- "$ref": "../../examples/cli.yaml#/TagShow" 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 dd056a84..aad08e84 100644 --- a/paths/teams/add_project.yaml +++ b/paths/teams/add_project.yaml @@ -32,7 +32,6 @@ x-code-samples: -X POST \ -d '{"id":"a4b3c2d1"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TeamsProjectsCreate" requestBody: required: true content: diff --git a/paths/teams/add_space.yaml b/paths/teams/add_space.yaml index 6f5ad452..cf48860f 100644 --- a/paths/teams/add_space.yaml +++ b/paths/teams/add_space.yaml @@ -32,7 +32,6 @@ x-code-samples: -X POST \ -d '{"id":"a4b3c2d1"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TeamsSpacesCreate" requestBody: required: true content: diff --git a/paths/teams/add_user.yaml b/paths/teams/add_user.yaml index 92805b31..adb2e1d1 100644 --- a/paths/teams/add_user.yaml +++ b/paths/teams/add_user.yaml @@ -32,7 +32,6 @@ x-code-samples: -X POST \ -d '{"id":"a4b3c2d1"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TeamsUsersCreate" requestBody: required: true content: diff --git a/paths/teams/create.yaml b/paths/teams/create.yaml index d2ce20c7..b8aa71e1 100644 --- a/paths/teams/create.yaml +++ b/paths/teams/create.yaml @@ -35,7 +35,6 @@ x-code-samples: -X POST \ -d '{"name":"German Translators"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TeamCreate" requestBody: required: true content: diff --git a/paths/teams/delete.yaml b/paths/teams/delete.yaml index b3b480c1..22899364 100644 --- a/paths/teams/delete.yaml +++ b/paths/teams/delete.yaml @@ -23,6 +23,5 @@ x-code-samples: curl "https://api.phrase.com/v2/accounts/:account_id/teams/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/TeamDelete" x-cli-command: teams delete x-cli-version: '2.5' diff --git a/paths/teams/index.yaml b/paths/teams/index.yaml index f3fb36bd..26ee9a1a 100644 --- a/paths/teams/index.yaml +++ b/paths/teams/index.yaml @@ -40,6 +40,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/teams" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/TeamsList" 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 eb3d608c..0c444f37 100644 --- a/paths/teams/remove_project.yaml +++ b/paths/teams/remove_project.yaml @@ -24,6 +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 -- "$ref": "../../examples/cli.yaml#/TeamsProjectsDelete" 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 4c6cb9f6..e03ca3fe 100644 --- a/paths/teams/remove_space.yaml +++ b/paths/teams/remove_space.yaml @@ -24,6 +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 -- "$ref": "../../examples/cli.yaml#/TeamsSpacesDelete" 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 59e2b0a3..bb7b7916 100644 --- a/paths/teams/remove_user.yaml +++ b/paths/teams/remove_user.yaml @@ -24,6 +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 -- "$ref": "../../examples/cli.yaml#/TeamsUsersDelete" x-cli-command: teams users_delete x-cli-version: '2.5' diff --git a/paths/teams/show.yaml b/paths/teams/show.yaml index 14f09714..a54f7967 100644 --- a/paths/teams/show.yaml +++ b/paths/teams/show.yaml @@ -33,6 +33,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/accounts/:account_id/teams/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/TeamShow" x-cli-command: teams show x-cli-version: '2.5' diff --git a/paths/teams/update.yaml b/paths/teams/update.yaml index 03c8a32d..532692e9 100644 --- a/paths/teams/update.yaml +++ b/paths/teams/update.yaml @@ -36,7 +36,6 @@ x-code-samples: -X PATCH \ -d '{"name":"German Translators"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TeamUpdate" requestBody: required: true content: diff --git a/paths/translations/batch_exclude.yaml b/paths/translations/batch_exclude.yaml index 523b7d98..edc0e993 100644 --- a/paths/translations/batch_exclude.yaml +++ b/paths/translations/batch_exclude.yaml @@ -40,7 +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' -- "$ref": "../../examples/cli.yaml#/TranslationsExcludeCollection" requestBody: required: true content: diff --git a/paths/translations/batch_include.yaml b/paths/translations/batch_include.yaml index aaf5647d..44781941 100644 --- a/paths/translations/batch_include.yaml +++ b/paths/translations/batch_include.yaml @@ -40,7 +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' -- "$ref": "../../examples/cli.yaml#/TranslationsIncludeCollection" requestBody: required: true content: diff --git a/paths/translations/batch_review.yaml b/paths/translations/batch_review.yaml index c8708f2c..5ad62aac 100644 --- a/paths/translations/batch_review.yaml +++ b/paths/translations/batch_review.yaml @@ -42,7 +42,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%reviewed:false%20tags:feature,center"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TranslationsReviewCollection" requestBody: required: true content: diff --git a/paths/translations/batch_unreview.yaml b/paths/translations/batch_unreview.yaml index e84c6424..5240fe12 100644 --- a/paths/translations/batch_unreview.yaml +++ b/paths/translations/batch_unreview.yaml @@ -41,7 +41,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%reviewed:false%20tags:feature,center"}' \ -H 'Content-Type: application/json' - - "$ref": "../../examples/cli.yaml#/TranslationsUnreviewCollection" requestBody: required: true content: diff --git a/paths/translations/batch_unverify.yaml b/paths/translations/batch_unverify.yaml index 26ebb93f..d021c1a4 100644 --- a/paths/translations/batch_unverify.yaml +++ b/paths/translations/batch_unverify.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/TranslationsUnverifyCollection" requestBody: required: true content: diff --git a/paths/translations/batch_verify.yaml b/paths/translations/batch_verify.yaml index f17605f8..c8538515 100644 --- a/paths/translations/batch_verify.yaml +++ b/paths/translations/batch_verify.yaml @@ -42,7 +42,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","q":"PhraseApp*%20unverified:true%20tags:feature,center"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TranslationsVerifyCollection" requestBody: required: true content: diff --git a/paths/translations/create.yaml b/paths/translations/create.yaml index 4888dc22..1e7bc465 100644 --- a/paths/translations/create.yaml +++ b/paths/translations/create.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/TranslationCreate" requestBody: required: true content: diff --git a/paths/translations/exclude.yaml b/paths/translations/exclude.yaml index a96b12b7..71a77b3c 100644 --- a/paths/translations/exclude.yaml +++ b/paths/translations/exclude.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TranslationExclude" requestBody: required: true content: diff --git a/paths/translations/include.yaml b/paths/translations/include.yaml index 2d8b0864..e34034b1 100644 --- a/paths/translations/include.yaml +++ b/paths/translations/include.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TranslationInclude" requestBody: required: true content: diff --git a/paths/translations/index.yaml b/paths/translations/index.yaml index 317eda21..8befee50 100644 --- a/paths/translations/index.yaml +++ b/paths/translations/index.yaml @@ -100,6 +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 -- "$ref": "../../examples/cli.yaml#/TranslationsList" 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 23bcf148..0c455731 100644 --- a/paths/translations/index_keys.yaml +++ b/paths/translations/index_keys.yaml @@ -81,6 +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 -- "$ref": "../../examples/cli.yaml#/TranslationsByKey" 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 59b4529f..98b39426 100644 --- a/paths/translations/index_locale.yaml +++ b/paths/translations/index_locale.yaml @@ -83,6 +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 -- "$ref": "../../examples/cli.yaml#/TranslationsByLocale" x-cli-command: translations by_locale x-cli-version: '2.5' diff --git a/paths/translations/review.yaml b/paths/translations/review.yaml index c1666a5e..0b636495 100644 --- a/paths/translations/review.yaml +++ b/paths/translations/review.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TranslationReview" requestBody: required: true content: diff --git a/paths/translations/search.yaml b/paths/translations/search.yaml index d44e7ba7..8739a157 100644 --- a/paths/translations/search.yaml +++ b/paths/translations/search.yaml @@ -46,7 +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' -- "$ref": "../../examples/cli.yaml#/TranslationsSearch" requestBody: required: true content: diff --git a/paths/translations/show.yaml b/paths/translations/show.yaml index f9cc465d..23168225 100644 --- a/paths/translations/show.yaml +++ b/paths/translations/show.yaml @@ -44,6 +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 -- "$ref": "../../examples/cli.yaml#/TranslationShow" x-cli-command: translations show x-cli-version: '2.5' diff --git a/paths/translations/unreview.yaml b/paths/translations/unreview.yaml index 23bfa569..5674419f 100644 --- a/paths/translations/unreview.yaml +++ b/paths/translations/unreview.yaml @@ -42,7 +42,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' - - "$ref": "../../examples/cli.yaml#/TranslationUnreview" requestBody: required: true content: diff --git a/paths/translations/unverify.yaml b/paths/translations/unverify.yaml index 42bf5360..6d44eebe 100644 --- a/paths/translations/unverify.yaml +++ b/paths/translations/unverify.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TranslationUnverify" requestBody: required: true content: diff --git a/paths/translations/update.yaml b/paths/translations/update.yaml index 847bd158..ede214b5 100644 --- a/paths/translations/update.yaml +++ b/paths/translations/update.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch","content":"My translation"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TranslationUpdate" requestBody: required: true content: diff --git a/paths/translations/verify.yaml b/paths/translations/verify.yaml index 6634aad4..1ff3d95f 100644 --- a/paths/translations/verify.yaml +++ b/paths/translations/verify.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"branch":"my-feature-branch"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/TranslationVerify" requestBody: required: true content: diff --git a/paths/upload_batches/create.yaml b/paths/upload_batches/create.yaml index 9787a6b7..cf9d337a 100644 --- a/paths/upload_batches/create.yaml +++ b/paths/upload_batches/create.yaml @@ -76,5 +76,4 @@ x-code-samples: ] }' \ -u : - - "$ref": "../../examples/cli.yaml#/UploadBatchesCreate" x-cli-command: upload_batches create diff --git a/paths/uploads/create.yaml b/paths/uploads/create.yaml index cfacd961..e0dc1067 100644 --- a/paths/uploads/create.yaml +++ b/paths/uploads/create.yaml @@ -49,7 +49,6 @@ x-code-samples: -F tags=awesome-feature,needs-proofreading \ -F locale_mapping[en]=2 \ -F format_options[foo]=bar - - "$ref": "../../examples/cli.yaml#/UploadCreate" requestBody: required: true content: diff --git a/paths/uploads/index.yaml b/paths/uploads/index.yaml index c3674c00..1c113414 100644 --- a/paths/uploads/index.yaml +++ b/paths/uploads/index.yaml @@ -51,6 +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 -- "$ref": "../../examples/cli.yaml#/UploadsList" x-cli-command: uploads list x-cli-version: '2.5' diff --git a/paths/uploads/show.yaml b/paths/uploads/show.yaml index 0607cc56..9a2feea9 100644 --- a/paths/uploads/show.yaml +++ b/paths/uploads/show.yaml @@ -44,6 +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 -- "$ref": "../../examples/cli.yaml#/UploadShow" x-cli-command: uploads show x-cli-version: '2.5' diff --git a/paths/users/user.yaml b/paths/users/user.yaml index cc21947d..b5c81a53 100644 --- a/paths/users/user.yaml +++ b/paths/users/user.yaml @@ -36,6 +36,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/user" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/ShowUser" x-cli-command: users user x-cli-version: '2.5' diff --git a/paths/variables/create.yaml b/paths/variables/create.yaml index 259f3364..6e2f553d 100644 --- a/paths/variables/create.yaml +++ b/paths/variables/create.yaml @@ -42,7 +42,6 @@ x-code-samples: -X POST \ -d '{"name":"MY_VARIABLE","value":"Hello World"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/VariableCreate" requestBody: required: true content: diff --git a/paths/variables/destroy.yaml b/paths/variables/destroy.yaml index eb64973e..1b7c1e01 100644 --- a/paths/variables/destroy.yaml +++ b/paths/variables/destroy.yaml @@ -30,6 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/variables/:name" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/VariableDelete" x-cli-command: variables delete x-cli-version: '2.5' diff --git a/paths/variables/index.yaml b/paths/variables/index.yaml index 7534eee8..b72c3526 100644 --- a/paths/variables/index.yaml +++ b/paths/variables/index.yaml @@ -45,6 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/variables" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/VariablesList" x-cli-command: variables list x-cli-version: '2.5' diff --git a/paths/variables/show.yaml b/paths/variables/show.yaml index 3ea9d3b3..6234e4ae 100644 --- a/paths/variables/show.yaml +++ b/paths/variables/show.yaml @@ -38,6 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/variables/:name" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/VariableShow" x-cli-command: variables show x-cli-version: '2.5' diff --git a/paths/variables/update.yaml b/paths/variables/update.yaml index d5e0cbe0..1c2fe112 100644 --- a/paths/variables/update.yaml +++ b/paths/variables/update.yaml @@ -43,7 +43,6 @@ x-code-samples: -X PATCH \ -d '{"name":"MY_VARIABLE","value":"Hello World"}' \ -H 'Content-Type: application/json' -- "$ref": "../../examples/cli.yaml#/VariableUpdate" requestBody: required: true content: diff --git a/paths/versions/index.yaml b/paths/versions/index.yaml index e49287eb..2d50f8ab 100644 --- a/paths/versions/index.yaml +++ b/paths/versions/index.yaml @@ -59,6 +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 -- "$ref": "../../examples/cli.yaml#/VersionsList" x-cli-command: versions_history list x-cli-version: '2.5' diff --git a/paths/versions/show.yaml b/paths/versions/show.yaml index 1b9c5395..5167350c 100644 --- a/paths/versions/show.yaml +++ b/paths/versions/show.yaml @@ -45,6 +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 -- "$ref": "../../examples/cli.yaml#/VersionShow" 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 362737b1..f399ff86 100644 --- a/paths/webhook_deliveries/index.yaml +++ b/paths/webhook_deliveries/index.yaml @@ -40,6 +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 -- "$ref": "../../examples/cli.yaml#/WebhookDeliveriesList" 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 8cc3f8d6..8effaf69 100644 --- a/paths/webhook_deliveries/redeliver.yaml +++ b/paths/webhook_deliveries/redeliver.yaml @@ -38,6 +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 -- "$ref": "../../examples/cli.yaml#/WebhookDeliveriesRedeliver" 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 dbe86471..85d4ccfa 100644 --- a/paths/webhook_deliveries/show.yaml +++ b/paths/webhook_deliveries/show.yaml @@ -36,6 +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 -- "$ref": "../../examples/cli.yaml#/WebhookDeliveriesShow" x-cli-command: webhook_deliveries show x-cli-version: '2.5' diff --git a/paths/webhooks/create.yaml b/paths/webhooks/create.yaml index bd99a599..6939f87a 100644 --- a/paths/webhooks/create.yaml +++ b/paths/webhooks/create.yaml @@ -42,7 +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' -- "$ref": "../../examples/cli.yaml#/WebhookCreate" requestBody: required: true content: diff --git a/paths/webhooks/destroy.yaml b/paths/webhooks/destroy.yaml index 3ee1c370..3dd10b32 100644 --- a/paths/webhooks/destroy.yaml +++ b/paths/webhooks/destroy.yaml @@ -30,6 +30,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X DELETE -- "$ref": "../../examples/cli.yaml#/WebhookDelete" x-cli-command: webhooks delete x-cli-version: '2.5' diff --git a/paths/webhooks/index.yaml b/paths/webhooks/index.yaml index fcb55d5c..a85470c1 100644 --- a/paths/webhooks/index.yaml +++ b/paths/webhooks/index.yaml @@ -45,6 +45,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/webhooks" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/WebhooksList" x-cli-command: webhooks list x-cli-version: '2.5' diff --git a/paths/webhooks/show.yaml b/paths/webhooks/show.yaml index 6fe1a485..4a06f972 100644 --- a/paths/webhooks/show.yaml +++ b/paths/webhooks/show.yaml @@ -38,6 +38,5 @@ x-code-samples: source: |- curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:id" \ -u USERNAME_OR_ACCESS_TOKEN -- "$ref": "../../examples/cli.yaml#/WebhookShow" x-cli-command: webhooks show x-cli-version: '2.5' diff --git a/paths/webhooks/test.yaml b/paths/webhooks/test.yaml index d80012c8..7b655b37 100644 --- a/paths/webhooks/test.yaml +++ b/paths/webhooks/test.yaml @@ -42,6 +42,5 @@ x-code-samples: curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:id/test" \ -u USERNAME_OR_ACCESS_TOKEN \ -X POST -- "$ref": "../../examples/cli.yaml#/WebhookTest" x-cli-command: webhooks test x-cli-version: '2.5' diff --git a/paths/webhooks/update.yaml b/paths/webhooks/update.yaml index 475b7cbf..b9561619 100644 --- a/paths/webhooks/update.yaml +++ b/paths/webhooks/update.yaml @@ -43,7 +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' -- "$ref": "../../examples/cli.yaml#/WebhookUpdate" requestBody: required: true content: 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(); From 1534aef18465ea675edc576873536f1139e577df Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Fri, 26 Jun 2026 14:29:17 +0200 Subject: [PATCH 3/8] docs: document x-cli-command and generated CLI samples in README Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d1ef3a53..f8dc9cc8 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,21 @@ 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, and injected into the compiled spec (`doc/compiled.json`) during +`make bundle`. 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. + ## Workflow The following repositories are generated upon pushing to this one: From 14a45f92e8d50f7695f219f07636dd9ce9f8ca40 Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Fri, 26 Jun 2026 14:44:02 +0200 Subject: [PATCH 4/8] fix(build): keep bundle/lint Node-only; inject in compare-output CI `make bundle` previously ran `make examples` (openapi-generator + Java), which broke the Node-only `lint` and `compare-output` CI jobs. Bundle now only injects the committed examples/cli.yaml (Node only); examples regeneration moves to the `cli` target (where Java is available) plus a standalone `make examples`. compare-output now runs scripts/inject-cli-examples.js after bundling so it reproduces the committed doc/compiled.json. Co-Authored-By: Claude Opus 4.8 (1M context) --- .github/workflows/lint.yml | 1 + Makefile | 7 +++++-- README.md | 11 ++++++++--- openapi-generator/templates/TEMPLATING.md | 18 ++++++++++++++---- 4 files changed, 28 insertions(+), 9 deletions(-) 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 5f76b312..e9607c79 100644 --- a/Makefile +++ b/Makefile @@ -14,13 +14,14 @@ lint: make bundle bash ./lint.sh bundle: - npx swagger-cli bundle -t yaml -w 300 main.yaml > tmp/compiled.yaml - make examples 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: openapi-generator-cli generate -i tmp/compiled.yaml -g go -o tmp/cli-examples -c ./openapi-generator/cli_examples_lang.yaml -e handlebars @@ -49,3 +50,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 f8dc9cc8..b86b2222 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,14 @@ You added an endpoint in Phrase Strings. In this project you do the following: 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, and injected into the compiled spec (`doc/compiled.json`) during -`make bundle`. 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. +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 diff --git a/openapi-generator/templates/TEMPLATING.md b/openapi-generator/templates/TEMPLATING.md index b7ffe726..0a8686d8 100644 --- a/openapi-generator/templates/TEMPLATING.md +++ b/openapi-generator/templates/TEMPLATING.md @@ -151,10 +151,20 @@ 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`): bundle YAML → `make examples` (regenerates -`examples/cli.yaml`) → bundle JSON+YAML → inject into both. The generator ignores -`x-code-samples`, so the injected samples in `tmp/compiled.yaml` do not affect a -subsequent `make examples`. +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 From b35a6b8a9d2a3f3a2a9bbc83ee1a26521ac7d6a2 Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Fri, 26 Jun 2026 15:26:45 +0200 Subject: [PATCH 5/8] fix(CLI): render array/numeric query+form flags correctly Array-typed flags (e.g. --locale_ids, --filters, --states) were rendered as a quoted JSON string containing quotes (--locale_ids "["de","en"]"), which is invalid. The flag-rendering branch only handled isMap/isBoolean; isArray and isNumeric fell through to string quoting. Arrays now render as single-quoted JSON ('["de","en"]', matching how the CLI parses []string flags via json.Unmarshal) and numerics render unquoted, aligning the flag path with the --data body path. Co-Authored-By: Claude Opus 4.8 (1M context) --- doc/compiled.json | 12 +++++------ examples/cli.yaml | 20 +++++++------------ .../templates/cli/cli_examples.handlebars | 2 +- 3 files changed, 14 insertions(+), 20 deletions(-) diff --git a/doc/compiled.json b/doc/compiled.json index 722f1cd7..31c82444 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -9862,7 +9862,7 @@ }, { "lang": "CLI v2", - "source": "phrase locales download \\\n --project_id \\\n --id \\\n --If-Modified-Since \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\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 " + "source": "phrase locales download \\\n --project_id \\\n --id \\\n --If-Modified-Since \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\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", @@ -11774,7 +11774,7 @@ }, { "lang": "CLI v2", - "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 " + "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", @@ -14379,7 +14379,7 @@ }, { "lang": "CLI v2", - "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 " + "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", @@ -15404,7 +15404,7 @@ }, { "lang": "CLI v2", - "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 " + "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", @@ -17414,7 +17414,7 @@ }, { "lang": "CLI v2", - "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 " + "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", @@ -31691,7 +31691,7 @@ }, { "lang": "CLI v2", - "source": "phrase linked_keys create \\\n --project_id \\\n --id \\\n --data '{ \"child_key_ids\": [\"child_key_id1\",\"child_key_id2\"] }' \\\n --access_token " + "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" diff --git a/examples/cli.yaml b/examples/cli.yaml index 9a4c2531..460f51b4 100644 --- a/examples/cli.yaml +++ b/examples/cli.yaml @@ -259,7 +259,7 @@ replies/list: --per_page "25" \ --branch "my-feature-branch" \ --query "Some comment content" \ - --filters "["read","unread"]" \ + --filters '["read","unread"]' \ --order "desc" \ --access_token reply/create: @@ -383,8 +383,8 @@ comments/list: --per_page "25" \ --branch "my-feature-branch" \ --query "Some comment content" \ - --locale_ids "["someId"]" \ - --filters "["read","unread"]" \ + --locale_ids '["someId"]' \ + --filters '["read","unread"]' \ --order "desc" \ --access_token custom_metadata_properties/delete: @@ -1064,7 +1064,7 @@ jobs/list: --owned_by "abcd1234cdef1234abcd1234cdef1234" \ --assigned_to "abcd1234cdef1234abcd1234cdef1234" \ --state "completed" \ - --states "["in_progress","completed"]" \ + --states '["in_progress","completed"]' \ --key_id "abcd1234cdef1234abcd1234cdef1234" \ --updated_since "2013-02-21T00:00:00.000Z" \ --access_token @@ -1190,7 +1190,7 @@ key_links/create: phrase linked_keys create \ --project_id \ --id \ - --data '{ "child_key_ids": ["child_key_id1","child_key_id2"] }' \ + --data '{ "child_key_ids": ["ijkl9012mnop3456ijkl9012mnop3456","abcd1234efgh5678abcd1234efgh5678"] }' \ --access_token key_links/destroy: lang: CLI v2 @@ -1279,7 +1279,7 @@ locale/download: --translation_key_prefix "prefix_" \ --filter_by_prefix true \ --custom_metadata_filters '{ }' \ - --locale_ids "["de","en"]" \ + --locale_ids '["de","en"]' \ --updated_since "2023-01-01T00:00:00Z" \ --access_token locale/show: @@ -1538,7 +1538,7 @@ projects/list: --per_page "25" \ --account_id "accountId_example" \ --sort_by "sortBy_example" \ - --filters "favorites" \ + --filters 'favorites' \ --q "name:android" \ --access_token quality_performance_score/list: @@ -1782,12 +1782,6 @@ screenshot/delete: --id \ --branch "my-feature-branch" \ --access_token -screenshot/ping: - lang: CLI v2 - source: |- - phrase screenshots ping \ - --project_id \ - --access_token screenshot/show: lang: CLI v2 source: |- diff --git a/openapi-generator/templates/cli/cli_examples.handlebars b/openapi-generator/templates/cli/cli_examples.handlebars index 7a3ed281..761a6bc2 100644 --- a/openapi-generator/templates/cli/cli_examples.handlebars +++ b/openapi-generator/templates/cli/cli_examples.handlebars @@ -2,7 +2,7 @@ lang: CLI v2 source: |- phrase {{{vendorExtensions.[x-cli-command]}}}{{#allParams}}{{^isBodyParam}}{{#unless (eq baseName "X-PhraseApp-OTP")}} \ - --{{baseName}} {{#isBinary}}<{{baseName}}>{{/isBinary}}{{^isBinary}}{{#isPathParam}}<{{baseName}}>{{/isPathParam}}{{^isPathParam}}{{#isMap}}'{ }'{{/isMap}}{{^isMap}}{{#isBoolean}}{{{example}}}{{/isBoolean}}{{^isBoolean}}{{#example}}"{{{.}}}"{{/example}}{{^example}}<{{baseName}}>{{/example}}{{/isBoolean}}{{/isMap}}{{/isPathParam}}{{/isBinary}}{{/unless}}{{/isBodyParam}}{{/allParams}}{{#bodyParam}} \ + --{{baseName}} {{#isBinary}}<{{baseName}}>{{/isBinary}}{{^isBinary}}{{#isPathParam}}<{{baseName}}>{{/isPathParam}}{{^isPathParam}}{{#isArray}}'{{{example}}}'{{/isArray}}{{^isArray}}{{#isMap}}'{ }'{{/isMap}}{{^isMap}}{{#isBoolean}}{{{example}}}{{/isBoolean}}{{^isBoolean}}{{#isNumeric}}{{{example}}}{{/isNumeric}}{{^isNumeric}}{{#example}}"{{{.}}}"{{/example}}{{^example}}<{{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}} From 89ce1552c374c4e9c61aa3c1cccb2aba8e622c0f Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Fri, 26 Jun 2026 15:35:12 +0200 Subject: [PATCH 6/8] fix(CLI): snake_case flag names for header params Header params (--if_modified_since, --if_none_match) were rendered from baseName (If-Modified-Since), but the CLI exposes them as ToSnakeCase(exportName). Flag names (and placeholders) now use lower+dash->underscore, matching the real CLI; all other params already had snake_case baseNames so are unaffected. Co-Authored-By: Claude Opus 4.8 (1M context) --- doc/compiled.json | 8 ++++---- examples/cli.yaml | 16 ++++++++-------- .../templates/cli/cli_examples.handlebars | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/compiled.json b/doc/compiled.json index 31c82444..c10bcbdb 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -9862,7 +9862,7 @@ }, { "lang": "CLI v2", - "source": "phrase locales download \\\n --project_id \\\n --id \\\n --If-Modified-Since \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\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 " + "source": "phrase locales download \\\n --project_id \\\n --id \\\n --if_modified_since \"ifModifiedSince_example\" \\\n --if_none_match \"ifNoneMatch_example\" \\\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", @@ -10069,7 +10069,7 @@ }, { "lang": "CLI v2", - "source": "phrase locale_downloads create \\\n --project_id \\\n --locale_id \\\n --If-Modified-Since \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\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 " + "source": "phrase locale_downloads create \\\n --project_id \\\n --locale_id \\\n --if_modified_since \"ifModifiedSince_example\" \\\n --if_none_match \"ifNoneMatch_example\" \\\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", @@ -10153,7 +10153,7 @@ }, { "lang": "CLI v2", - "source": "phrase locale_downloads show \\\n --project_id \\\n --locale_id \\\n --id \\\n --If-Modified-Since \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\n --access_token " + "source": "phrase locale_downloads show \\\n --project_id \\\n --locale_id \\\n --id \\\n --if_modified_since \"ifModifiedSince_example\" \\\n --if_none_match \"ifNoneMatch_example\" \\\n --access_token " } ], "x-cli-command": "locale_downloads show", @@ -27395,7 +27395,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations list \\\n --project_id \\\n --If-Modified-Since \"ifModifiedSince_example\" \\\n --If-None-Match \"ifNoneMatch_example\" \\\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 " + "source": "phrase translations list \\\n --project_id \\\n --if_modified_since \"ifModifiedSince_example\" \\\n --if_none_match \"ifNoneMatch_example\" \\\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", diff --git a/examples/cli.yaml b/examples/cli.yaml index 460f51b4..f7009a30 100644 --- a/examples/cli.yaml +++ b/examples/cli.yaml @@ -1213,8 +1213,8 @@ locale_download/create: phrase locale_downloads create \ --project_id \ --locale_id \ - --If-Modified-Since "ifModifiedSince_example" \ - --If-None-Match "ifNoneMatch_example" \ + --if_modified_since "ifModifiedSince_example" \ + --if_none_match "ifNoneMatch_example" \ --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: @@ -1224,8 +1224,8 @@ locale_download/show: --project_id \ --locale_id \ --id \ - --If-Modified-Since "ifModifiedSince_example" \ - --If-None-Match "ifNoneMatch_example" \ + --if_modified_since "ifModifiedSince_example" \ + --if_none_match "ifNoneMatch_example" \ --access_token account/locales: lang: CLI v2 @@ -1256,8 +1256,8 @@ locale/download: phrase locales download \ --project_id \ --id \ - --If-Modified-Since "ifModifiedSince_example" \ - --If-None-Match "ifNoneMatch_example" \ + --if_modified_since "ifModifiedSince_example" \ + --if_none_match "ifNoneMatch_example" \ --branch "my-feature-branch" \ --file_format "yml" \ --tags "feature1,feature2" \ @@ -2151,8 +2151,8 @@ translations/list: source: |- phrase translations list \ --project_id \ - --If-Modified-Since "ifModifiedSince_example" \ - --If-None-Match "ifNoneMatch_example" \ + --if_modified_since "ifModifiedSince_example" \ + --if_none_match "ifNoneMatch_example" \ --page "1" \ --per_page "25" \ --branch "my-feature-branch" \ diff --git a/openapi-generator/templates/cli/cli_examples.handlebars b/openapi-generator/templates/cli/cli_examples.handlebars index 761a6bc2..7948d9a7 100644 --- a/openapi-generator/templates/cli/cli_examples.handlebars +++ b/openapi-generator/templates/cli/cli_examples.handlebars @@ -2,7 +2,7 @@ lang: CLI v2 source: |- phrase {{{vendorExtensions.[x-cli-command]}}}{{#allParams}}{{^isBodyParam}}{{#unless (eq baseName "X-PhraseApp-OTP")}} \ - --{{baseName}} {{#isBinary}}<{{baseName}}>{{/isBinary}}{{^isBinary}}{{#isPathParam}}<{{baseName}}>{{/isPathParam}}{{^isPathParam}}{{#isArray}}'{{{example}}}'{{/isArray}}{{^isArray}}{{#isMap}}'{ }'{{/isMap}}{{^isMap}}{{#isBoolean}}{{{example}}}{{/isBoolean}}{{^isBoolean}}{{#isNumeric}}{{{example}}}{{/isNumeric}}{{^isNumeric}}{{#example}}"{{{.}}}"{{/example}}{{^example}}<{{baseName}}>{{/example}}{{/isNumeric}}{{/isBoolean}}{{/isMap}}{{/isArray}}{{/isPathParam}}{{/isBinary}}{{/unless}}{{/isBodyParam}}{{/allParams}}{{#bodyParam}} \ + --{{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}}"{{{.}}}"{{/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}} From 884839d3500d32367dfafb831cda0a889829e2ce Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Fri, 26 Jun 2026 16:01:51 +0200 Subject: [PATCH 7/8] fix(build): make `examples` target runnable Two issues prevented `make examples` from regenerating examples/cli.yaml: - The target name collided with the examples/ directory, so make considered it up to date and did nothing. Added a .PHONY declaration for all targets. - Use `npx openapi-generator-cli` (like the swagger-cli calls) so it resolves to the pinned npm dependency instead of an unconfigured asdf shim. Co-Authored-By: Claude Opus 4.8 (1M context) --- Makefile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index e9607c79..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 @@ -24,7 +26,7 @@ bundle: # x-cli-command, then re-run `make bundle` to inject the refreshed examples. # Requires tmp/compiled.yaml to exist (produced by `make bundle`). examples: - openapi-generator-cli generate -i tmp/compiled.yaml -g go -o tmp/cli-examples -c ./openapi-generator/cli_examples_lang.yaml -e handlebars + 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 From 82381f25fe3ae14266c72ec8566f31ddf5a82dcb Mon Sep 17 00:00:00 2001 From: Mladen Jablanovic Date: Fri, 26 Jun 2026 16:05:12 +0200 Subject: [PATCH 8/8] docs(API): add examples for If-Modified-Since / If-None-Match headers Add example values to the conditional-request header params so their CLI samples render real values instead of synthetic placeholders. The If-None-Match ETag example contains double quotes (W/"123456789"), which surfaced a gap: the flag-path string rendering did not escape inner quotes (only the --data body path did). Escape them there too. Co-Authored-By: Claude Opus 4.8 (1M context) --- doc/compiled.json | 14 ++++++++------ examples/cli.yaml | 16 ++++++++-------- .../templates/cli/cli_examples.handlebars | 2 +- parameters.yaml | 2 ++ 4 files changed, 19 insertions(+), 15 deletions(-) diff --git a/doc/compiled.json b/doc/compiled.json index c10bcbdb..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", @@ -9862,7 +9864,7 @@ }, { "lang": "CLI v2", - "source": "phrase locales download \\\n --project_id \\\n --id \\\n --if_modified_since \"ifModifiedSince_example\" \\\n --if_none_match \"ifNoneMatch_example\" \\\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 " + "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", @@ -10069,7 +10071,7 @@ }, { "lang": "CLI v2", - "source": "phrase locale_downloads create \\\n --project_id \\\n --locale_id \\\n --if_modified_since \"ifModifiedSince_example\" \\\n --if_none_match \"ifNoneMatch_example\" \\\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 " + "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", @@ -10153,7 +10155,7 @@ }, { "lang": "CLI v2", - "source": "phrase locale_downloads show \\\n --project_id \\\n --locale_id \\\n --id \\\n --if_modified_since \"ifModifiedSince_example\" \\\n --if_none_match \"ifNoneMatch_example\" \\\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", @@ -27395,7 +27397,7 @@ }, { "lang": "CLI v2", - "source": "phrase translations list \\\n --project_id \\\n --if_modified_since \"ifModifiedSince_example\" \\\n --if_none_match \"ifNoneMatch_example\" \\\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 " + "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", diff --git a/examples/cli.yaml b/examples/cli.yaml index f7009a30..79a01560 100644 --- a/examples/cli.yaml +++ b/examples/cli.yaml @@ -1213,8 +1213,8 @@ locale_download/create: phrase locale_downloads create \ --project_id \ --locale_id \ - --if_modified_since "ifModifiedSince_example" \ - --if_none_match "ifNoneMatch_example" \ + --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: @@ -1224,8 +1224,8 @@ locale_download/show: --project_id \ --locale_id \ --id \ - --if_modified_since "ifModifiedSince_example" \ - --if_none_match "ifNoneMatch_example" \ + --if_modified_since "2024-03-15T09:00:00Z" \ + --if_none_match "W/\"123456789\"" \ --access_token account/locales: lang: CLI v2 @@ -1256,8 +1256,8 @@ locale/download: phrase locales download \ --project_id \ --id \ - --if_modified_since "ifModifiedSince_example" \ - --if_none_match "ifNoneMatch_example" \ + --if_modified_since "2024-03-15T09:00:00Z" \ + --if_none_match "W/\"123456789\"" \ --branch "my-feature-branch" \ --file_format "yml" \ --tags "feature1,feature2" \ @@ -2151,8 +2151,8 @@ translations/list: source: |- phrase translations list \ --project_id \ - --if_modified_since "ifModifiedSince_example" \ - --if_none_match "ifNoneMatch_example" \ + --if_modified_since "2024-03-15T09:00:00Z" \ + --if_none_match "W/\"123456789\"" \ --page "1" \ --per_page "25" \ --branch "my-feature-branch" \ diff --git a/openapi-generator/templates/cli/cli_examples.handlebars b/openapi-generator/templates/cli/cli_examples.handlebars index 7948d9a7..d7294d54 100644 --- a/openapi-generator/templates/cli/cli_examples.handlebars +++ b/openapi-generator/templates/cli/cli_examples.handlebars @@ -2,7 +2,7 @@ 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}}"{{{.}}}"{{/example}}{{^example}}<{{lower (replace baseName "-" "_")}}>{{/example}}{{/isNumeric}}{{/isBoolean}}{{/isMap}}{{/isArray}}{{/isPathParam}}{{/isBinary}}{{/unless}}{{/isBodyParam}}{{/allParams}}{{#bodyParam}} \ + --{{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