eclipse-tractusx / item-relationship-service

https://eclipse-tractusx.github.io/item-relationship-service/docs/
Apache License 2.0
7 stars 21 forks source link

Add Versions for requested Semantic Models of IRS API #439

Closed jzbmw closed 6 months ago

jzbmw commented 7 months ago

As PO , I want to be compliant to the versioning initiative of CX , so that we will be downward compatible .

Acceptance Criteria

Hints / Details

Defining the aspect 2.0.0 the minor and patch version is ignored. The version 2.0.0 accepts any version between 2.0.0 and 3.0.0

apects [
      urn:samm:io.catenax.single_level_bom_as_built:2.0.0
]

Out of Scope

ds-ext-kmassalski commented 6 months ago

Agreed on PL with @jzbmw to use full urn with hash, eg: "urn": "urn:bamm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned",

  1. From task - wrong apects [ "urn:bamm:io.catenax.single_level_usage_as_planned:1.1.0" ]
  2. Correct apects [ "urn:bamm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned" ]

Agreed on beheviour: Semantics Hub models: "urn": "urn:bamm:io.catenax.single_level_usage_as_planned:1.0.0#SingleLevelUsageAsPlanned", "urn": "urn:bamm:io.catenax.single_level_usage_as_planned:1.0.1#SingleLevelUsageAsPlanned", "urn": "urn:bamm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned",

1. apects [ "urn:bamm:io.catenax.single_level_usage_as_planned:5.12.0#SingleLevelUsageAsPlanned" ] result => { "statusCode": "BAD_REQUEST", "error": "Aspects did not match the available aspects: '[urn:bamm:io.catenax.single_level_usage_as_planned:5.12.0#SingleLevelUsageAsPlanned]'", "messages": null }

2. apects [ "urn:bamm:io.catenax.single_level_usage_as_planned:1.0.1#SingleLevelUsageAsPlanned" ] result => { Job with submodels: "urn": "urn:bamm:io.catenax.single_level_usage_as_planned:1.0.0#SingleLevelUsageAsPlanned", "urn": "urn:bamm:io.catenax.single_level_usage_as_planned:1.0.1#SingleLevelUsageAsPlanned", "urn": "urn:bamm:io.catenax.single_level_usage_as_planned:1.1.0#SingleLevelUsageAsPlanned", }

dsmf commented 6 months ago

Pull Request: https://github.com/catenax-ng/tx-item-relationship-service/pull/807

ds-ext-kmassalski commented 6 months ago

PR's: https://github.com/catenax-ng/tx-item-relationship-service/pull/807 https://github.com/catenax-ng/tx-item-relationship-service/pull/811

ds-ext-kmassalski commented 6 months ago

the API Documentation has been updated - done the Tests have been updated - done The API has been changed to accept only the urn's which are available - done Add valid example values to API docu ( replace "string") - done FQN is used to define the aspect name - done For detecting version we use the major version under account - done 2.?.? Accepting any minor a patch version of this aspect model - done Update Tavern and Cucumber Tests - done Update documentation arc42, admin manual, etc - done

jzbmw commented 6 months ago

the failing tavern tests will be accepted and checked again with the update of the Testdata to version 1.7.0 Issue was that Semantic Hub was not delivering valid schema files for SLBAB 2.0.0

mkanal commented 6 months ago

the failing tavern tests will be accepted and checked again with the update of the Testdata to version 1.7.0 Issue was that Semantic Hub was not delivering valid schema files for SLBAB 2.0.0