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

[Traceability KIT 24.12] Special Characteristics #1064

Conversation

johannsvarela
Copy link
Contributor

@johannsvarela johannsvarela commented Oct 22, 2024

Description

This PR updates the sections below with new content for special characteristics for the upcoming release 24.12. For detailed information regarding the changes made have a look at the updated changelog file.

  • Business View
  • Development View

Related Issues

Fixes eclipse-tractusx/sig-release#818 / https://github.com/catenax-eV/sig-roadmap/issues/167

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@johannsvarela johannsvarela added the enhancement New feature or request label Oct 22, 2024
@johannsvarela johannsvarela marked this pull request as ready for review October 24, 2024 09:11
@stephanbcbauer
Copy link
Member

@johannsvarela can you please solve the conflicts? @jSchuetz88 , @eckardg coouls you please check conten wize?

Friendly reminder:

  • Initial PR at latest: 15. November
  • Merged at latest: 29. November

@johannsvarela
Copy link
Contributor Author

@jSchuetz88 this PR shouldn't be merged until the corresponding aspect model SpecialCharacteristic.Measurement 1.0.0 (#784) is completed and published.

Since the aspect model is introduced and described in detail for this KIT, the content of this PR must be adapted after the aspect model was finished.

@ndr-brt
Copy link
Contributor

ndr-brt commented Nov 21, 2024

@johannsvarela same as #1028 (comment)

@johannsvarela johannsvarela removed the request for review from a team November 21, 2024 08:12
@eckardg
Copy link
Contributor

eckardg commented Nov 22, 2024

LGTM

Copy link
Member

@jSchuetz88 jSchuetz88 left a comment

Choose a reason for hiding this comment

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

Hi @johannsvarela,

looks good. Only two remarks from my side:

  • please add a note, that special characteristics are not standardized yet
  • please check for the results property (see comment)

Copy link
Member

Choose a reason for hiding this comment

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

Just a side note, but this changelog will most likely lead to a merge conflict with the changelog from the Block Notification PR.

}
```
#### Recommended Pattern (Key Value Pair)
Due to the amount of different characteristics we opted not to require a specific format for the measurement objects contained in the **"results": [ ]** object list. We rather provide a set of format we recommend to use. These recommendations depend on the most common characteristics and their requirements for the results.
Copy link
Member

Choose a reason for hiding this comment

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

In my understanding the result property has been slightly changed with the aspect model (see eclipse-tractusx/sldt-semantic-models#784):

"results": [
{
"identifier": "measurementPoint23",
"description": "This text gives you context to the related measurement to help to put it into the necessary context.",
"unit": "unit:hectopascal",
"value": 12.09,
"measurementTimestamp": "2024-11-22T12:51:38.465+01:00"
}

Copy link
Member

Choose a reason for hiding this comment

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

@LuisRickert as we prepare the new release for Tractus, please check.

@stephanbcbauer
Copy link
Member

Overall PR is release relevant -> model needs to be fixed @LuisRickert, please provide a HOTFIX.
Content checked by @ther3sa , @jSchuetz88 , @stephanbcbauer

Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

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

LGTM , see previous comment

@stephanbcbauer stephanbcbauer merged commit c00a8b5 into eclipse-tractusx:main Dec 3, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[New Model] [R24.12] Traceability KIT: Special Characteristics
5 participants