[TSI-2174] Add custom_metadata_filters param to locale download endpoint

phrase · Dec 5, 2023 · f536479 · f536479
1 parent e03aa9f
commit f536479
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
@@ -7778,6 +7778,17 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "name": "custom_metadata_filters",
+            "in": "query",
+            "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.\n",
+            "schema": {
+              "type": "object",
+              "properties": {}
+            },
+            "style": "deepObject",
+            "explode": true
           }
         ],
         "responses": {
@@ -7816,7 +7827,7 @@
         "x-code-samples": [
           {
             "lang": "Curl",
-            "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\" \\\n  -u USERNAME_OR_ACCESS_TOKEN"
+            "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\" \\\n  -u USERNAME_OR_ACCESS_TOKEN"
           },
           {
             "lang": "CLI v2",

diff --git a/paths/locales/download.yaml b/paths/locales/download.yaml
@@ -112,6 +112,15 @@ parameters:
     in: query
     schema:
       type: string
+  - name: custom_metadata_filters
+    in: query
+    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.
+    schema:
+      type: object
+      properties: {}
+    style: deepObject
+    explode: true
 responses:
   "200":
     description: OK
@@ -136,7 +145,7 @@ responses:
 x-code-samples:
   - lang: Curl
     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" \
+      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: |-