diff --git a/doc/compiled.json b/doc/compiled.json index 766710a45..5ffcacee6 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -7670,8 +7670,9 @@ "example": "Web application style guide" }, "audience": { - "description": "Audience description", + "description": "Audience description. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "customer-facing" }, "target_audience": { @@ -7715,43 +7716,51 @@ "example": "technical" }, "business": { - "description": "Description of the business", + "description": "Description of the business. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "We are a travel site that helps customers find the best hotels and flights." }, "company_branding": { - "description": "Company branding to remain consistent.", + "description": "Company branding to remain consistent. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "ACME Inc. should never be translated." }, "formatting": { - "description": "Formatting requirements and character limitations.", + "description": "Formatting requirements and character limitations. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "Never use capital letters" }, "glossary_terms": { - "description": "List of terms and/or phrases that need to be translated consistently.", + "description": "List of terms and/or phrases that need to be translated consistently. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "Apartment, cabin, loft" }, "grammar_consistency": { - "description": "Formal or informal pronouns, consistent conjugation, grammatical gender", + "description": "Formal or informal pronouns, consistent conjugation, grammatical gender. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "" }, "literal_translation": { - "description": "Can be one of: Cultural/Conversational, Literal, Neutral.", + "description": "Can be one of: Cultural/Conversational, Literal, Neutral. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "Neutral" }, "overall_tone": { - "description": "Tone requirement descriptions", + "description": "Tone requirement descriptions. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "Tone should be fun and light" }, "samples": { - "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.", + "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. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "http://www.myexample.com/my/document/path/to/samples.pdf" } } @@ -8152,9 +8161,10 @@ } }, "description": { - "description": "description of property", + "description": "description of property. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "example": "A healthy snack for all ages", - "type": "string" + "type": "string", + "nullable": true }, "value_options": { "description": "value options of property (only applies to single or multi select properties)", @@ -9929,8 +9939,9 @@ "example": "abcd1234abcd1234abcd1234abcd1234" }, "fallback_locale_id": { - "description": "Fallback locale for empty translations. Can be a locale name or id.", + "description": "Fallback locale for empty translations. Can be a locale name or id. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "abcd1234abcd1234abcd1234abcd1234" }, "unverify_new_translations": { @@ -9954,8 +9965,9 @@ "example": null }, "language_ai_profile": { - "description": "Identifier of the Language AI profile to use for this locale.", + "description": "Identifier of the Language AI profile to use for this locale. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "abcd1234abcd1234abcd1234abcd1234" } } @@ -11489,8 +11501,9 @@ "title": "release/update/parameters", "properties": { "description": { - "description": "Description of the release", + "description": "Description of the release. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "My first Release" }, "platforms": { @@ -11505,13 +11518,15 @@ ] }, "app_min_version": { - "description": "Minimum version of the app that the release supports in semver format", + "description": "Minimum version of the app that the release supports in semver format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "2.5.0" }, "app_max_version": { - "description": "Maximum version of the app that the release supports in semver format", + "description": "Maximum version of the app that the release supports in semver format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "3.0.0" }, "branch": { @@ -12629,8 +12644,9 @@ "example": "de" }, "briefing": { - "description": "Briefing for the translators", + "description": "Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "de-DE" }, "due_date": { @@ -12641,8 +12657,9 @@ "nullable": true }, "ticket_url": { - "description": "URL to a ticket for this job (e.g. Jira, Trello)", + "description": "URL to a ticket for this job (e.g. Jira, Trello) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "https://example.atlassian.net/browse/FOO" }, "target_locale_ids": { @@ -13713,8 +13730,9 @@ "example": "template" }, "briefing": { - "description": "Briefing for the translators", + "description": "Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "text" }, "autotranslate": { @@ -16530,8 +16548,9 @@ "example": "secr3t" }, "description": { - "description": "Webhook description", + "description": "Webhook description. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "My webhook for chat notifications" }, "events": { @@ -18472,8 +18491,9 @@ "example": "My Android Project" }, "point_of_contact": { - "description": "(Optional) User ID of the point of contact for the project. Pass `null` to unset.", + "description": "(Optional) User ID of the point of contact for the project. Pass `null` or an empty string to unset. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "abcd1234" }, "main_format": { @@ -22667,8 +22687,9 @@ "example": "A screenshot name" }, "description": { - "description": "Description of the screenshot", + "description": "Description of the screenshot. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "A screenshot description" }, "filename": { @@ -23097,8 +23118,9 @@ "example": "MyCompany" }, "description": { - "description": "Description of term", + "description": "Description of term. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "Use this when refering to our company" }, "translatable": { @@ -24872,8 +24894,9 @@ "example": null }, "name_plural": { - "description": "Plural name for the key (used in some file formats, e.g. Gettext)", + "description": "Plural name for the key (used in some file formats, e.g. Gettext) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "home.index.headlines" }, "data_type": { @@ -24915,18 +24938,21 @@ "example": null }, "original_file": { - "description": "Original file attribute. Used in some formats, e.g. XLIFF.", + "description": "Original file attribute. Used in some formats, e.g. XLIFF. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": null }, "localized_format_string": { - "description": "NSStringLocalizedFormatKey attribute. Used in .stringsdict format.", + "description": "NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": null }, "localized_format_key": { - "description": "NSStringLocalizedFormatKey attribute. Used in .stringsdict format.", + "description": "NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": null }, "custom_metadata": { @@ -31793,8 +31819,9 @@ "example": "template" }, "briefing": { - "description": "Briefing for the translators", + "description": "Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.", "type": "string", + "nullable": true, "example": "text" }, "autotranslate": { diff --git a/paths/custom_metadata_properties/update.yaml b/paths/custom_metadata_properties/update.yaml index 20de82257..0fba0c078 100644 --- a/paths/custom_metadata_properties/update.yaml +++ b/paths/custom_metadata_properties/update.yaml @@ -29,9 +29,10 @@ requestBody: items: type: string description: - description: description of property + description: description of property. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. example: A healthy snack for all ages type: string + nullable: true value_options: description: value options of property (only applies to single or multi select properties) example: diff --git a/paths/glossary_terms/update.yaml b/paths/glossary_terms/update.yaml index 7e06e6b20..c187f2b32 100644 --- a/paths/glossary_terms/update.yaml +++ b/paths/glossary_terms/update.yaml @@ -65,8 +65,9 @@ requestBody: type: string example: MyCompany description: - description: Description of term + description: Description of term. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: Use this when refering to our company translatable: description: Indicates whether the term should be used for all languages or can be translated diff --git a/paths/job_templates/update.yaml b/paths/job_templates/update.yaml index 3780268be..c12969a4a 100644 --- a/paths/job_templates/update.yaml +++ b/paths/job_templates/update.yaml @@ -67,8 +67,9 @@ requestBody: type: string example: template briefing: - description: Briefing for the translators + description: Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: text autotranslate: description: Automatically translate the job using machine translation. diff --git a/paths/jobs/update.yaml b/paths/jobs/update.yaml index 90ef26e03..173f87ba5 100644 --- a/paths/jobs/update.yaml +++ b/paths/jobs/update.yaml @@ -65,8 +65,9 @@ requestBody: type: string example: de briefing: - description: Briefing for the translators + description: Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: de-DE due_date: description: Date the job should be finished @@ -75,8 +76,9 @@ requestBody: example: '2017-08-15' nullable: true ticket_url: - description: URL to a ticket for this job (e.g. Jira, Trello) + description: URL to a ticket for this job (e.g. Jira, Trello) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: https://example.atlassian.net/browse/FOO target_locale_ids: description: List of target locales for the job. diff --git a/paths/keys/update.yaml b/paths/keys/update.yaml index ae8ce1a98..8a9d0d23f 100644 --- a/paths/keys/update.yaml +++ b/paths/keys/update.yaml @@ -86,8 +86,9 @@ requestBody: type: boolean example: name_plural: - description: Plural name for the key (used in some file formats, e.g. Gettext) + description: Plural name for the key (used in some file formats, e.g. Gettext) Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: home.index.headlines data_type: description: 'Type of the key. Can be one of the following: string, number, boolean, array, markdown.' @@ -121,16 +122,19 @@ requestBody: type: boolean example: original_file: - description: Original file attribute. Used in some formats, e.g. XLIFF. + description: Original file attribute. Used in some formats, e.g. XLIFF. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: localized_format_string: - description: NSStringLocalizedFormatKey attribute. Used in .stringsdict format. + description: NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: localized_format_key: - description: NSStringLocalizedFormatKey attribute. Used in .stringsdict format. + description: NSStringLocalizedFormatKey attribute. Used in .stringsdict format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: custom_metadata: description: Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value. diff --git a/paths/locales/update.yaml b/paths/locales/update.yaml index ef9259db4..dc15c9d35 100644 --- a/paths/locales/update.yaml +++ b/paths/locales/update.yaml @@ -87,8 +87,9 @@ requestBody: type: string example: abcd1234abcd1234abcd1234abcd1234 fallback_locale_id: - description: Fallback locale for empty translations. Can be a locale name or id. + description: Fallback locale for empty translations. Can be a locale name or id. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: abcd1234abcd1234abcd1234abcd1234 unverify_new_translations: description: Indicates that new translations for this locale should be marked as unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. @@ -107,7 +108,8 @@ requestBody: type: boolean example: language_ai_profile: - description: Identifier of the Language AI profile to use for this locale. + description: Identifier of the Language AI profile to use for this locale. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: abcd1234abcd1234abcd1234abcd1234 x-cli-version: '2.5' diff --git a/paths/organization_job_templates/update.yaml b/paths/organization_job_templates/update.yaml index 33b1e1ac7..be3cfdbbe 100644 --- a/paths/organization_job_templates/update.yaml +++ b/paths/organization_job_templates/update.yaml @@ -61,8 +61,9 @@ requestBody: type: string example: template briefing: - description: Briefing for the translators + description: Briefing for the translators. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: text autotranslate: description: Automatically translate the job using machine translation. diff --git a/paths/projects/update.yaml b/paths/projects/update.yaml index c69aa570a..7c95d7892 100644 --- a/paths/projects/update.yaml +++ b/paths/projects/update.yaml @@ -70,8 +70,9 @@ requestBody: type: string example: My Android Project point_of_contact: - description: (Optional) User ID of the point of contact for the project. Pass `null` to unset. + description: (Optional) User ID of the point of contact for the project. Pass `null` or an empty string to unset. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: abcd1234 main_format: description: (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364) or our [Formats API Endpoint](#formats). diff --git a/paths/releases/update.yaml b/paths/releases/update.yaml index 33ad17c57..ef73626e8 100644 --- a/paths/releases/update.yaml +++ b/paths/releases/update.yaml @@ -61,8 +61,9 @@ requestBody: title: release/update/parameters properties: description: - description: Description of the release + description: Description of the release. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: My first Release platforms: description: List of platforms the release should support. @@ -73,12 +74,14 @@ requestBody: - android - ios app_min_version: - description: Minimum version of the app that the release supports in semver format + description: Minimum version of the app that the release supports in semver format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: 2.5.0 app_max_version: - description: Maximum version of the app that the release supports in semver format + description: Maximum version of the app that the release supports in semver format. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: 3.0.0 branch: description: Branch used for release diff --git a/paths/screenshots/update.yaml b/paths/screenshots/update.yaml index df4f3e29d..97062b263 100644 --- a/paths/screenshots/update.yaml +++ b/paths/screenshots/update.yaml @@ -69,8 +69,9 @@ requestBody: type: string example: A screenshot name description: - description: Description of the screenshot + description: Description of the screenshot. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: A screenshot description filename: description: Screenshot file diff --git a/paths/styleguides/update.yaml b/paths/styleguides/update.yaml index 7ef3c19a8..9a9a1a988 100644 --- a/paths/styleguides/update.yaml +++ b/paths/styleguides/update.yaml @@ -63,8 +63,9 @@ requestBody: type: string example: Web application style guide audience: - description: Audience description + description: Audience description. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: customer-facing target_audience: description: Target audience for the translations. @@ -101,35 +102,43 @@ requestBody: - fictional example: technical business: - description: Description of the business + description: Description of the business. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: We are a travel site that helps customers find the best hotels and flights. company_branding: - description: Company branding to remain consistent. + description: Company branding to remain consistent. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: ACME Inc. should never be translated. formatting: - description: Formatting requirements and character limitations. + description: Formatting requirements and character limitations. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: Never use capital letters glossary_terms: - description: List of terms and/or phrases that need to be translated consistently. + description: List of terms and/or phrases that need to be translated consistently. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: Apartment, cabin, loft grammar_consistency: - description: Formal or informal pronouns, consistent conjugation, grammatical gender + description: Formal or informal pronouns, consistent conjugation, grammatical gender. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: '' literal_translation: - description: 'Can be one of: Cultural/Conversational, Literal, Neutral.' + description: 'Can be one of: Cultural/Conversational, Literal, Neutral. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there.' type: string + nullable: true example: Neutral overall_tone: - description: Tone requirement descriptions + description: Tone requirement descriptions. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: Tone should be fun and light samples: - 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. + 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. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: http://www.myexample.com/my/document/path/to/samples.pdf x-cli-version: '2.5' diff --git a/paths/webhooks/update.yaml b/paths/webhooks/update.yaml index f415434c0..a020cd21b 100644 --- a/paths/webhooks/update.yaml +++ b/paths/webhooks/update.yaml @@ -67,8 +67,9 @@ requestBody: type: string example: secr3t description: - description: Webhook description + description: Webhook description. Send an empty string or `null` to clear the value; omit the field to leave it unchanged. The Phrase CLI drops `null` values before sending, so use an empty string there. type: string + nullable: true example: My webhook for chat notifications events: description: List of event names to trigger the webhook (separated by comma)