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

Update: Fleet.Vehicles to 2.0.0 #514

Merged
merged 13 commits into from
Jan 23, 2024
Merged

Update: Fleet.Vehicles to 2.0.0 #514

merged 13 commits into from
Jan 23, 2024

Conversation

TorstenHirsch
Copy link
Contributor

@TorstenHirsch TorstenHirsch commented Dec 20, 2023 •
edited by agg3fe
Loading

Description

QAX (Catena-X use case quality) decided to set most of the properties to optional and also to streamline the aspect data model.

Added

  • metaInformation property added to root entity
  • integration of the shared UUID characteristic and RegEx for the vehicle Catena-X identifie
  • Introducing new characteristic for unique identifiers
  • integration of separate aspect model Vehicle.ProductDescription:3.0.0 into this model to do necessary adaptions that were decided in Catena-X Quality use case team: Most of the properties should be set to optional
  • meta data entity: Gives data consumer necessary information how data provider created this data set

Changed

  • changed all properties to optional except one unique identifier per entity
  • properties that were linked to OEM entity are now one level up
  • fuel type property now linked to engine property
  • entity production was renamed to productionPlant to increase clarity

Removed

  • link to Vehicle.ProductDescription:3.0.0: Previous linked model now integrated and adapted
    Streamlining of aspect model:
  • remove of body entity + body properties as it was never used
  • remove of all KBA properties: Focusing on NHTSA properties only
  • remove of oem entity: Properties now located on vehicle level
  • remove of fuel entity: Properties now located on vehicle and engines level
  • remove of sale entity: Properties now located on vehicle level
  • remove of production entity: Properties now located on vehicle level

Closes #512

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 GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@TorstenHirsch
Update Vehicles.ttl
7ff896a 
Merging the depended model Vehicle.ProductDescription:3.0.0 into Fleet.Vehicles
Using share UUIDV4 for catenaXVehicleID
Set most of the properties to optional
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@TorstenHirsch
RC1
b4dad35 
This version is RC1; If Catena-X QAX decides to release this version that this version is going to be released
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@TorstenHirsch
Copy link
Contributor Author

@agg3fe modelling_team

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

agg3fe
agg3fe reviewed Jan 19, 2024
View reviewed changes
io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl Outdated

:UniqueID a samm:Characteristic ;
samm:preferredName "unique ID"@en ;
samm:description "This Characteristic describes a property that is truly unque either inside the Company that is providing the data or even in Catena-X dataspace. Only one property in a semantic entity should be a uniqueID. Unique ids can be used to link a data set with other semantic models."@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 unque

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

agg3fe
agg3fe reviewed Jan 19, 2024
View reviewed changes
io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl Outdated

:recordStatus a samm:Property ;
samm:preferredName "Record status"@en ;
samm:description "The record operation enunumeration can be used to realize delta update concept.\nDelta updateupdate concept means:\n- You transfer an initial load of data\n- After the first week only the delta to the initial load is transferred\n\n\nThe record status describes whether this record is:\n- new=>This record is transferred the first time\n- update=> Some properties of this record have changed compared to a previous transfer\n- delete=> This record was transferred in the initial load or in a previous delta update, but is not \nused any more and therefore it should be deleted on data consumer side\n- same=> This record was transferred in the initial load or in a previous delta update"@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 enunumeration, updateupdate , \nused.
please check in other models also if used same description.

agg3fe
agg3fe reviewed Jan 19, 2024
View reviewed changes
io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl Outdated

:MetaCharacteristic a samm:Characteristic ;
samm:preferredName "MetaCharacteristic"@en ;
samm:description "Chracteristic for the meta information."@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 Chracteristic

agg3fe
agg3fe requested changes Jan 19, 2024
View reviewed changes
Copy link
Contributor

@agg3fe agg3fe 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 my comments

@TorstenHirsch
Update Vehicles.ttl
c6bf080 
Fixed findings from review.
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@TorstenHirsch
Copy link
Contributor Author

@agg3fe Please check - I fixed all mentioned findings
modelling_team

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

agg3fe
agg3fe reviewed Jan 19, 2024
View reviewed changes
io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl Outdated

:recordStatus a samm:Property ;
samm:preferredName "Record status"@en ;
samm:description "The record operation enunumeration can be used to realize delta update concept.\nDelta update concept means:\n- You transfer an initial load of data\n- After the first week only the delta to the initial load is transferred\n\n\nThe record status describes whether this record is:\n- new=>This record is transferred the first time\n- update=> Some properties of this record have changed compared to a previous transfer\n- delete=> This record was transferred in the initial load or in a previous delta update, but is not \nused any more and therefore it should be deleted on data consumer side\n- same=> This record was transferred in the initial load or in a previous delta update"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

please fix typo enunumeration. should be enumeration.

Copy link
Contributor

Choose a reason for hiding this comment

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

@TorstenHirsch please fix this typo in this and other model.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed @agg3fe
modelling_team

@agg3fe
Copy link
Contributor

agg3fe commented Jan 19, 2024

@TorstenHirsch please fix one typo, then we are good for MS2.

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@TorstenHirsch TorstenHirsch requested a review from agg3fe January 22, 2024 14:17
agg3fe
agg3fe approved these changes Jan 22, 2024
View reviewed changes
Copy link
Contributor

@agg3fe agg3fe left a comment

Choose a reason for hiding this comment

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

LGTM

@agg3fe agg3fe 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 Jan 22, 2024
@agg3fe
Copy link
Contributor

agg3fe commented Jan 23, 2024

@TorstenHirsch you can update the copyright information in a same way you have done here https://github.com/eclipse-tractusx/sldt-semantic-models/pull/516/files#diff-86e16b0506922dc2f5838d29fbf64889e88904ad8eb64cd762816d9996292a34R2
For BPNS, please refer to this model example https://github.com/eclipse-tractusx/sldt-semantic-models/pull/405/files#diff-8294717bc9be9d276f548ae9f83e2831503589ef17d4d5bf6f1463cdb397d00eR32

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.fleet.vehicles/2.0.0/Vehicles.ttl

Input model is valid

@agg3fe agg3fe merged commit 62cfae3 into eclipse-tractusx:main Jan 23, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agg3fe agg3fe agg3fe 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.

[Model Update]: Update io.catenax.fleet.vehicles to version 2.0.0
2 participants
@TorstenHirsch @agg3fe