Skip to content

Commit 94f6092

Browse files
authored
Add request example docs (#254)
1 parent 3c1a193 commit 94f6092

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

settings/global.mdx

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -390,10 +390,18 @@ Example:
390390
</Expandable>
391391
</ResponseField>
392392

393-
<ResponseField name="maintainOrder" type="boolean" default={false}>
394-
Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.
395-
396-
<Warning>This behavior will soon be enabled by default, at which point this field will be deprecated.</Warning>
393+
<ResponseField name="request" type="object">
394+
Configurations for API requests
395+
<Expandable title="Request">
396+
<ResponseField name="example" type="object">
397+
Configurations for the auto-generated API request examples
398+
<Expandable>
399+
<ResponseField name="languages" type="string[]">
400+
An array of strings that determine the order of the languages of the auto-generated request examples. You can either define custom languages utilizing [x-codeSamples](/api-playground/openapi/advanced-features#x-codesamples) or use our default languages which include `bash`, `python`, `javascript`, `php`, `go`, `java`
401+
</ResponseField>
402+
</Expandable>
403+
</ResponseField>
404+
</Expandable>
397405
</ResponseField>
398406

399407
<ResponseField name="paramFields" type="ApiParamFields">
@@ -587,4 +595,5 @@ Click on the following dropdown to view a sample configuration file
587595

588596
## More Customization
589597

590-
Learn more about how to further customize your docs with custom CSS and JS in [Custom Scripts](https://mintlify.com/docs/integrations/custom/).
598+
Learn more about how to further customize your docs with custom CSS and JS in
599+
[Custom Scripts](https://mintlify.com/docs/integrations/custom/).

0 commit comments

Comments
 (0)