fix(API): make clearable string fields on update endpoints nullable #STRINGS-3652

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:

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

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.

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.

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.

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'

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.

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).

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

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

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'

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)