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

[New Model] Notification Header 1.0.0 (Shared Aspect Model) #128

Closed
wants to merge 1 commit into from
Closed

[New Model] Notification Header 1.0.0 (Shared Aspect Model) #128

wants to merge 1 commit into from

Conversation

sschul33
Copy link

@sschul33 sschul33 commented Mar 28, 2023 •
edited by bs-jokri
Loading

initial model

Description

-->

Closes #115

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the BAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar bamm-cli.jar -i <path-to-aspect-model> -v ). The BAMM 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 "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a 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 BAMM 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"
  • file RELEASE_NOTES.md exists and contains entries for proposed model changes

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'

@sschul33
Copy link
Author

sschul33 commented Mar 28, 2023 •
edited
Loading

@bs-jokri : Please review
@jacewski-bosch , @BenediktMuellerIML, @DrDanielMetz : FYI

@sschul33
Copy link
Author

sschul33 commented Apr 3, 2023

Modeling_Team

@sschul33 sschul33 changed the title [New Model] Notification Header 1.0.0 [New Model] Notification Header 1.0.0 (Shared Aspect Model) Apr 3, 2023
bs-jokri
bs-jokri suggested changes Apr 20, 2023
View reviewed changes
Copy link
Contributor

@bs-jokri bs-jokri left a comment

Choose a reason for hiding this comment

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

check comments

io.catenax.notification_header/1.0.0/NotificationHeader.ttl

:header a bamm:Property;
bamm:name "header";
bamm:preferredName "header"@en;
Copy link
Contributor

Choose a reason for hiding this comment

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

uppercase

io.catenax.notification_header/1.0.0/NotificationHeader.ttl
bamm:characteristic :BpnCharacteristic;
bamm:exampleValue "BPNL00000003BV4H".
:BpnCharacteristic a bamm:Characteristic;
bamm:name "BpnCharacteristic";
Copy link
Contributor

Choose a reason for hiding this comment

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

pref name and description missing

io.catenax.notification_header/1.0.0/NotificationHeader.ttl
:BpnCharacteristic a bamm:Characteristic;
bamm:name "BpnCharacteristic";
bamm:dataType xsd:string.
:UuidCharacteristic a bamm:Characteristic;
Copy link
Contributor

Choose a reason for hiding this comment

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

description missing

io.catenax.notification_header/1.0.0/NotificationHeader.ttl
bamm:description "ID of the asset in the sender's EDC that receives messages that relate to this one (e.g. response messages to a request message)"@en;
bamm:characteristic :ReplyAssetIdCharacteristic;
bamm:exampleValue "ess-response-asset".
:UrlCharacteristic a bamm:Characteristic;
Copy link
Contributor

Choose a reason for hiding this comment

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

description

io.catenax.notification_header/1.0.0/NotificationHeader.ttl
bamm:name "UrlCharacteristic";
bamm:dataType xsd:string;
bamm:preferredName "Url Characteristic"@en.
:ReplyAssetIdCharacteristic a bamm:Characteristic;
Copy link
Contributor

Choose a reason for hiding this comment

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

description

io.catenax.notification_header/1.0.0/NotificationHeader.ttl
:originalNotificationId a bamm:Property;
bamm:name "originalNotificationId";
bamm:preferredName "originalNotificationId"@en;
bamm:description "a UUID v4 that identifies the message in relation to which this message is sent; MUST be omitted if no such relation exists"@en;
Copy link
Contributor

Choose a reason for hiding this comment

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

start uppercase

io.catenax.notification_header/1.0.0/NotificationHeader.ttl
bamm:exampleValue "70143bcb-9d27-46d2-9180-3ad04f9e4638".
:notificationType a bamm:Property;
bamm:name "notificationType";
bamm:preferredName "notificationType"@en;
Copy link
Contributor

Choose a reason for hiding this comment

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

standard English

io.catenax.notification_header/1.0.0/NotificationHeader.ttl
:notificationType a bamm:Property;
bamm:name "notificationType";
bamm:preferredName "notificationType"@en;
bamm:description "the standardized schema identifier of the message document in the content property"@en;
Copy link
Contributor

Choose a reason for hiding this comment

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

start uppercase

io.catenax.notification_header/1.0.0/NotificationHeader.ttl
bamm:description "the standardized schema identifier of the message document in the content property"@en;
bamm:characteristic :NotificationTypeCharacteristic.
:NotificationTypeCharacteristic a bamm-c:Enumeration;
bamm:name "NotificationTypeCharacteristic";
Copy link
Contributor

Choose a reason for hiding this comment

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

description missing

@bs-jokri bs-jokri mentioned this pull request May 22, 2023
Closed
5 tasks
@dominikoeh dominikoeh mentioned this pull request Jul 5, 2023
Merged
27 tasks
@bs-jokri
Copy link
Contributor

bs-jokri commented Jul 6, 2023

replaced by #227

@bs-jokri bs-jokri closed this Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bs-jokri bs-jokri bs-jokri requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[New Model]: Shared Model for Notification Header
2 participants
@sschul33 @bs-jokri