Skip to content

Update runnable-endpoint docs to use live example instead of image #1293

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

Closed
wants to merge 1 commit into from
Closed

Update runnable-endpoint docs to use live example instead of image #1293

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
21 changes: 9 additions & 12 deletions .../products/docs/pages/component-library/default-components/runnable-endpoint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,15 @@

The `<RunnableEndpoint>` component enables users to make real HTTP requests to your APIs directly in the API Reference. It auto-detects endpoint definitions from your API specification and provides a request builder with inputs for headers, path parameters, query parameters, and request bodies.

<Tabs>
<Tab title="Example">

![Runnable Endpoint component example](runnable-endpoint.png)

</Tab>
<Tab title="Markdown">
````jsx
<RunnableEndpoint endpoint="GET /api/users/{id}" />
````
</Tab>
</Tabs>
<CodeBlock title="Markdown">
```jsx
<RunnableEndpoint endpoint="POST /snippets" />
```
</CodeBlock>

will be rendered as:

Check warning on line 14 in fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'be rendered' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'be rendered' looks like passive voice.", "location": {"path": "fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx", "range": {"start": {"line": 14, "column": 6}}}, "severity": "INFO"}

<RunnableEndpoint endpoint="POST /snippets" />

## Features

Expand Down