Skip to content

Commit

Permalink
docs(entities-plugins): fix indentation (#1262)
Browse files Browse the repository at this point in the history
  • Loading branch information
sumimakito authored Mar 19, 2024
1 parent 9ddb1a8 commit 4d24b43
Showing 1 changed file with 9 additions and 0 deletions.
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

0 comments on commit 4d24b43

Please sign in to comment.