Skip to content

Fixed API Generation Explanation #654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fixed API Generation Explanation #654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ceea6d3
Documentation edits made through Mintlify web editor
andrew-mintlify Apr 14, 2025
aa7a6e9
Documentation edits made through Mintlify web editor
andrew-mintlify Apr 14, 2025
535a318
Documentation edits made through Mintlify web editor
andrew-mintlify Apr 14, 2025
bb1a33f
Documentation edits made through Mintlify web editor
andrew-mintlify Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions api-playground/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: 'Playground'
description: 'Enable users to interact with your API'
openapi: 'POST /project/update/{projectId}'
title: "Playground"
description: "Enable users to interact with your API"
openapi: "POST /project/update/{projectId}"
hideApiMarker: true
icon: 'play'
icon: "play"
---

The API playground is an interactive environment to make requests and preview an API endpoint.
The API playground is an interactive environment to make requests and preview an API endpoint. Everything you see on this page will be auto-generated utilizing your OpenAPI spec.

<Info>
Autogenerating API pages with OpenAPI will automatically generate API

Check warning on line 12 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/overview.mdx#L12 

Did you really mean 'Autogenerating'?
playground. Read more about using OpenAPI [here](/api-playground/openapi).
</Info>
</Info>
10 changes: 9 additions & 1 deletion content/components/sticky-examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ The `<RequestExample>` component works similar to [CodeGroup](/content/component

Please set a name on every code block you put inside RequestExample.

<Info>
This is where you can add additional custom languages as code examples for your API endpoints\!
</Info>

<RequestExample>

````md RequestExample Example
<RequestExample>

Expand All @@ -25,13 +30,15 @@ Please set a name on every code block you put inside RequestExample.

</RequestExample>
````

</RequestExample>

## Response Example

The `<ResponseExample>` component is the same as `<RequestExample>` but will show up underneath it.

<ResponseExample>

````md ResponseExample Example
<ResponseExample>

Expand All @@ -41,4 +48,5 @@ The `<ResponseExample>` component is the same as `<RequestExample>` but will sho

</ResponseExample>
````
</ResponseExample>

</ResponseExample>
Loading