diff --git a/sap-extensions/extensions.json b/sap-extensions/extensions.json index de50544..5385fe0 100644 --- a/sap-extensions/extensions.json +++ b/sap-extensions/extensions.json @@ -39,7 +39,9 @@ "sap:UserID", "sap:EndOfBusinessDate", "sap:BlockingDate", - "sap:EndOfRetentionDate" + "sap:IsBlockedIndicator", + "sap:EndOfRetentionDate", + "sap:DataCategoryID" ] }, "x-sap-dpp-is-potentially-personal": { @@ -50,7 +52,18 @@ "x-sap-dpp-is-potentially-sensitive": { "type": "boolean", "default": true, - "description": "Property contains potentially sensitive personal data. Sensitive personal data is a category of personal data that needs special handling. The determination which personal data is sensitive may differ for different legal areas or industries. Examples of sensitive personal data: 1. Special categories of personal data, such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, trade union membership, genetic data, biometric data, data concerning health or sex life or sexual orientation. 2. Personal data subject to professional secrecy. 3. Personal data relating to criminal or administrative offenses. 4. Personal data concerning insurances and bank or credit card accounts." + "description": "Property or entity containing potentially sensitive personal data. Sensitive personal data is a category of personal data that needs special handling. The determination which personal data is sensitive may differ for different legal areas or industries. Examples of sensitive personal data: 1. Special categories of personal data, such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, trade union membership, genetic data, biometric data, data concerning health or sex life or sexual orientation. 2. Personal data subject to professional secrecy. 3. Personal data relating to criminal or administrative offenses. 4. Personal data concerning insurances and bank or credit card accounts." + }, + "x-sap-dpp-related-data-category-id": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The annotation value is an array of strings, enabling the assignment of multiple data categories to one entity or field. Data categories are entities describing a particular set of personal data with a similar usage, meaning, quality, and risk. The strings must adhere to the format of an Correlation ID corresponding to the concept name dataCategory in conjunction with an localIdentifier introduced herein (refer to [ORD Specification | Open Resource Discovery](https://open-resource-discovery.org/spec-v1#correlation-id)).", + "examples": [ + "sap.s4com:dataCategory:SalesOrder", + "sap.s4com:dataCategory:PurchaseContract" + ] } } }, diff --git a/sap-schemas/v2.0/README.md b/sap-schemas/v2.0/README.md index 9c66729..f6f79d9 100644 --- a/sap-schemas/v2.0/README.md +++ b/sap-schemas/v2.0/README.md @@ -608,7 +608,9 @@ Constraints: - `sap:UserID` - `sap:EndOfBusinessDate` - `sap:BlockingDate` + - `sap:IsBlockedIndicator` - `sap:EndOfRetentionDate` + - `sap:DataCategoryID` Constraints: @@ -642,3 +644,31 @@ Constraints: - OPTIONAL - Default: `true` + +### `x-sap-dpp-related-data-category-id` + +- Type: `Array` +- Used at: [Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object) +- Description: The annotation value is an array of strings, enabling the assignment of multiple data categories to one entity or field. Data categories are entities describing a particular set of personal data with a similar usage, meaning, quality, and risk. The strings must adhere to the format of an Correlation ID corresponding to the concept name dataCategory in conjunction with an localIdentifier introduced herein (refer to [ORD Specification | Open Resource Discovery](https://open-resource-discovery.org/spec-v1#correlation-id)). + +- Array Item: + + - Type: `String` + +Example: + +```json +{ + "components": { + "schemas": { + "Product": { + "type": "object", + "x-sap-dpp-related-data-category-id": [ + "sap.s4com:dataCategory:SalesOrder", + "sap.s4com:dataCategory:PurchaseContract" + ] + } + } + } +} +``` diff --git a/sap-schemas/v2.0/schema.json b/sap-schemas/v2.0/schema.json index ff0ffa3..1eae945 100644 --- a/sap-schemas/v2.0/schema.json +++ b/sap-schemas/v2.0/schema.json @@ -1325,7 +1325,9 @@ "sap:UserID", "sap:EndOfBusinessDate", "sap:BlockingDate", - "sap:EndOfRetentionDate" + "sap:IsBlockedIndicator", + "sap:EndOfRetentionDate", + "sap:DataCategoryID" ] }, "x-sap-dpp-is-potentially-personal": { @@ -1336,7 +1338,18 @@ "x-sap-dpp-is-potentially-sensitive": { "type": "boolean", "default": true, - "description": "Property contains potentially sensitive personal data. Sensitive personal data is a category of personal data that needs special handling. The determination which personal data is sensitive may differ for different legal areas or industries. Examples of sensitive personal data: 1. Special categories of personal data, such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, trade union membership, genetic data, biometric data, data concerning health or sex life or sexual orientation. 2. Personal data subject to professional secrecy. 3. Personal data relating to criminal or administrative offenses. 4. Personal data concerning insurances and bank or credit card accounts." + "description": "Property or entity containing potentially sensitive personal data. Sensitive personal data is a category of personal data that needs special handling. The determination which personal data is sensitive may differ for different legal areas or industries. Examples of sensitive personal data: 1. Special categories of personal data, such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, trade union membership, genetic data, biometric data, data concerning health or sex life or sexual orientation. 2. Personal data subject to professional secrecy. 3. Personal data relating to criminal or administrative offenses. 4. Personal data concerning insurances and bank or credit card accounts." + }, + "x-sap-dpp-related-data-category-id": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The annotation value is an array of strings, enabling the assignment of multiple data categories to one entity or field. Data categories are entities describing a particular set of personal data with a similar usage, meaning, quality, and risk. The strings must adhere to the format of an Correlation ID corresponding to the concept name dataCategory in conjunction with an localIdentifier introduced herein (refer to [ORD Specification | Open Resource Discovery](https://open-resource-discovery.org/spec-v1#correlation-id)).", + "examples": [ + "sap.s4com:dataCategory:SalesOrder", + "sap.s4com:dataCategory:PurchaseContract" + ] }, "x-sap-odm-semantic-key": { "type": "array", diff --git a/sap-schemas/v3.0/README.md b/sap-schemas/v3.0/README.md index bf89fc8..d0c57d3 100644 --- a/sap-schemas/v3.0/README.md +++ b/sap-schemas/v3.0/README.md @@ -577,7 +577,9 @@ Constraints: - `sap:UserID` - `sap:EndOfBusinessDate` - `sap:BlockingDate` + - `sap:IsBlockedIndicator` - `sap:EndOfRetentionDate` + - `sap:DataCategoryID` Constraints: @@ -611,3 +613,31 @@ Constraints: - OPTIONAL - Default: `true` + +### `x-sap-dpp-related-data-category-id` + +- Type: `Array` +- Used at: [Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object) +- Description: The annotation value is an array of strings, enabling the assignment of multiple data categories to one entity or field. Data categories are entities describing a particular set of personal data with a similar usage, meaning, quality, and risk. The strings must adhere to the format of an Correlation ID corresponding to the concept name dataCategory in conjunction with an localIdentifier introduced herein (refer to [ORD Specification | Open Resource Discovery](https://open-resource-discovery.org/spec-v1#correlation-id)). + +- Array Item: + + - Type: `String` + +Example: + +```json +{ + "components": { + "schemas": { + "Product": { + "type": "object", + "x-sap-dpp-related-data-category-id": [ + "sap.s4com:dataCategory:SalesOrder", + "sap.s4com:dataCategory:PurchaseContract" + ] + } + } + } +} +``` diff --git a/sap-schemas/v3.0/schema.json b/sap-schemas/v3.0/schema.json index 76b86f7..dec59d0 100644 --- a/sap-schemas/v3.0/schema.json +++ b/sap-schemas/v3.0/schema.json @@ -718,7 +718,9 @@ "sap:UserID", "sap:EndOfBusinessDate", "sap:BlockingDate", - "sap:EndOfRetentionDate" + "sap:IsBlockedIndicator", + "sap:EndOfRetentionDate", + "sap:DataCategoryID" ] }, "x-sap-dpp-is-potentially-personal": { @@ -729,7 +731,18 @@ "x-sap-dpp-is-potentially-sensitive": { "type": "boolean", "default": true, - "description": "Property contains potentially sensitive personal data. Sensitive personal data is a category of personal data that needs special handling. The determination which personal data is sensitive may differ for different legal areas or industries. Examples of sensitive personal data: 1. Special categories of personal data, such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, trade union membership, genetic data, biometric data, data concerning health or sex life or sexual orientation. 2. Personal data subject to professional secrecy. 3. Personal data relating to criminal or administrative offenses. 4. Personal data concerning insurances and bank or credit card accounts." + "description": "Property or entity containing potentially sensitive personal data. Sensitive personal data is a category of personal data that needs special handling. The determination which personal data is sensitive may differ for different legal areas or industries. Examples of sensitive personal data: 1. Special categories of personal data, such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, trade union membership, genetic data, biometric data, data concerning health or sex life or sexual orientation. 2. Personal data subject to professional secrecy. 3. Personal data relating to criminal or administrative offenses. 4. Personal data concerning insurances and bank or credit card accounts." + }, + "x-sap-dpp-related-data-category-id": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The annotation value is an array of strings, enabling the assignment of multiple data categories to one entity or field. Data categories are entities describing a particular set of personal data with a similar usage, meaning, quality, and risk. The strings must adhere to the format of an Correlation ID corresponding to the concept name dataCategory in conjunction with an localIdentifier introduced herein (refer to [ORD Specification | Open Resource Discovery](https://open-resource-discovery.org/spec-v1#correlation-id)).", + "examples": [ + "sap.s4com:dataCategory:SalesOrder", + "sap.s4com:dataCategory:PurchaseContract" + ] }, "x-sap-odm-semantic-key": { "type": "array",