feat(API): Add 'default_encoding' documentation (#733)

phrase · Dec 13, 2024 · 0139c51 · 0139c51
1 parent 139bc28
commit 0139c51
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
@@ -16837,6 +16837,18 @@
                     "description": "(Optional) Requires autotranslate_enabled to be true",
                     "type": "boolean",
                     "example": true
+                  },
+                  "default_encoding": {
+                    "description": "(Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the <a href='#post-/projects/-project_id-/uploads'>`file_encoding`</a> parameter for Uploads.",
+                    "type": "string",
+                    "example": "UTF-8",
+                    "enum": [
+                      "UTF-8",
+                      "UTF-16",
+                      "UTF-16BE",
+                      "UTF-16LE",
+                      "ISO-8859-1"
+                    ]
                   }
                 }
               }

diff --git a/paths/projects/update.yaml b/paths/projects/update.yaml
@@ -141,4 +141,14 @@ requestBody:
             description: "(Optional) Requires autotranslate_enabled to be true"
             type: boolean
             example: true
+          default_encoding:
+            description: "(Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the <a href='#post-/projects/-project_id-/uploads'>`file_encoding`</a> parameter for Uploads."
+            type: string
+            example: "UTF-8"            
+            enum:
+              - "UTF-8"
+              - "UTF-16"
+              - "UTF-16BE"
+              - "UTF-16LE"
+              - "ISO-8859-1"
 x-cli-version: "2.6.3"