Skip to content

Commit 7297901

Browse files
committed
Copy edit overview
1 parent ab16562 commit 7297901

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

api-playground/overview.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ The API playground is an interactive environment that lets users test and explor
1515

1616
The playground is automatically generated from your OpenAPI specification or AsyncAPI schema so any updates to your API are automatically reflected in the playground. You can also manually create API reference pages after defining a base URL and authentication method in your `docs.json`.
1717

18-
We recommend generating your API playground with an OpenAPI specification. See [OpenAPI Setup](/api-playground/openapi-setup) for more information on creating your OpenAPI document.
18+
We recommend generating your API playground from an OpenAPI specification. See [OpenAPI Setup](/api-playground/openapi-setup) for more information on creating your OpenAPI document.
1919

2020
## Getting started
2121

2222
<Steps>
2323
<Step title="Add your OpenAPI specification file.">
24-
You will need a valid OpenAPI specification file in your project.
24+
<Info>
25+
Make sure that your OpenAPI specification file is valid.
26+
</Info>
2527

2628
``` {2}
2729
/your-project
@@ -72,9 +74,11 @@ You can customize your API playground by defining the following properties in yo
7274

7375
<ResponseField name="examples" type="object">
7476
Configurations for the autogenerated API examples.
75-
<Expandable title="Examples" defaultOpen="True">
77+
<Expandable title="examples" defaultOpen="True">
7678
<ResponseField name="languages" type="array of string">
7779
Example languages for the autogenerated API snippets.
80+
81+
Languages display in the order specified.
7882
</ResponseField>
7983
<ResponseField name="defaults" type="&quot;required&quot; | &quot;all&quot;">
8084
Whether to show optional parameters in API examples. Defaults to `all`.
@@ -98,7 +102,7 @@ You can customize your API playground by defining the following properties in yo
98102
}
99103
```
100104

101-
This example configures the API playground to be fully interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets.
105+
This example configures the API playground to be interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets.
102106

103107
### Custom `MDX` pages
104108

@@ -109,8 +113,8 @@ When you need more control over your API documentation, create individual `MDX`
109113
- Hide specific operations
110114
- Reorder pages in your navigation
111115

112-
See [MDX Setup](/api-playground/mdx/configuration.mdx) for more information on creating individual pages for your API endpoints.
116+
See [MDX Setup](/api-playground/mdx/configuration) for more information on creating individual pages for your API endpoints.
113117

114118
## Further reading
115119

116-
- [AsyncAPI Setup](/api-playground/asyncapi/setup.mdx) for more information on creating your AsyncAPI schema to generate WebSocket reference pages.
120+
- [AsyncAPI Setup](/api-playground/asyncapi/setup) for more information on creating your AsyncAPI schema to generate WebSocket reference pages.

0 commit comments

Comments
 (0)