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

Single level usage as planned 1.1.0 #102

Conversation

BenediktMuellerIML
Copy link
Contributor

Description

We need to update this Aspect to include all Part versions and validity (asPlanned) to cover the versioning of components and vehicles.

Added

  • optional validity period for child-parent relation

Changed

  • descriptions to more explicitly describe handling of versions of child parts
  • updated reference for SAMM Unit Catalog to a more stable one
  • all characteristics, entities, and constraints now have proper names, preferred names and descriptions
  • fixed some typos in preferred names and descriptions

-->

Closes #74

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

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'

@BenediktMuellerIML
Copy link
Contributor Author

modeling_team

@ZazraltMagic
Copy link

  • camel case and pascal case is ok
  • release notes and metadata.json ok
  • not all property have examples
  • missing name for :CatenaXIdTraitCharacteristic, :NumberOfObjects, :Quantity, :QuantityCharacteristic, :measurementUnit
  • missing description for :ValidityPeriodCharacteristic
  • pascal case in name 'SingleLevelUsageAsPlanned'

@BenediktMuellerIML
Copy link
Contributor Author

fixed MS2 findings
@ZazraltMagic: please review the changes and apply MS2 label accordingly

@ZazraltMagic
Copy link

@bs-jokri now all good, please approve MS2.

# Copyright (c) 2022 Siemens AG
# Copyright (c) 2022 T-Systems International GmbH
# Copyright (c) 2022 ZF Friedrichshafen AG
# Copyright (c) 2022 Contributors to the Eclipse Foundation
Copy link
Contributor

Choose a reason for hiding this comment

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

update to 2023

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@catroest copyright updated

@jacewski-bosch
Copy link
Contributor

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

MS3 approved please merge @bs-jokri

@bs-jokri bs-jokri added 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 labels Mar 27, 2023
@bs-jokri bs-jokri merged commit 05faf19 into eclipse-tractusx:main Mar 27, 2023
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.

[Model Update]: SingleLevelUsageAsPlanned include versions and validity
5 participants