docs: update docs referencing OwnerPicker and EntityPicker

Signed-off-by: Enrico Alvarenga <enrico.alvarenga@segment.com>
This commit is contained in:
Enrico Alvarenga
2022-12-19 12:53:38 -08:00
parent e4c0240445
commit 1cd1c5cbb0
5 changed files with 46 additions and 18 deletions
+29 -1
View File
@@ -2,4 +2,32 @@
'@backstage/plugin-scaffolder': patch
---
Added a new prop to OwnerPicker and EntityPicker components to support filtering options by any field(s) of an entity.
Added the catalogFilter prop to OwnerPicker and EntityPicker components to support filtering options by any field(s) of an entity.
The `allowedKinds` field has been deprecated. Use `catalogFilter` instead. This field allows users to specify a filter on the shape of [EntityFilterQuery](https://github.com/backstage/backstage/blob/774c42003782121d3d6b2aa5f2865d53370c160e/packages/catalog-client/src/types/api.ts#L74), which can be passed into the CatalogClient. See examples below:
- Get all entities of kind `Group`
```yaml
owner:
title: Owner
type: string
description: Owner of the component
ui:field: OwnerPicker
ui:options:
catalogFilter:
- kind: Group
```
- Get entities of kind `Group` and spec.type `team`
```yaml
owner:
title: Owner
type: string
description: Owner of the component
ui:field: OwnerPicker
ui:options:
catalogFilter:
- kind: Group
spec.type: team
```
@@ -44,8 +44,8 @@ spec:
description: Owner of the component
ui:field: OwnerPicker
ui:options:
allowedKinds:
- Group
catalogFilter:
kind: Group
- title: Choose a location
required:
- repoUrl
@@ -459,7 +459,7 @@ an owner for them. Ideally, users should be able to select an owner when they go
through the scaffolder form from the users and groups already known to
Backstage. The `OwnerPicker` is a custom field that generates a searchable list
of groups and/or users already in the catalog to pick an owner from. You can
specify which of the two kinds are listed in the `allowedKinds` option:
specify which of the two kinds (or both) are listed in the `catalogFilter.kind` option:
```yaml
owner:
@@ -468,8 +468,8 @@ owner:
description: Owner of the component
ui:field: OwnerPicker
ui:options:
allowedKinds:
- Group
catalogFilter:
kind: [Group, User]
```
## `spec.steps` - `Action[]`
@@ -73,16 +73,16 @@ spec:
description: Owner of the component
ui:field: OwnerPicker
ui:options:
allowedKinds:
- Group
catalogFilter:
kind: Group
system:
title: System
type: string
description: System of the component
ui:field: EntityPicker
ui:options:
allowedKinds:
- System
catalogFilter:
kind: System
defaultKind: System
- title: Choose a location
@@ -74,16 +74,16 @@ spec:
description: Owner of the component
ui:field: OwnerPicker
ui:options:
allowedKinds:
- Group
catalogFilter:
kind: Group
system:
title: System
type: string
description: System of the component
ui:field: EntityPicker
ui:options:
allowedKinds:
- System
catalogFilter:
kind: System
defaultKind: System
- title: Choose a location
@@ -73,16 +73,16 @@ spec:
description: Owner of the component
ui:field: OwnerPicker
ui:options:
allowedKinds:
- Group
catalogFilter:
kind: Group
system:
title: System
type: string
description: System of the component
ui:field: EntityPicker
ui:options:
allowedKinds:
- System
catalogFilter:
kind: System
defaultKind: System
- title: Choose a location