From 7f21538c9eed2eee13577bc338b64fb40bd31dfb Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Tue, 15 Feb 2022 10:22:28 +0100 Subject: [PATCH 1/2] catalog-model: deprecate JSONSchema Signed-off-by: Johan Haals --- .changeset/sharp-rice-do.md | 5 +++++ packages/catalog-model/api-report.md | 2 +- packages/catalog-model/src/types.ts | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 .changeset/sharp-rice-do.md diff --git a/.changeset/sharp-rice-do.md b/.changeset/sharp-rice-do.md new file mode 100644 index 0000000000..c1a6c0846c --- /dev/null +++ b/.changeset/sharp-rice-do.md @@ -0,0 +1,5 @@ +--- +'@backstage/catalog-model': patch +--- + +Deprecates `JSONSchema` export type. diff --git a/packages/catalog-model/api-report.md b/packages/catalog-model/api-report.md index 5124945933..b1ca96d750 100644 --- a/packages/catalog-model/api-report.md +++ b/packages/catalog-model/api-report.md @@ -289,7 +289,7 @@ export { GroupEntityV1alpha1 }; // @public export const groupEntityV1alpha1Validator: KindValidator; -// @public +// @public @deprecated export type JSONSchema = JSONSchema7 & { [key in string]?: JsonValue; }; diff --git a/packages/catalog-model/src/types.ts b/packages/catalog-model/src/types.ts index 1a0fab267c..0526f8807e 100644 --- a/packages/catalog-model/src/types.ts +++ b/packages/catalog-model/src/types.ts @@ -21,6 +21,7 @@ import { JSONSchema7 } from 'json-schema'; * JSONSchema extendable by arbitrary JSON attributes * * @public + * @deprecated use JSONSchema7 from the json-schema package instead. */ export type JSONSchema = JSONSchema7 & { [key in string]?: JsonValue }; From 89186d8356b8b3053ec18b7abdc83afa3ee59fcf Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Tue, 15 Feb 2022 14:29:36 +0100 Subject: [PATCH 2/2] chore: update wording Signed-off-by: Johan Haals --- .changeset/sharp-rice-do.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/sharp-rice-do.md b/.changeset/sharp-rice-do.md index c1a6c0846c..0441ac338a 100644 --- a/.changeset/sharp-rice-do.md +++ b/.changeset/sharp-rice-do.md @@ -2,4 +2,4 @@ '@backstage/catalog-model': patch --- -Deprecates `JSONSchema` export type. +Deprecated `JSONSchema` export type.