Skip to content

Document examples option for readonly prop in RunnableEndpoint component #2268

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
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document examples option for readonly prop in RunnableEndpoint component #2268

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
2 changes: 1 addition & 1 deletion .../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 @@ -39,7 +39,7 @@ The component supports:
</ParamField>

<ParamField path="readonly" type="list of strings" required={false}>
Fields to lock by hiding their dropdown selectors. Accepts `"environment"` to lock the server URL and prevent users from switching environments. When set to `readonly={["environment"]}`, the environment selector is hidden and the endpoint uses the environment specified by `defaultEnvironment` (or the first environment if not specified).
Fields to lock by hiding their dropdown selectors. Accepts `"environment"` to lock the server URL and prevent users from switching environments, and `"examples"` to lock the example selection and prevent users from switching between multiple examples. When set to `readonly={["environment"]}`, the environment selector is hidden and the endpoint uses the environment specified by `defaultEnvironment` (or the first environment if not specified). When set to `readonly={["examples"]}`, the example selector is hidden and the endpoint uses the example specified by `example` (or the first example if not specified).
</ParamField>

<ParamField path="className" type="string" required={false}>
Expand Down