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

[Model Update] QualityTaskAttachment 2.0.0 #625

Merged
merged 6 commits into from
Feb 21, 2024
Merged

[Model Update] QualityTaskAttachment 2.0.0 #625

merged 6 commits into from
Feb 21, 2024

Conversation

JulianSchererZF
Copy link
Contributor

@JulianSchererZF JulianSchererZF commented Feb 6, 2024 •
edited by agg3fe
Loading

Description

-->

Closes #598

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

@JulianSchererZF JulianSchererZF changed the title [Model Update] QualityTaskAttachment [Model Update] QualityTaskAttachment 2.0.0 Feb 6, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 6, 2024

Validation Report for io.catenax.quality_task_attachment/2.0.0/QualityTaskAttachment.ttl

Input model is valid

agg3fe
agg3fe reviewed Feb 8, 2024
View reviewed changes
io.catenax.quality_task_attachment/2.0.0/QualityTaskAttachment.ttl Outdated
@@ -0,0 +1,172 @@
#######################################################################
# Copyright (c) 2023 Robert Bosch GmbH
Copy link
Contributor

Choose a reason for hiding this comment

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

2023, 2024 required

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added year 2024 as mentioned

agg3fe
agg3fe reviewed Feb 8, 2024
View reviewed changes
io.catenax.quality_task_attachment/2.0.0/QualityTaskAttachment.ttl Outdated
@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.quality_task_attachment:1.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.

version 2.0.0 required here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed version as mentioned

agg3fe
agg3fe reviewed Feb 8, 2024
View reviewed changes
io.catenax.quality_task_attachment/2.0.0/QualityTaskAttachment.ttl Outdated
samm:preferredName "Quality Task ID"@en ;
samm:description "A unique quality task identifier where these list of parts analysis belong to."@en ;
samm:characteristic samm-c:Text ;
samm:exampleValue "BPN-811_2022_000001" .
Copy link
Contributor

Choose a reason for hiding this comment

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

If it is unique ID, do you want to use shared aspect Uuid.tll here?
example:https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.shared.uuid/2.0.0/Uuid.ttl#L35

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Used shared aspect for Uuid in model

agg3fe
agg3fe reviewed Feb 8, 2024
View reviewed changes
io.catenax.quality_task_attachment/2.0.0/QualityTaskAttachment.ttl Outdated
samm:characteristic samm-c:Text ;
samm:exampleValue "/subfolder/Histogramm_data.csv" .

:sizeInKb a samm:Property ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Property and the referenced Characteristic should not have the same name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed naming

agg3fe
agg3fe reviewed Feb 8, 2024
View reviewed changes
io.catenax.quality_task_attachment/2.0.0/QualityTaskAttachment.ttl Outdated
samm:characteristic samm-c:Text ;
samm:exampleValue "semicolon" .

:variables a samm:Property ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Property and the referenced Characteristic should not have the same name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed naming

agg3fe
agg3fe requested changes Feb 8, 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

@agg3fe
Copy link
Contributor

agg3fe commented Feb 16, 2024

@JulianSchererZF could you please resolve the comments.

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task_attachment/2.0.0/QualityTaskAttachment.ttl

Input model is valid

agg3fe
agg3fe approved these changes Feb 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.

LGTM

agg3fe
agg3fe reviewed Feb 19, 2024
View reviewed changes
io.catenax.quality_task_attachment/RELEASE_NOTES.md Outdated
@@ -11,3 +11,13 @@ All notable changes to this model will be documented in this file.
n/a

### Removed

## [2.0.0] - 2024-02-05
Copy link
Contributor

Choose a reason for hiding this comment

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

you can change the date to today's date if you want MS3 today.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, forgot that. Date is changed and I will participate in todays meeting for MS3

@agg3fe agg3fe added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Feb 19, 2024
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task_attachment/2.0.0/QualityTaskAttachment.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 Feb 19, 2024
@agg3fe agg3fe merged commit 20d564b into eclipse-tractusx:main Feb 21, 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 Issue]: QualityTaskAttachment incorrect example value
2 participants
@JulianSchererZF @agg3fe