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

change example for post code from "68161\\12" to "98765-4321" #276

Merged
merged 2 commits into from
Aug 9, 2023

Conversation

birgitZF
Copy link
Contributor

@birgitZF birgitZF commented Aug 9, 2023

change adress to address

Description

change example for post code from "68161\12" to "98765-4321" and change adress to address

-->

Closes #

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 "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 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"
  • 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'
  • The release date in the Release Note is set to the date of the MS3 approval

@github-actions
Copy link

github-actions bot commented Aug 9, 2023

Validation Report for io.catenax.shared.address_characteristic/3.0.0/AddressAspect.ttl

Syntax error in line 102, column 153: Triples not terminated by DOT

   97:    samm:description "Characteristic of a country belonging to an address"@en ;
   98:    samm:dataType :CountryEntity .
   99: 
  100: :PostCodeCharacteristic a samm-c:SingleEntity ;
  101:    samm:preferredName "PostCode Characteristic"@en ;
->102:    samm:description "Characteristic for defining a postcode which can consist of a type (e.g. \"REGULAR\" for zip codes) and a value (e.g. \"98765-4321"). Model follows the specification of BPDM."@en ;
  103:    samm:dataType :PostCodeEntity .
  104: 
  105: :ThoroughfareEntity a samm:Entity ;
  106:    samm:preferredName "Thoroughfare Entity"@en ;
  107:    samm:description "Entity for a thoroughfare which consists of a type, value and number."@en ;

@github-actions
Copy link

github-actions bot commented Aug 9, 2023

Validation Report for io.catenax.shared.address_characteristic/3.0.0/AddressAspect.ttl

Validation failed:

@bs-jokri
Copy link
Contributor

bs-jokri commented Aug 9, 2023

this PR is an addendum to the PR with some fixes to the writing of the address writing
#267

So no additional Review cycle and MS approvals required

@bs-jokri bs-jokri merged commit 38605f6 into eclipse-tractusx:main Aug 9, 2023
@birgitZF birgitZF deleted the updateAddress branch February 1, 2024 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants