Skip to content

Commit 935e02b

Browse files
VarpuspaaviVarpuspaavi
authored
docs(API): Add examples in upload create params (#890)
1 parent 1155e2d commit 935e02b

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

‎clients/cli/go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,8 +215,8 @@ github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn
215215
github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc=
216216
github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181zc=
217217
github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
218-
github.com/phrase/phrase-go/v4 v4.7.0 h1:CCKJoVKM4hKVsXJ1F1G6NBRCQXr9HclZzZ/IbQGIwvI=
219-
github.com/phrase/phrase-go/v4 v4.7.0/go.mod h1:4XplKvrbHS2LDaXfFp9xrVDtO5xk2WHFm0htutwwd8c=
218+
github.com/phrase/phrase-go/v4 v4.9.0 h1:V+MWmNrxwrYNtmoY41dgrdWT902Er2hcohtQcpVvWmw=
219+
github.com/phrase/phrase-go/v4 v4.9.0/go.mod h1:4XplKvrbHS2LDaXfFp9xrVDtO5xk2WHFm0htutwwd8c=
220220
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
221221
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
222222
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=

‎doc/compiled.json‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14656,51 +14656,51 @@
1465614656
"update_translations": {
1465714657
"description": "Indicates whether existing translations should be updated with the file content.",
1465814658
"type": "boolean",
14659-
"example": null
14659+
"example": true
1466014660
},
1466114661
"update_custom_metadata": {
14662-
"description": "Indicates whether existing custom metadata properties should be updated with the file content",
14662+
"description": "Determines whether to update custom metadata values when uploading a file. If set to true, existing metadata can be changed or removed. Passing an empty value deletes the corresponding metadata property.",
1466314663
"type": "boolean",
1466414664
"default": true,
14665-
"example": null
14665+
"example": true
1466614666
},
1466714667
"update_translation_keys": {
1466814668
"description": "Pass `false` here to prevent new keys from being created and existing keys updated.",
1466914669
"type": "boolean",
1467014670
"default": true,
14671-
"example": null
14671+
"example": true
1467214672
},
1467314673
"update_translations_on_source_match": {
1467414674
"description": "Update target translations only if the source translations of the uploaded multilingual file match the stored translations.",
1467514675
"type": "boolean",
1467614676
"default": false,
14677-
"example": null
14677+
"example": true
1467814678
},
1467914679
"update_descriptions": {
1468014680
"description": "Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.",
1468114681
"type": "boolean",
14682-
"example": null
14682+
"example": true
1468314683
},
1468414684
"convert_emoji": {
1468514685
"description": "This option is obsolete. Providing the option will cause a bad request error.",
1468614686
"type": "boolean",
14687-
"example": null,
14687+
"example": true,
1468814688
"deprecated": true
1468914689
},
1469014690
"skip_upload_tags": {
1469114691
"description": "Indicates whether the upload should not create upload tags.",
1469214692
"type": "boolean",
14693-
"example": null
14693+
"example": true
1469414694
},
1469514695
"skip_unverification": {
1469614696
"description": "Indicates whether the upload should unverify updated translations.",
1469714697
"type": "boolean",
14698-
"example": null
14698+
"example": true
1469914699
},
1470014700
"file_encoding": {
1470114701
"description": "Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".",
1470214702
"type": "string",
14703-
"example": null
14703+
"example": "UTF-8"
1470414704
},
1470514705
"locale_mapping": {
1470614706
"description": "Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.",
@@ -14717,24 +14717,24 @@
1471714717
"autotranslate": {
1471814718
"description": "If set, translations for the uploaded language will be fetched automatically.",
1471914719
"type": "boolean",
14720-
"example": null
14720+
"example": true
1472114721
},
1472214722
"verify_mentioned_translations": {
1472314723
"description": "Indicates whether all translations mentioned in the upload should be verified.",
1472414724
"type": "boolean",
1472514725
"default": false,
14726-
"example": null
14726+
"example": true
1472714727
},
1472814728
"mark_reviewed": {
1472914729
"description": "Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.",
1473014730
"type": "boolean",
14731-
"example": null
14731+
"example": true
1473214732
},
1473314733
"tag_only_affected_keys": {
1473414734
"description": "Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`",
1473514735
"type": "boolean",
1473614736
"default": false,
14737-
"example": null
14737+
"example": true
1473814738
},
1473914739
"translation_key_prefix": {
1474014740
"description": "This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized.",

‎paths/uploads/create.yaml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -87,43 +87,43 @@ requestBody:
8787
update_translations:
8888
description: Indicates whether existing translations should be updated with the file content.
8989
type: boolean
90-
example:
90+
example: true
9191
update_custom_metadata:
92-
description: Indicates whether existing custom metadata properties should be updated with the file content
92+
description: Determines whether to update custom metadata values when uploading a file. If set to true, existing metadata can be changed or removed. Passing an empty value deletes the corresponding metadata property.
9393
type: boolean
9494
default: true
95-
example:
95+
example: true
9696
update_translation_keys:
9797
description: Pass `false` here to prevent new keys from being created and existing keys updated.
9898
type: boolean
9999
default: true
100-
example:
100+
example: true
101101
update_translations_on_source_match:
102102
description: Update target translations only if the source translations of the uploaded multilingual file match the stored translations.
103103
type: boolean
104104
default: false
105-
example:
105+
example: true
106106
update_descriptions:
107107
description: Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.
108108
type: boolean
109-
example:
109+
example: true
110110
convert_emoji:
111111
description: This option is obsolete. Providing the option will cause a bad request error.
112112
type: boolean
113-
example:
113+
example: true
114114
deprecated: true
115115
skip_upload_tags:
116116
description: Indicates whether the upload should not create upload tags.
117117
type: boolean
118-
example:
118+
example: true
119119
skip_unverification:
120120
description: Indicates whether the upload should unverify updated translations.
121121
type: boolean
122-
example:
122+
example: true
123123
file_encoding:
124124
description: Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1".
125125
type: string
126-
example:
126+
example: "UTF-8"
127127
locale_mapping:
128128
description: Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
129129
type: object
@@ -137,21 +137,21 @@ requestBody:
137137
autotranslate:
138138
description: If set, translations for the uploaded language will be fetched automatically.
139139
type: boolean
140-
example:
140+
example: true
141141
verify_mentioned_translations:
142142
description: Indicates whether all translations mentioned in the upload should be verified.
143143
type: boolean
144144
default: false
145-
example:
145+
example: true
146146
mark_reviewed:
147147
description: Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
148148
type: boolean
149-
example:
149+
example: true
150150
tag_only_affected_keys:
151151
description: Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
152152
type: boolean
153153
default: false
154-
example:
154+
example: true
155155
translation_key_prefix:
156156
description: This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized.
157157
type: string

0 commit comments

Comments
 (0)