Skip to content

Commit

Permalink
feat(irs):[#209] Update IRS API Swagger documentation to match AAS 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@dsmf
dsmf committed Nov 14, 2023
1 parent 8d0f467 commit b9da83f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 17 deletions.
4 changes: 3 additions & 1 deletion AUTHORS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@ The following people have contributed to this repository:
- Michael Schlacher, doubleSlash Net-Business GmbH, https://github.com/michaelschlacher2
- Sebastian Bezold, Mercedes Benz AG, https://github.com/SebastianBezold
- Zied Belkhiria, MHP, https://github.com/Zied-Belkhiria-Mhp
- Adam Bugajewski, doubleSlash Net-Business GmbH, https://github.com/ds-ext-abugajewski
- Adam Bugajewski, doubleSlash Net-Business GmbH, https://github.com/ds-ext-abugajewski
- Matthias Fischer, doubleSlash Net-Business GmbH, https://github.com/dsmf

3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- IRS can now check the readiness of external services. Use the new ``management.health.dependencies.enabled`` config entry to determine if external dependencies health checks should be checked (false by default).
- The map of external services healthcheck endpoints can be configured with ``management.health.dependencies.urls`` property, eg. ``service_name: http://service_name_host/health``
- Update IRS API Swagger documentation to match AAS 3.0.0

## [4.0.1] - 2023-11-10
### Changed
Expand Down Expand Up @@ -450,4 +451,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
[1.1.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/v0.9.1...v1.0.0
[0.9.1]: https://github.com/eclipse-tractusx/item-relationship-service/commits/v0.9.1
[0.9.0]: https://github.com/eclipse-tractusx/item-relationship-service/commits/v0.9.0
[0.9.0]: https://github.com/eclipse-tractusx/item-relationship-service/commits/v0.9.0
37 changes: 22 additions & 15 deletions irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiExamples.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,12 @@ private Example createAspectModelsResult() {
.type("BAMM")
.build();
final AspectModel serialPart = AspectModel.builder()
.name("SerialPart")
.urn("urn:bamm:io.catenax.serial_part:1.0.0#SerialPart")
.version("1.0.0")
.status("RELEASED")
.type("BAMM")
.build();
.name("SerialPart")
.urn("urn:bamm:io.catenax.serial_part:1.0.0#SerialPart")
.version("1.0.0")
.status("RELEASED")
.type("BAMM")
.build();

return toExample(AspectModels.builder()
.lastUpdated("2023-02-13T08:18:11.990659500Z")
Expand Down Expand Up @@ -275,8 +275,12 @@ private Example createCompleteEssJobResult() {
.submodel(createEssSubmodel())
.bpn(Bpn.withManufacturerId(EXAMPLE_BPN).updateManufacturerName("AB CD"))
.build();
final NotificationSummary newSummary = new NotificationSummary(
AsyncFetchedItems.builder().running(NO_RUNNING_OR_FAILED_ITEMS).completed(FETCHED_ITEMS_SIZE).failed(NO_RUNNING_OR_FAILED_ITEMS).build(),
final NotificationSummary newSummary = new NotificationSummary(AsyncFetchedItems.builder()
.running(
NO_RUNNING_OR_FAILED_ITEMS)
.completed(FETCHED_ITEMS_SIZE)
.failed(NO_RUNNING_OR_FAILED_ITEMS)
.build(),
FetchedItems.builder().completed(FETCHED_ITEMS_SIZE).failed(NO_RUNNING_OR_FAILED_ITEMS).build(),
SENT_NOTIFICATIONS_SIZE, SENT_NOTIFICATIONS_SIZE);
final Job job = essJobsJobs.getJob().toBuilder().summary(newSummary).build();
Expand Down Expand Up @@ -381,7 +385,7 @@ private AssetAdministrationShellDescriptor createShell() {
.build()))
.globalAssetId("urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9")
.idShort("future concept x")
.id("882fc530-b69b-4707-95f6-5dbc5e9baaa8")
.id("urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8")
.specificAssetIds(List.of(IdentifierKeyValuePair.builder()
.name("engineserialid")
.value("12309481209312")
Expand Down Expand Up @@ -427,12 +431,12 @@ private SubmodelDescriptor createBaseSubmodelDescriptor() {
.language("en")
.text("Provides base vehicle information")
.build()))
.idShort("vehicle base details")
.id("4a738a24-b7d8-4989-9cd6-387772f40565")
.idShort("SingleLevelBomAsPlanned")
.id("urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d")
.semanticId(Reference.builder()
.keys(List.of(SemanticId.builder()
.type("Submodel")
.value("urn:bamm:com.catenax.vehicle:0.1.1")
.type("ExternalReference")
.value("urn:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned")
.build()))
.type("ModelReference")
.build())
Expand All @@ -447,6 +451,10 @@ private Endpoint createEndpoint(final String endpointAddress) {
.href(endpointAddress)
.endpointProtocol("HTTPS")
.endpointProtocolVersion(List.of("1.0"))
.subprotocol("DSP")
.subprotocolBody(
"id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net")
.subprotocolBodyEncoding("plain")
.build())
.build();
}
Expand All @@ -457,8 +465,7 @@ private SubmodelDescriptor createPartSubmodelDescriptor() {
.language("en")
.text("Provides base vehicle information")
.build()))
.idShort("vehicle part details")
.id("dae4d249-6d66-4818-b576-bf52f3b9ae90")
.idShort("vehicle part details").id("urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90")
.semanticId(Reference.builder()
.keys(List.of(SemanticId.builder()
.type("Submodel")
Expand Down

0 comments on commit b9da83f

Please sign in to comment.