docs: mark allowedKinds as deprecated

Signed-off-by: Enrico Alvarenga <enrico.alvarenga@segment.com>
This commit is contained in:
Enrico Alvarenga
2022-12-19 12:55:02 -08:00
parent 1cd1c5cbb0
commit 981e34be32
2 changed files with 10 additions and 2 deletions
@@ -29,10 +29,15 @@ export const entityQueryFilterExpressionSchema = z.record(
export const EntityPickerFieldSchema = makeFieldSchemaFromZod(
z.string(),
z.object({
/**
* @deprecated Use `catalogFilter` instead.
*/
allowedKinds: z
.array(z.string())
.optional()
.describe('List of kinds of entities to derive options from'),
.describe(
'DEPRECATED: Use `catalogFilter` instead. List of kinds of entities to derive options from',
),
defaultKind: z
.string()
.optional()
@@ -23,12 +23,15 @@ import { entityQueryFilterExpressionSchema } from '../EntityPicker/schema';
export const OwnerPickerFieldSchema = makeFieldSchemaFromZod(
z.string(),
z.object({
/**
* @deprecated Use `catalogFilter` instead.
*/
allowedKinds: z
.array(z.string())
.default(['Group', 'User'])
.optional()
.describe(
'List of kinds of entities to derive options from. Defaults to Group and User',
'DEPRECATED: Use `catalogFilter` instead. List of kinds of entities to derive options from. Defaults to Group and User',
),
allowArbitraryValues: z
.boolean()