diff --git a/CHANGELOG.md b/CHANGELOG.md index 932d959..f308ca6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,14 @@ For a roadmap including expected timeline, please refer to [ROADMAP.md](./ROADMA ## [unreleased] +## [1.9.7] + +### Changed + +- Allowing `disabled` as "hidden property" in Data Products for backward compatibility + - The property was removed in favor of `lifecycleStatus` + - This may be cleaned up / removed again in the future + ## [1.9.6] ### Added diff --git a/dist/types/v1/Document.d.ts b/dist/types/v1/Document.d.ts index ba0b8bc..29bfdd2 100644 --- a/dist/types/v1/Document.d.ts +++ b/dist/types/v1/Document.d.ts @@ -1737,6 +1737,19 @@ export interface DataProduct { * APIs that are part of the input and output ports have their own independent `releaseStatus` and `version`. */ releaseStatus: "active" | "beta" | "deprecated"; + /** + * Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so. + * This can happen either because it has not been setup for use or disabled by an admin / user. + * + * If the resource is not available in principle for a particular system instance, e.g. due to lack of entitlement, it MUST not be described in the system-instance aware perspective. + * + * This property can only reflect the knowledge of the described system instance itself. + * Outside factors for availability can't need to be considered (e.g. network connectivity, middlewares). + * + * A disabled resource MAY skip describing its resource definitions. + * + */ + disabled?: boolean; /** * Lifecycle status of the Data Product as a whole. * diff --git a/package.json b/package.json index 570700c..677c735 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "$schema": "http://json.schemastore.org/package", "name": "@sap/open-resource-discovery", - "version": "1.9.6", + "version": "1.9.7", "description": "Open Resource Discovery (ORD) Specification", "author": "SAP SE", "license": "Apache-2.0", diff --git a/static/spec-v1/interfaces/Configuration.xlsx b/static/spec-v1/interfaces/Configuration.xlsx index bd3e221..4ae31a1 100644 Binary files a/static/spec-v1/interfaces/Configuration.xlsx and b/static/spec-v1/interfaces/Configuration.xlsx differ diff --git a/static/spec-v1/interfaces/Document.annotated.schema.json b/static/spec-v1/interfaces/Document.annotated.schema.json index e6cb14f..c9b7b03 100644 --- a/static/spec-v1/interfaces/Document.annotated.schema.json +++ b/static/spec-v1/interfaces/Document.annotated.schema.json @@ -2344,6 +2344,12 @@ "active" ] }, + "disabled": { + "type": "boolean", + "default": false, + "description": "Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.\nThis can happen either because it has not been setup for use or disabled by an admin / user.\n\nIf the resource is not available in principle for a particular system instance, e.g. due to lack of entitlement, it MUST not be described in the system-instance aware perspective.\n\nThis property can only reflect the knowledge of the described system instance itself.\nOutside factors for availability can't need to be considered (e.g. network connectivity, middlewares).\n\nA disabled resource MAY skip describing its resource definitions.\n", + "x-hide": true + }, "lifecycleStatus": { "type": "string", "description": "Lifecycle status of the Data Product as a whole.\n\nMUST be provided when describing the system-instance aware (run-time) perspective.\nSHOULD NOT be provided in static (design-time) perspective. Static aggregators MUST ignore this property.", diff --git a/static/spec-v1/interfaces/Document.csv b/static/spec-v1/interfaces/Document.csv index abff3fa..a8b6eb7 100644 --- a/static/spec-v1/interfaces/Document.csv +++ b/static/spec-v1/interfaces/Document.csv @@ -156,6 +156,7 @@ Data Product,version,true,string Data Product,lastUpdate,false,string Data Product,visibility,true,string Data Product,releaseStatus,true,string +Data Product,disabled,false,boolean Data Product,lifecycleStatus,false,string Data Product,deprecationDate,false,string Data Product,sunsetDate,false,string diff --git a/static/spec-v1/interfaces/Document.schema.json b/static/spec-v1/interfaces/Document.schema.json index c32180e..8298c2b 100644 --- a/static/spec-v1/interfaces/Document.schema.json +++ b/static/spec-v1/interfaces/Document.schema.json @@ -2211,6 +2211,11 @@ "active" ] }, + "disabled": { + "type": "boolean", + "default": false, + "description": "Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.\nThis can happen either because it has not been setup for use or disabled by an admin / user.\n\nIf the resource is not available in principle for a particular system instance, e.g. due to lack of entitlement, it MUST not be described in the system-instance aware perspective.\n\nThis property can only reflect the knowledge of the described system instance itself.\nOutside factors for availability can't need to be considered (e.g. network connectivity, middlewares).\n\nA disabled resource MAY skip describing its resource definitions.\n" + }, "lifecycleStatus": { "type": "string", "description": "Lifecycle status of the Data Product as a whole.\n\nMUST be provided when describing the system-instance aware (run-time) perspective.\nSHOULD NOT be provided in static (design-time) perspective. Static aggregators MUST ignore this property.", diff --git a/static/spec-v1/interfaces/Document.ts b/static/spec-v1/interfaces/Document.ts index a9db6d2..aa45970 100644 --- a/static/spec-v1/interfaces/Document.ts +++ b/static/spec-v1/interfaces/Document.ts @@ -1873,6 +1873,19 @@ export interface DataProduct { * APIs that are part of the input and output ports have their own independent `releaseStatus` and `version`. */ releaseStatus: "active" | "beta" | "deprecated"; + /** + * Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so. + * This can happen either because it has not been setup for use or disabled by an admin / user. + * + * If the resource is not available in principle for a particular system instance, e.g. due to lack of entitlement, it MUST not be described in the system-instance aware perspective. + * + * This property can only reflect the knowledge of the described system instance itself. + * Outside factors for availability can't need to be considered (e.g. network connectivity, middlewares). + * + * A disabled resource MAY skip describing its resource definitions. + * + */ + disabled?: boolean; /** * Lifecycle status of the Data Product as a whole. * diff --git a/static/spec-v1/interfaces/Document.ts.txt b/static/spec-v1/interfaces/Document.ts.txt index a9db6d2..aa45970 100644 --- a/static/spec-v1/interfaces/Document.ts.txt +++ b/static/spec-v1/interfaces/Document.ts.txt @@ -1873,6 +1873,19 @@ export interface DataProduct { * APIs that are part of the input and output ports have their own independent `releaseStatus` and `version`. */ releaseStatus: "active" | "beta" | "deprecated"; + /** + * Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so. + * This can happen either because it has not been setup for use or disabled by an admin / user. + * + * If the resource is not available in principle for a particular system instance, e.g. due to lack of entitlement, it MUST not be described in the system-instance aware perspective. + * + * This property can only reflect the knowledge of the described system instance itself. + * Outside factors for availability can't need to be considered (e.g. network connectivity, middlewares). + * + * A disabled resource MAY skip describing its resource definitions. + * + */ + disabled?: boolean; /** * Lifecycle status of the Data Product as a whole. * diff --git a/static/spec-v1/interfaces/Document.xlsx b/static/spec-v1/interfaces/Document.xlsx index 985b4d6..525052c 100644 Binary files a/static/spec-v1/interfaces/Document.xlsx and b/static/spec-v1/interfaces/Document.xlsx differ diff --git a/static/spec-v1/interfaces/DocumentAPI.oas3.yaml b/static/spec-v1/interfaces/DocumentAPI.oas3.yaml index 540c210..7424c1e 100644 --- a/static/spec-v1/interfaces/DocumentAPI.oas3.yaml +++ b/static/spec-v1/interfaces/DocumentAPI.oas3.yaml @@ -2866,6 +2866,26 @@ components: - beta - deprecated example: active + disabled: + type: boolean + default: false + description: > + Indicates that this resource is currently not available for consumption at runtime, but could be configured + to be so. + + This can happen either because it has not been setup for use or disabled by an admin / user. + + + If the resource is not available in principle for a particular system instance, e.g. due to lack of + entitlement, it MUST not be described in the system-instance aware perspective. + + + This property can only reflect the knowledge of the described system instance itself. + + Outside factors for availability can't need to be considered (e.g. network connectivity, middlewares). + + + A disabled resource MAY skip describing its resource definitions. lifecycleStatus: type: string description: |-