Skip to content

Commit c6a10b3

Browse files
authored
docs(API): document correct way of passing format_options (#1055)
1 parent d7356e9 commit c6a10b3

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

doc/compiled.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9119,7 +9119,12 @@
91199119
"example": true
91209120
},
91219121
"format_options": {
9122-
"description": "Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar`",
9122+
"description": "Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364)\nfor a list of options available for each format. Pass format options as a JSON object with key-value pairs corresponding\nto the option name and value. For example, to include comments in a Gettext file, pass `{\"include_comments\": true}`.\n",
9123+
"example": {
9124+
"format_options": {
9125+
"foo": "bar"
9126+
}
9127+
},
91239128
"type": "object",
91249129
"properties": {}
91259130
},

paths/locale_downloads/create.yaml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,13 @@ requestBody:
4848
type: boolean
4949
example: true
5050
format_options:
51-
description: 'Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar`'
52-
# example:
51+
description: |
52+
Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364)
53+
for a list of options available for each format. Pass format options as a JSON object with key-value pairs corresponding
54+
to the option name and value. For example, to include comments in a Gettext file, pass `{"include_comments": true}`.
55+
example:
56+
format_options:
57+
foo: bar
5358
type: object
5459
properties: {}
5560
encoding:

0 commit comments

Comments
 (0)