Skip to content

Updating DPP annotation description #31

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

Merged
pavelkornev merged 8 commits into from
Nov 18, 2024
Merged

Updating DPP annotation description #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
319f7d3
Updating DPP annotation description
sthesse Oct 21, 2024
eee9526
Update sap-schemas/v2.0/README.md
sthesse Oct 23, 2024
00abf49
Update sap-extensions/extensions.json
sthesse Oct 23, 2024
a02bb0a
Update sap-schemas/v3.0/README.md
sthesse Oct 23, 2024
8bbfff8
shortening description in isPotentialPersonal
sthesse Oct 23, 2024
c6bb05b
Merge branch 'fix/dpp_descriptions' of https://github.com/sthesse/ope…
sthesse Oct 23, 2024
224360c
Merge branch 'main' into fix/dpp_descriptions
pavelkornev Nov 6, 2024
71ffc4a
generating schema
sthesse Nov 6, 2024
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
4 changes: 2 additions & 2 deletions sap-extensions/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@
"x-sap-dpp-is-potentially-personal": {
"type": "boolean",
"default": true,
"description": "Property contains potentially personal data. Properties annotated with x-sap-dpp-field-semantics need not be additionally annotated with this extension."
"description": "Property contains potentially personal data. Properties annotated with x-sap-dpp-field-semantics need not be additionally annotated with this extension. Personal data describes any information which is related to an identified or identifiable natural person (data subject). An identifiable person is one who can be identified, directly or indirectly, in particular by a reference to an identifier such as a name, an identification number, location data, an online identifier, or to one or more factors specific to the physical, physiological, genetic, mental, economic, cultural, or social identity of that natural person."
Copy link
Member

@pavelkornev pavelkornev Nov 6, 2024

Choose a reason for hiding this comment

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

Please generate SAP schemas ! run npm run generate and commit those files to this PR. Thx.

Copy link
Contributor

@ralfhandl ralfhandl Nov 6, 2024

Choose a reason for hiding this comment

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

@pavelkornev How about automating that step with a GitHub action?

Copy link
Member

@pavelkornev pavelkornev Nov 18, 2024

Choose a reason for hiding this comment

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

Yeah, i think we should generate markdown files in general and have just one place where we define things, not 2.

},
"x-sap-dpp-is-potentially-sensitive": {
"type": "boolean",
"default": true,
"description": "Property contains potentially sensitive personal data"
"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."
}
}
},
Expand Down
11 changes: 9 additions & 2 deletions sap-schemas/v2.0/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,7 @@ Constraints:

- Type: `Boolean`
- Used at: [Schema Object](https://spec.openapis.org/oas/v2.0#schema-object)
- Description: Property contains potentially personal data. Properties annotated with `x-sap-dpp-field-semantics` need not be additionally annotated with this extension.
- Description: Property contains potentially personal data. Properties annotated with `x-sap-dpp-field-semantics` need not be additionally annotated with this extension. Personal data describes any information which is related to an identified or identifiable natural person (data subject). An identifiable person is one who can be identified, directly or indirectly, in particular by a reference to an identifier such as a name, an identification number, location data, an online identifier, or to one or more factors specific to the physical, physiological, genetic, mental, economic, cultural, or social identity of that natural person.

Constraints:

Expand All @@ -629,7 +629,14 @@ Constraints:

- Type: `Boolean`
- Used at: [Schema Object](https://spec.openapis.org/oas/v2.0#schema-object)
- Description: Property contains potentially sensitive personal data.
- 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:

- 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.
- Personal data subject to professional secrecy.
- Personal data relating to criminal or administrative offenses.
- Personal data concerning insurances and bank or credit card accounts.

Constraints:

Expand Down
4 changes: 2 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 @@ -1331,12 +1331,12 @@
"x-sap-dpp-is-potentially-personal": {
"type": "boolean",
"default": true,
"description": "Property contains potentially personal data. Properties annotated with x-sap-dpp-field-semantics need not be additionally annotated with this extension."
"description": "Property contains potentially personal data. Properties annotated with x-sap-dpp-field-semantics need not be additionally annotated with this extension. Personal data describes any information which is related to an identified or identifiable natural person (data subject). An identifiable person is one who can be identified, directly or indirectly, in particular by a reference to an identifier such as a name, an identification number, location data, an online identifier, or to one or more factors specific to the physical, physiological, genetic, mental, economic, cultural, or social identity of that natural person."
},
"x-sap-dpp-is-potentially-sensitive": {
"type": "boolean",
"default": true,
"description": "Property contains potentially sensitive personal data"
"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."
},
"x-sap-odm-semantic-key": {
"type": "array",
Expand Down
11 changes: 9 additions & 2 deletions sap-schemas/v3.0/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ Constraints:

- Type: `Boolean`
- Used at: [Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object)
- Description: Property contains potentially personal data. Properties annotated with `x-sap-dpp-field-semantics` need not be additionally annotated with this extension.
- Description: Property contains potentially personal data. Properties annotated with `x-sap-dpp-field-semantics` need not be additionally annotated with this extension. Personal data describes any information which is related to an identified or identifiable natural person (data subject). An identifiable person is one who can be identified, directly or indirectly, in particular by a reference to an identifier such as a name, an identification number, location data, an online identifier, or to one or more factors specific to the physical, physiological, genetic, mental, economic, cultural, or social identity of that natural person.

Constraints:

Expand All @@ -598,7 +598,14 @@ Constraints:

- Type: `Boolean`
- Used at: [Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object)
- Description: Property contains potentially sensitive personal data.
- 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:

- 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.
- Personal data subject to professional secrecy.
- Personal data relating to criminal or administrative offenses.
- Personal data concerning insurances and bank or credit card accounts.

Constraints:

Expand Down
4 changes: 2 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 @@ -724,12 +724,12 @@
"x-sap-dpp-is-potentially-personal": {
"type": "boolean",
"default": true,
"description": "Property contains potentially personal data. Properties annotated with x-sap-dpp-field-semantics need not be additionally annotated with this extension."
"description": "Property contains potentially personal data. Properties annotated with x-sap-dpp-field-semantics need not be additionally annotated with this extension. Personal data describes any information which is related to an identified or identifiable natural person (data subject). An identifiable person is one who can be identified, directly or indirectly, in particular by a reference to an identifier such as a name, an identification number, location data, an online identifier, or to one or more factors specific to the physical, physiological, genetic, mental, economic, cultural, or social identity of that natural person."
},
"x-sap-dpp-is-potentially-sensitive": {
"type": "boolean",
"default": true,
"description": "Property contains potentially sensitive personal data"
"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."
},
"x-sap-odm-semantic-key": {
"type": "array",
Expand Down