From da44c47f436d24607844ad6fc0038bb8cf42e8ed Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Wed, 23 Feb 2022 13:29:46 +0100 Subject: [PATCH 1/3] catalog-model: Deprecate `entity.metadata.generation` Signed-off-by: Johan Haals --- .changeset/thirty-keys-study.md | 5 +++++ packages/catalog-model/src/entity/Entity.ts | 1 + 2 files changed, 6 insertions(+) create mode 100644 .changeset/thirty-keys-study.md diff --git a/.changeset/thirty-keys-study.md b/.changeset/thirty-keys-study.md new file mode 100644 index 0000000000..310f5bca34 --- /dev/null +++ b/.changeset/thirty-keys-study.md @@ -0,0 +1,5 @@ +--- +'@backstage/catalog-model': patch +--- + +Deprecated the `entity.metadata.generation` field which has been superseded by `entity.metadata.etag`. diff --git a/packages/catalog-model/src/entity/Entity.ts b/packages/catalog-model/src/entity/Entity.ts index 7199334e51..00865c6671 100644 --- a/packages/catalog-model/src/entity/Entity.ts +++ b/packages/catalog-model/src/entity/Entity.ts @@ -116,6 +116,7 @@ export type EntityMeta = JsonObject & { * This field can not be set by the user at creation time, and the server * will reject an attempt to do so. The field will be populated in read * operations. + * @deprecated replaced by etag. */ generation?: number; From 14bed12b763feac729890e289adba601ec923c44 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Wed, 23 Feb 2022 13:37:42 +0100 Subject: [PATCH 2/3] deprecate generation in entity schema Signed-off-by: Johan Haals --- packages/catalog-model/src/schema/EntityMeta.schema.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/catalog-model/src/schema/EntityMeta.schema.json b/packages/catalog-model/src/schema/EntityMeta.schema.json index c834bfb113..7b2b9d3f82 100644 --- a/packages/catalog-model/src/schema/EntityMeta.schema.json +++ b/packages/catalog-model/src/schema/EntityMeta.schema.json @@ -38,7 +38,8 @@ "type": "integer", "description": "A positive nonzero number that indicates the current generation of data for this entity; the value is incremented each time the spec changes. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations.", "examples": [1], - "minimum": 1 + "minimum": 1, + "deprecated": true }, "name": { "type": "string", From 4d8b9320b328521c2ebd0199485bfafdbfadaa28 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Wed, 23 Feb 2022 14:12:15 +0100 Subject: [PATCH 3/3] update wording Signed-off-by: Johan Haals --- .changeset/thirty-keys-study.md | 2 +- packages/catalog-model/src/entity/Entity.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/thirty-keys-study.md b/.changeset/thirty-keys-study.md index 310f5bca34..e2cc5fa76e 100644 --- a/.changeset/thirty-keys-study.md +++ b/.changeset/thirty-keys-study.md @@ -2,4 +2,4 @@ '@backstage/catalog-model': patch --- -Deprecated the `entity.metadata.generation` field which has been superseded by `entity.metadata.etag`. +Deprecated the `entity.metadata.generation` as the field has never been fully functioning. diff --git a/packages/catalog-model/src/entity/Entity.ts b/packages/catalog-model/src/entity/Entity.ts index 00865c6671..3b8205fba6 100644 --- a/packages/catalog-model/src/entity/Entity.ts +++ b/packages/catalog-model/src/entity/Entity.ts @@ -116,7 +116,7 @@ export type EntityMeta = JsonObject & { * This field can not be set by the user at creation time, and the server * will reject an attempt to do so. The field will be populated in read * operations. - * @deprecated replaced by etag. + * @deprecated field is not supported. */ generation?: number;