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

Issue fix 401 #402

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

Conversation

LuisRickert
Copy link
Contributor

@LuisRickert LuisRickert commented Oct 11, 2023

Description

Closes #401
Questions to reviewer:

  • For now we bumped the version to 2.0.1 since we changed the source file
    - alternative just change the Version 2.0.0
  • left the MS 2&3 Checklist, since I'm not sure if it has to be confirmed again.

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the SAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar samm-cli.jar aspect <path-to-aspect-model> validate ). The SAMM 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 "preferred name" and "description" in English language. The description must be comprehensible. It is not required to write full sentences but style should be consistent over the whole model
  • 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 SAMM 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"
  • generated json schema validates against example json payload
  • 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'
  • If a previous model exists, model deprecation has been checked for previous model
  • The release date in the Release Note is set to the date of the MS3 approval

@github-actions
Copy link

Validation Report for io.catenax.single_level_bom_as_specified/2.0.1/SingleLevelBomAsSpecified.ttl

Input model is valid

@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
@prefix : <urn:samm:io.catenax.single_level_bom_as_specified:2.0.0#>.
Copy link
Contributor

Choose a reason for hiding this comment

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

If you want to create new model, then please change the version here to 2.0.1

Copy link

github-actions bot commented Nov 6, 2023

Validation Report for io.catenax.single_level_bom_as_specified/2.0.1/SingleLevelBomAsSpecified.ttl

Input model is valid

samm:preferredName "Manufacturer ID"@en;
samm:description "The ID of the initial issuer of the single level BoMAsSpecified"@en;
samm:characteristic samm-c:Text;
samm:exampleValue "BPNL1234567890LR".
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this the text property where you can store any value or only BPNL number? if only bpnl number, then I would suggest to use shared aspect model, example: https://github.com/eclipse-tractusx/sldt-semantic-models/pull/405/files#diff-8294717bc9be9d276f548ae9f83e2831503589ef17d4d5bf6f1463cdb397d00eR104

samm:description "The ID of the initial issuer of the single level BoMAsSpecified"@en;
samm:characteristic samm-c:Text;
samm:exampleValue "BPNL1234567890LR".
:assetIdTrait a samm-c:Trait;
Copy link
Contributor

Choose a reason for hiding this comment

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

for uuidv4, you can directly make use of shared aspect model. example: https://github.com/eclipse-tractusx/sldt-semantic-models/pull/405/files#diff-8294717bc9be9d276f548ae9f83e2831503589ef17d4d5bf6f1463cdb397d00eR45
and then you can delete your own Characteristic and Uuidv4RegularExpression

samm:dataType :ItemEntity.
:ItemEntity a samm:Entity;
samm:preferredName "Item Entity"@en;
samm:description "Entity encapsulating the properies describing a item"@en;
Copy link
Contributor

Choose a reason for hiding this comment

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

typo properies

@agg3fe
Copy link
Contributor

agg3fe commented Nov 7, 2023

@LuisRickert Could you please check my comments.

@agg3fe
Copy link
Contributor

agg3fe commented Nov 15, 2023

@LuisRickert any updates on this model?

@agg3fe
Copy link
Contributor

agg3fe commented Jan 19, 2024

@LuisRickert is this model ready for MS2 check?

@agg3fe agg3fe added the invalid This doesn't seem right label Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalid This doesn't seem right
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Model Issue]: SingleLevelBoMAsSpecified
2 participants