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

Update IotSensorDeviceDefinition v.2.0.0 #448

Conversation

Cvetanka-ZF
Copy link
Contributor

@Cvetanka-ZF Cvetanka-ZF commented Nov 13, 2023

Description

-->

  • Converted from BAMM to SAMM.

Closes #428

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

Copy link

Validation Report for io.catenax.iot_sensor_device_definition/2.0.0/IotSensorDeviceDefinition.ttl

Input model is valid

@Cvetanka-ZF
Copy link
Contributor Author

modeling_team

:catenaXId a samm:Property ;
samm:preferredName "Catena-X Identifier"@en ;
samm:description "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace."@en ;
samm:characteristic :CatenaXIdTrait ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Here also you can make use of existing characteristic and don't need to define a new one.
For reference: https://github.com/eclipse-tractusx/sldt-semantic-models/pull/405/files#diff-8294717bc9be9d276f548ae9f83e2831503589ef17d4d5bf6f1463cdb397d00eR45

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Thank you for the hint!

:ownerID a samm:Property ;
samm:preferredName "IoT Sensor Device Owner"@en ;
samm:description "The Catena-X BPNL of the device owner."@en ;
samm:characteristic :OwnerIDCharacteristic ;
Copy link
Contributor

Choose a reason for hiding this comment

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

if BPNL is the only allowed value, You can make use of existing characteristic and don't need to define a new one.
For reference: https://github.com/eclipse-tractusx/sldt-semantic-models/pull/405/files#diff-8294717bc9be9d276f548ae9f83e2831503589ef17d4d5bf6f1463cdb397d00eR104

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Thank you for the hint!

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

Adjusted to use the shared aspects for BPNL and UUID.
Copy link

Validation Report for io.catenax.iot_sensor_device_definition/2.0.0/IotSensorDeviceDefinition.ttl

Input model is valid

@Cvetanka-ZF
Copy link
Contributor Author

please check my comments

@agg3fe requested changes are done.

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 the MS2_Approved Checklist "MS2 Valid Model" is approved. label Nov 16, 2023
@agg3fe
Copy link
Contributor

agg3fe commented Nov 16, 2023

@Cvetanka-ZF Thanks. I have assigned MS2 approval. Finally you can change the date in release notes, so that we can do the MS3 on Monday.

@@ -2,13 +2,18 @@
All notable changes to this model will be documented in this file.

## [Unreleased]
## [2.0.0] - 2023-11-13
Copy link
Contributor

Choose a reason for hiding this comment

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

please change the date to 2023-11-20

Copy link

Validation Report for io.catenax.iot_sensor_device_definition/2.0.0/IotSensorDeviceDefinition.ttl

Input model is valid

@agg3fe agg3fe added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Nov 20, 2023
@agg3fe agg3fe merged commit 243d6d5 into eclipse-tractusx:main Nov 21, 2023
4 checks passed
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]: IotSensorDeviceDefinition
2 participants