Skip to content
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.

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

docs(entities-plugins): fix indentation #1262

Merged
merged 1 commit into from
Mar 19, 2024
Merged
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions packages/entities/entities-plugins/docs/plugin-select.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,46 +35,55 @@ A grid component for selecting Plugins.
- required: `true`
- default: `undefined`
- App name.

- `apiBaseUrl`:
- type: `string`
- required: `true`
- default: `undefined`
- Base URL for API requests.

- `requestHeaders`:
- type: `RawAxiosRequestHeaders | AxiosHeaders`
- required: `false`
- default: `undefined`
- Additional headers to send with all Axios requests.

- `getCreateRoute`:
- type: `(plugin: string) => RouteLocationRaw`
- required: `true`
- default: `undefined`
- A function that returns the route for creating a specific plugin type.

- `createCustomRoute`:
- type: RouteLocationRaw
- required: `false`
- default: `undefined`
- The route for creating a custom plugin.

- `getCustomEditRoute`:
- type: `(plugin: string) => RouteLocationRaw`
- required: `false`
- default: `undefined`
- A function that returns the route for editing a custom plugin.

- `workspace`:
- type: `string`
- required: `true`
- default: `undefined`
- *Specific to Kong Manager*. Name of the current workspace.

- `controlPlaneId`:
- type: `string`
- required: `true`
- default: `undefined`
- *Specific to Konnect*. Name of the current control plane.

- `entityId`:
- type: `string`
- required: `false`
- default: `null`
- Current entity id if the PluginSelect is being launched from the plugins tab on a consumer, consumer group, gateway service, or route detail page.

- `entityType`:
- type: `'consumers' | 'consumer_groups' | 'services' | 'routes'`
- required: `false`
Expand Down
Loading