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.

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

Updated data model io.catenax.vehicle.product_description to SAMM:2.0.0 #178

Conversation

TorstenHirsch
Copy link
Contributor

@TorstenHirsch TorstenHirsch commented May 16, 2023

Description

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'

- model updated to SAMM:2.0.0
- entities relinked - see readme.md for details
@TorstenHirsch TorstenHirsch changed the title Updated data model to SAMM:2.0.0 Updated data model io.catenax.vehicle.product_description to SAMM:2.0.0 May 16, 2023
@TorstenHirsch
Copy link
Contributor Author

Modelling_Team

@TorstenHirsch
Copy link
Contributor Author

@bs-jokri Please do a pre-MS2 check :-) Thank you

License header updated
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 fix the encoding issues

Fixed mentioned encoding issues
@TorstenHirsch
Copy link
Contributor Author

@bs-jokri I fixed the encoding - what's the problem with preferred name check? I didn't change anything here -> all preferred names are same like in semantic model version 2.0.0

@TorstenHirsch TorstenHirsch requested a review from bs-jokri May 22, 2023 06:48
@TorstenHirsch
Copy link
Contributor Author

@bs-jokri Could you complete MS2 checks? Thank you

- Checked license header
- Removed some typos
@github-actions
Copy link

Validation Report for io.catenax.vehicle.product_description/3.0.0/ProductDescription.ttl

Validation failed:

Updated copyright notice
@github-actions
Copy link

Validation Report for io.catenax.vehicle.product_description/3.0.0/ProductDescription.ttl

Validation failed:

@TorstenHirsch TorstenHirsch requested a review from catroest June 26, 2023 07:59
Updated copyright section, set release date to today
@TorstenHirsch TorstenHirsch requested a review from catroest June 26, 2023 08:44
@github-actions
Copy link

Validation Report for io.catenax.vehicle.product_description/3.0.0/ProductDescription.ttl

Validation failed:

Copy link
Contributor

@catroest catroest left a comment

Choose a reason for hiding this comment

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

Remarks to change:

  • Preferred names start all with upper case and do preferrably not use shortcuts.
  • All sentences start with upper case, end with a dot and do preferrably not use shortcuts.
  • some missing pieces

if you edit the preferred names watch out for: " no duplicate names or preferredNames within an Aspect (e.g. a Property and the referenced Characteristic should not have the same name)"

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.

My comments are properly addressed, thus good to go

@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Jun 26, 2023
Updated some of the descriptions
@github-actions
Copy link

Validation Report for io.catenax.vehicle.product_description/3.0.0/ProductDescription.ttl

Validation failed:

@TorstenHirsch
Copy link
Contributor Author

#modeling_team

@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
@github-actions
Copy link

github-actions bot commented Jul 3, 2023

Validation Report for io.catenax.vehicle.product_description/3.0.0/ProductDescription.ttl

Validation failed:

@github-actions
Copy link

github-actions bot commented Jul 6, 2023

Validation Report for io.catenax.vehicle.product_description/3.0.0/ProductDescription.ttl

Validation failed:

@github-actions
Copy link

github-actions bot commented Jul 6, 2023

Validation Report for io.catenax.vehicle.product_description/3.0.0/ProductDescription.ttl

Validation failed:

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 merged commit ff653d0 into eclipse-tractusx:main Jul 6, 2023
@TorstenHirsch TorstenHirsch deleted the Issue-176-Update-vehicle.product-description-to-3.0.0 branch November 10, 2023 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

3 participants