Skip to content
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

Jump to bottom

[New Model] Digital Product Pass #191

Merged
merged 22 commits into from
Jun 28, 2023
Merged

[New Model] Digital Product Pass #191

merged 22 commits into from
Jun 28, 2023

Conversation

catroest
Copy link
Contributor

@catroest catroest commented Jun 5, 2023 •
edited by bs-jokri
Loading

Description

-->

Closes #183

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the BAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar bamm-cli.jar -i <path-to-aspect-model> -v ). The BAMM CLI is available here and in GitHub
  • use Camel-Case (e.g., "MyModelElement" or "TimeDifferenceGmtId", when in doubt follow https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
  • the identifiers for all model elements start with a capital letter except for properties
  • the identifier for properties starts with a small letter
  • all model elements at least contain the fields "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a Property and the referenced Characteristic should not have the same name)
  • the versioning in the URN follows semantic versioning, where minor version bumps are backwards compatible and major version bumps are not backwards compatible.
  • use abbreviations only when necessary and if these are sufficiently common
  • avoid redundant prefixes in property names (consider adding properties to an enclosing Entity or even adapt the namespace of the model elements, e.g., instead of having two properties DismantlerId and DismantlerName use an Entity Dismantler with the properties name and id or use a URN like io.catenax.dismantler:0.0.1)
  • fields preferredName and description are not the same
  • preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation)
  • name of aspect is singular except if it only has one property which is a Collection, List or Set. In theses cases, the aspect name is plural.
  • units are referenced from the BAMM unit catalog whenever possible
  • use constraints to make known constraints from the use case explicit in the aspect model
  • when relying on external standards, they are referenced through a "see" element
  • all properties with an simple type have an example value
  • metadata.json exists with status "release"
  • file RELEASE_NOTES.md exists and contains entries for proposed model changes
  • all contributors to this model are mentioned in copyright header of model file

MS3 Criteria

(to be filled out by semantic modeling team before merge to main-branch)

  • All required reviewers have approved this PR (see reviewers section)
  • The new aspect (version) will be implemented by at least one data provider
  • The new aspect (version) will be consumed by at least one data consumer
  • There exists valid test data
  • In case of a new (incompatible) major version to an existing version, a migration strategy has been developed
  • The model has at least version '1.0.0'

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Semantic violations were found:

> :data :
  A cycle in the Aspect Model was detected

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Semantic violations were found:

> :data :
  A cycle in the Aspect Model was detected

@matbmoser
Copy link

Looks awesome 👍🏻

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

1 similar comment
@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

1 similar comment
@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

bs-jokri
bs-jokri suggested changes Jun 22, 2023
View reviewed changes
Copy link
Contributor

@bs-jokri bs-jokri left a comment

Choose a reason for hiding this comment

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

please check the two regex examples and fix the whitespaces

io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl Show resolved Hide resolved
io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl Show resolved Hide resolved
io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl Outdated Show resolved Hide resolved
io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl Outdated Show resolved Hide resolved
io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl Outdated Show resolved Hide resolved
io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl Outdated Show resolved Hide resolved
io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl Outdated Show resolved Hide resolved
@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@catroest
Copy link
Contributor Author

the model validates with 2.1.3 cli

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@catroest
changed attributes
aa20313 
from substanceOfConcernTransportation to safetyTransportation
from substanceOfConcernPavkaging to safetyPackaging
@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Jun 26, 2023
@catroest
MS3 approval changes from DPP Team
eb7d597 
- owner renamed to economic operator
- passport renamed to metadata
- economic operator connected with metadata

- sourcing renamed to sources
- same for the attributes/entities/characteristics below

- renamed attribute text to maintenanceDescription

- added attribute substanceId

- added an example to the property description
@catroest
Copy link
Contributor Author

catroest commented Jun 26, 2023 •
edited
Loading

Modeling_Team

MS3 approved from DPP Team

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.digital_product_passport/1.0.0/DigitalProductPassport.ttl

Input model is valid

bs-jokri
bs-jokri approved these changes Jun 26, 2023
View reviewed changes
Copy link
Contributor

@bs-jokri bs-jokri left a comment

Choose a reason for hiding this comment

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

LGTM

@bs-jokri bs-jokri added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Jun 26, 2023
@bs-jokri bs-jokri merged commit 08ce4c1 into eclipse-tractusx:main Jun 28, 2023
@catroest catroest deleted the DigitalProductPass branch July 4, 2023 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bs-jokri bs-jokri bs-jokri approved these changes

Assignees
No one assigned
Labels
MS2_Approved Checklist "MS2 Valid Model" is approved. MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[New Model]: Digital Product Passport
3 participants
@catroest @matbmoser @bs-jokri