diff --git a/api-playground/mdx/configuration.mdx b/api-playground/mdx/configuration.mdx index 1bc9a9da2..4d989cdc3 100644 --- a/api-playground/mdx/configuration.mdx +++ b/api-playground/mdx/configuration.mdx @@ -59,7 +59,7 @@ To generate pages for API endpoints using `MDX`, configure your API settings in - You can override the globally-defined display mode for the API playground per page by adding `playground` at the top of the `MDX` file: + You can override the globally-defined display mode for the API playground for a page by adding `playground` to the frontmatter: ```mdx --- @@ -68,7 +68,11 @@ To generate pages for API endpoints using `MDX`, configure your API settings in playground: 'none' --- ``` - + + - `playground: 'interactive'` - Display the interactive playground. + - `playground: 'simple'` - Display a copyable endpoint with no playground. + - `playground: 'none'` - Hide the playground. + diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx index d3c6e36b2..1fc8aca58 100644 --- a/api-playground/overview.mdx +++ b/api-playground/overview.mdx @@ -112,6 +112,7 @@ When you need more control over your API documentation, create individual `MDX` - Add additional content like examples - Hide specific operations - Reorder pages in your navigation +- Control playground behavior per page See [MDX Setup](/api-playground/mdx/configuration) for more information on creating individual pages for your API endpoints.