Skip to content

chore: fix endpoint schema docs #1398

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

Merged
merged 1 commit into from
Oct 23, 2025
Merged

chore: fix endpoint schema docs #1398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 14 additions & 16 deletions ...cts/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ to specify the path to the schema you want to reference. The available selectors

The following markdown:
```jsx
<EndpointSchemaSnippet endpoint="POST /snippets" selector="request" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request" />
```
will be rendered as:
<br/>
<EndpointSchemaSnippet endpoint="POST /snippets" selector="request" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request" />
</Card>
</Tab>
<Tab title="Path">
Expand All @@ -34,13 +34,11 @@ to specify the path to the schema you want to reference. The available selectors
<br/>
The following markdown:
```jsx
<EndpointSchemaSnippet endpoint="GET /plant/{plantId}" selector="request.path" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.path" />
```
will be rendered as:
<br/>
<h3>Path Parameters</h3>
<img src="./path-parameters.png" alt="Get plant by ID" className="ml-0 dark:hidden" />
<img src="./path-parameters-dark.png" alt="Get plant by ID" className="ml-0 hidden dark:block" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.path" />
</Card>
</Tab>
<Tab title="Query">
Expand All @@ -49,11 +47,11 @@ to specify the path to the schema you want to reference. The available selectors
<br/>
The following markdown:
```jsx
<EndpointSchemaSnippet endpoint="POST /snippets/load" selector="request.query" />
<EndpointSchemaSnippet endpoint="POST /discord/install" selector="request.query" />
```
will be rendered as:
<br/>
<EndpointSchemaSnippet endpoint="POST /snippets/load" selector="request.query" />
<EndpointSchemaSnippet endpoint="POST /discord/install" selector="request.query" />
</Card>
</Tab>
<Tab title="Body">
Expand All @@ -62,11 +60,11 @@ to specify the path to the schema you want to reference. The available selectors
<br/>
The following markdown:
```jsx
<EndpointSchemaSnippet endpoint="POST /snippets/load" selector="request.body" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.body" />
```
will be rendered as:
<br/>
<EndpointSchemaSnippet endpoint="POST /snippets/load" selector="request.body" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.body" />
</Card>
</Tab>
</Tabs>
Expand All @@ -82,11 +80,11 @@ to specify the path to the schema you want to reference. The available selectors

The following markdown:
```jsx
<EndpointSchemaSnippet endpoint="POST /snippets" selector="response" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response" />
```
will be rendered as:
<br/>
<EndpointSchemaSnippet endpoint="POST /snippets" selector="response" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response" />
</Card>
</Tab>
<Tab title="Body">
Expand All @@ -95,11 +93,11 @@ to specify the path to the schema you want to reference. The available selectors
<br/>
The following markdown:
```jsx
<EndpointSchemaSnippet endpoint="POST /snippets" selector="response.body" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response.body" />
```
will be rendered as:
<br/>
<EndpointSchemaSnippet endpoint="POST /snippets" selector="response.body" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response.body" />
</Card>
</Tab>
</Tabs>
Expand All @@ -111,11 +109,11 @@ to specify the path to the schema you want to reference. The available selectors
<br/>
Passing no selector will render the entire schema. The following markdown:
```jsx
<EndpointSchemaSnippet endpoint="POST /snippets" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" />
```
will be rendered as:
<br/>
<EndpointSchemaSnippet endpoint="POST /snippets" />
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" />
</Card>
</Tab>
</Tabs>
Expand Down