Update Phrase schema (#4638)

Author: jablan

src/schemas/json/phrase.json

@@ -19,6 +19,17 @@
       "description": "Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\"",
       "type": "string",
       "default": "UTF-8"
+    },
+    "format_options": {
+      "description": "Additional options available for specific formats. See our format guide for complete list.",
+      "type": "object",
+      "properties": {
+        "column_separator": {
+          "description": "Column separator character",
+          "type": "string",
+          "default": ";"
+        }
+      }
     }
   },
   "properties": {
@@ -51,24 +62,28 @@
                 "type": "object",
                 "properties": {
                   "file": {
-                    "description": "Translation file which will be uploaded",
+                    "description": "Translation file(s) which should be uploaded. You can either specify a single file or a pattern. The glob pattern will be expanded to all files matching the pattern. Besides '*' and '**', you can use the following placeholders: <locale_name> for the locale name and <locale_code> for the locale code",
                     "type": "string",
-                    "default": "<locale_name>.yml"
+                    "examples": [
+                      "en.yml",
+                      "translations/*.yml",
+                      "./src/<locale_name>.yml"
+                    ]
                   },
                   "params": {
                     "description": "Locale upload parameter",
                     "type": "object",
                     "properties": {
-                      "branch": {
-                        "description": "Branch name",
-                        "type": "string"
-                      },
                       "file_format": {
                         "$ref": "#/definitions/file_format"
                       },
                       "locale_id": {
                         "$ref": "#/definitions/locale_id"
                       },
+                      "branch": {
+                        "description": "Branch name",
+                        "type": "string"
+                      },
                       "tags": {
                         "description": "List of tags separated by comma to be associated with the new keys contained in the upload",
                         "type": "string"
@@ -110,27 +125,23 @@
                         "default": false
                       },
                       "mark_reviewed": {
-                        "description": "Indicated whether the imported translations should be marked as reviewed",
+                        "description": "Indicates whether the imported translations should be marked as reviewed",
                         "type": "boolean",
                         "default": false
                       },
                       "file_encoding": {
                         "$ref": "#/definitions/encoding"
                       },
+                      "translation_key_prefix": {
+                        "description": "Prefix all the created keys with the given prefix. This can be used to prevent collisions from multiple different sources",
+                        "type": "string"
+                      },
                       "locale_mapping": {
                         "description": "Optional, format specific mapping between locale names and the columns the translations to those locales are contained in",
                         "type": "object"
                       },
                       "format_options": {
-                        "description": "Additional options available for specific formats. See our format guide for complete list",
-                        "type": "object",
-                        "properties": {
-                          "column_separator": {
-                            "description": "Column separator character",
-                            "type": "string",
-                            "default": ";"
-                          }
-                        }
+                        "$ref": "#/definitions/format_options"
                       }
                     }
                   }
@@ -150,9 +161,9 @@
                 "type": "object",
                 "properties": {
                   "file": {
-                    "description": "Translation file which will be downloaded",
+                    "description": "Translation file which will be downloaded. You can either specify a single file or a pattern. The pattern can contain the following placeholders: <locale_name> for the locale name, <locale_code> for the locale code, and <tag>, which will go through the tag list and create a file for each tag. The placeholders will be replaced with the corresponding values.",
                     "type": "string",
-                    "default": "<locale_name>.yml"
+                    "examples": ["en.yml", "translations/<locale_name>.yml"]
                   },
                   "project_id": {
                     "$ref": "#/definitions/project_id"
@@ -228,6 +239,17 @@
                       "custom_metadata_filters": {
                         "description": "Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download",
                         "type": "object"
+                      },
+                      "filter_by_prefix": {
+                        "description": "Filters keys by prefix. Only keys starting with the given prefix will be included in the download, and the prefix will be removed from the key name in the files",
+                        "type": "string"
+                      },
+                      "translation_key_prefix": {
+                        "description": "If a key name starts with the given prefix, the prefix will be removed from the key name in the files",
+                        "type": "string"
+                      },
+                      "format_options": {
+                        "$ref": "#/definitions/format_options"
                       }
                     }
                   }

src/test/phrase/.phrase.yml

@@ -8,8 +8,10 @@ phrase:
     sources:
       - file: ./config/locales/en.yml
         params:
+          branch: main
           locale_id: en
           file_format: yml
+          translation_key_prefix: 'prefix.'
   pull:
     targets:
       - file: ./config/locales/<locale_name>.yml
@@ -18,3 +20,7 @@ phrase:
           use_last_reviewed_version: true
           include_empty_translations: true
           exclude_empty_zero_forms: true
+          custom_metadata_filters:
+            character: 'John Doe'
+          format_options:
+            column_separator: ','