Skip to content

Added new PersonalData Annoations #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sthesse wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Added new PersonalData Annoations #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ebda34c
update
sthesse Mar 20, 2026
4297e7d
update
sthesse Mar 20, 2026
40f3c45
Merge pull request #1 from sthesse/add/dpp_annotations
sthesse Mar 20, 2026
17fa7e9
Extending @PersonalData.isPotentiallySensitive to entities
sthesse Apr 14, 2026
ec69937
addressing reviewers feedback
sthesse Apr 27, 2026
99cf5a1
generation of schema
sthesse Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions sap-extensions/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@
"sap:UserID",
"sap:EndOfBusinessDate",
"sap:BlockingDate",
"sap:EndOfRetentionDate"
"sap:IsBlockedIndicator",
"sap:EndOfRetentionDate",
"sap:DataCategoryID"
]
},
"x-sap-dpp-is-potentially-personal": {
Expand All @@ -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"
]
}
}
},
Expand Down
30 changes: 30 additions & 0 deletions sap-schemas/v2.0/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,9 @@ Constraints:
- `sap:UserID`
- `sap:EndOfBusinessDate`
- `sap:BlockingDate`
- `sap:IsBlockedIndicator`
- `sap:EndOfRetentionDate`
- `sap:DataCategoryID`

Constraints:

Expand Down Expand Up @@ -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)

@pavelkornev pavelkornev Aug 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Used at: [Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object)
- Used at: [Schema Object](https://spec.openapis.org/oas/v2.0.html#schema-object)

Pay attention at OpenAPI spec version

- 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"
]
}
}
}
}
Comment on lines +661 to +673

@pavelkornev pavelkornev Aug 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a wrong example for OpenAPI v2.0:

  • components -> definitions
  • no schemas nesting

```
17 changes: 15 additions & 2 deletions sap-schemas/v2.0/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1325,7 +1325,9 @@
"sap:UserID",
"sap:EndOfBusinessDate",
"sap:BlockingDate",
"sap:EndOfRetentionDate"
"sap:IsBlockedIndicator",
"sap:EndOfRetentionDate",
"sap:DataCategoryID"
]
},
"x-sap-dpp-is-potentially-personal": {
Expand All @@ -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",
Expand Down
30 changes: 30 additions & 0 deletions sap-schemas/v3.0/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,9 @@ Constraints:
- `sap:UserID`
- `sap:EndOfBusinessDate`
- `sap:BlockingDate`
- `sap:IsBlockedIndicator`
- `sap:EndOfRetentionDate`
- `sap:DataCategoryID`

Constraints:

Expand Down Expand Up @@ -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"
]
}
}
}
}
```
17 changes: 15 additions & 2 deletions sap-schemas/v3.0/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,7 +718,9 @@
"sap:UserID",
"sap:EndOfBusinessDate",
"sap:BlockingDate",
"sap:EndOfRetentionDate"
"sap:IsBlockedIndicator",
"sap:EndOfRetentionDate",
"sap:DataCategoryID"
]
},
"x-sap-dpp-is-potentially-personal": {
Expand All @@ -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",
Expand Down
Loading