API documentation, testdata and registry client library

.github/workflows/maven-deploy.yaml

@@ -55,9 +55,6 @@ jobs:
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
 
-      - name: Build with Maven
-        run: mvn package -pl irs-testing,irs-models,irs-common,irs-edc-client,irs-registry-client --batch-mode
-
       # Import GPG Key
       - uses: ./.github/actions/import-gpg-key
         name: "Import GPG Key"
@@ -77,16 +74,19 @@ jobs:
             </servers>
           </settings>" > $HOME/.m2/settings.xml
 
+      - name: Copy License information
+        run: |
+          mkdir -p irs-registry-client/src/main/resources/META-INF/
+          mkdir -p irs-edc-client/src/main/resources/META-INF/
+          mkdir -p irs-models/src/main/resources/META-INF/
+          mkdir -p irs-testing/src/main/resources/META-INF/
+          cp LICENSE NOTICE.md DEPENDENCIES SECURITY.md irs-registry-client/src/main/resources/META-INF/
+          cp LICENSE NOTICE.md DEPENDENCIES SECURITY.md irs-edc-client/src/main/resources/META-INF/
+          cp LICENSE NOTICE.md DEPENDENCIES SECURITY.md irs-models/src/main/resources/META-INF/
+          cp LICENSE NOTICE.md DEPENDENCIES SECURITY.md irs-testing/src/main/resources/META-INF/
+
       # publish snapshots or releases
       - name: Publish version
         run: |-
           VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout -pl irs-registry-client)
-          REPOSITORY_URL="https://oss.sonatype.org/service/local/staging/deploy/maven2/"
-          if [[ $VERSION == *"-SNAPSHOT"* ]]; then
-            echo "Using snapshot repository"
-            REPOSITORY_URL="https://oss.sonatype.org/content/repositories/snapshots"
-          fi
-          echo "Publishing Version $VERSION to Sonatype Repository $REPOSITORY_URL"
-          mvn -s $HOME/.m2/settings.xml --batch-mode gpg:sign-and-deploy-file -Dgpg.passphrase="${{ secrets.ORG_GPG_PASSPHRASE }}" -Durl=$REPOSITORY_URL -DrepositoryId=ossrh -Dfile=irs-registry-client/target/irs-registry-client-$VERSION-jar-with-dependencies.jar -DgroupId=org.eclipse.tractusx.irs -DartifactId=irs-registry-client -Dversion=$VERSION -Dpackaging=jar
-          mvn -s $HOME/.m2/settings.xml --batch-mode gpg:sign-and-deploy-file -Dgpg.passphrase="${{ secrets.ORG_GPG_PASSPHRASE }}" -Durl=$REPOSITORY_URL -DrepositoryId=ossrh -Dfile=irs-registry-client/target/irs-registry-client-$VERSION-sources.jar -Dclassifier=sources -DgroupId=org.eclipse.tractusx.irs -DartifactId=irs-registry-client -Dversion=$VERSION -Dpackaging=jar
-          mvn -s $HOME/.m2/settings.xml --batch-mode gpg:sign-and-deploy-file -Dgpg.passphrase="${{ secrets.ORG_GPG_PASSPHRASE }}" -Durl=$REPOSITORY_URL -DrepositoryId=ossrh -Dfile=irs-registry-client/target/irs-registry-client-$VERSION-javadoc.jar -Dclassifier=javadoc -DgroupId=org.eclipse.tractusx.irs -DartifactId=irs-registry-client -Dversion=$VERSION -Dpackaging=jar
+          mvn clean deploy -s $HOME/.m2/settings.xml --batch-mode -Dgpg.passphrase="${{ secrets.ORG_GPG_PASSPHRASE }}" -Prelease -pl irs-testing,irs-models,irs-edc-client,irs-registry-client -Drevision=$VERSION

DEPENDENCIES

@@ -192,8 +192,8 @@ maven/mavencentral/net.java.dev.jna/jna/5.12.1, Apache-2.0 OR LGPL-2.1-or-later,
 maven/mavencentral/net.javacrumbs.json-unit/json-unit-assertj/2.36.1, Apache-2.0, approved, clearlydefined
 maven/mavencentral/net.javacrumbs.json-unit/json-unit-core/2.36.1, Apache-2.0, approved, clearlydefined
 maven/mavencentral/net.javacrumbs.json-unit/json-unit-json-path/2.36.1, Apache-2.0, approved, clearlydefined
-maven/mavencentral/net.jimblackler.jsonschemafriend/core/0.12.0, None, restricted, #10911
-maven/mavencentral/net.jimblackler.jsonschemafriend/extra/0.12.0, None, restricted, #10910
+maven/mavencentral/net.jimblackler.jsonschemafriend/core/0.12.0, Apache-2.0, approved, #10911
+maven/mavencentral/net.jimblackler.jsonschemafriend/extra/0.12.0, Apache-2.0, approved, #10910
 maven/mavencentral/net.jimblackler/jsonschemafriend/0.12.0, Apache-2.0, approved, #10912
 maven/mavencentral/net.jodah/typetools/0.6.3, Apache-2.0, approved, clearlydefined
 maven/mavencentral/net.minidev/accessors-smart/2.4.11, Apache-2.0, approved, #7515
@@ -300,11 +300,11 @@ maven/mavencentral/org.eclipse.jetty/jetty-webapp/11.0.16, EPL-2.0 OR Apache-2.0
 maven/mavencentral/org.eclipse.jetty/jetty-xml/11.0.16, EPL-2.0 OR Apache-2.0, approved, rt.jetty
 maven/mavencentral/org.eclipse.tractusx.irs/irs-api/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
 maven/mavencentral/org.eclipse.tractusx.irs/irs-common/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
-maven/mavencentral/org.eclipse.tractusx.irs/irs-edc-client/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
-maven/mavencentral/org.eclipse.tractusx.irs/irs-models/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
+maven/mavencentral/org.eclipse.tractusx.irs/irs-edc-client/1.3.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
+maven/mavencentral/org.eclipse.tractusx.irs/irs-models/1.3.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
 maven/mavencentral/org.eclipse.tractusx.irs/irs-policy-store/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
-maven/mavencentral/org.eclipse.tractusx.irs/irs-registry-client/1.3.1, Apache-2.0, approved, automotive.tractusx
-maven/mavencentral/org.eclipse.tractusx.irs/irs-testing/0.0.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
+maven/mavencentral/org.eclipse.tractusx.irs/irs-registry-client/1.3.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
+maven/mavencentral/org.eclipse.tractusx.irs/irs-testing/1.3.2-SNAPSHOT, Apache-2.0, approved, automotive.tractusx
 maven/mavencentral/org.glassfish.hk2.external/aopalliance-repackaged/3.0.4, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish
 maven/mavencentral/org.glassfish.hk2/hk2-api/3.0.4, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish
 maven/mavencentral/org.glassfish.hk2/hk2-locator/3.0.4, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish

docs/src/api/irs-api.yaml

@@ -1525,8 +1525,10 @@ components:
           example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0
         id:
           type: string
+          example: 882fc530-b69b-4707-95f6-5dbc5e9baaa8
         idShort:
           type: string
+          example: future concept x
         specificAssetIds:
           type: array
           items:
@@ -1663,16 +1665,20 @@ components:
       properties:
         manufacturerId:
           type: string
+          example: BPNL00000003AYRE
         manufacturerName:
           type: string
+          example: OEM A
     Constraint:
       type: object
       additionalProperties: false
       properties:
         leftOperand:
           type: string
+          example: string
         operator:
           type: string
+          example: eq
           enum:
             - eq
             - neq
@@ -1691,6 +1697,7 @@ components:
           type: array
           items:
             type: string
+          example: [string]
     Constraints:
       type: object
       additionalProperties: false
@@ -1767,6 +1774,7 @@ components:
       properties:
         interface:
           type: string
+          example: HTTP
         protocolInformation:
           $ref: '#/components/schemas/ProtocolInformation'
     ErrorResponse:
@@ -1862,12 +1870,14 @@ components:
       properties:
         name:
           type: string
+          example: engineserialid
         semanticId:
           $ref: '#/components/schemas/Reference'
         subjectId:
           $ref: '#/components/schemas/Reference'
         value:
           type: string
+          example: "12309481209312"
     Job:
       type: object
       additionalProperties: false
@@ -1876,9 +1886,11 @@ components:
         completedOn:
           type: string
           format: date-time
+          example: 2022-02-03T14:48:54.709Z
         createdOn:
           type: string
           format: date-time
+          example: 2022-02-03T14:48:54.709Z
         exception:
           $ref: '#/components/schemas/JobErrorDetails'
         globalAssetId:
@@ -1891,13 +1903,15 @@ components:
         id:
           type: string
           format: uuid
+          example: e5347c88-a921-11ec-b909-0242ac120002
           description: Id of the job.
           maxLength: 36
           minLength: 36
           pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"
         lastModifiedOn:
           type: string
           format: date-time
+          example: 2022-02-03T14:48:54.709Z
         owner:
           type: string
           description: The IRS api consumer.
@@ -1906,8 +1920,10 @@ components:
         startedOn:
           type: string
           format: date-time
+          example: 2022-02-03T14:48:54.709Z
         state:
           type: string
+          example: COMPLETED
           enum:
             - UNSAVED
             - INITIAL
@@ -1929,16 +1945,19 @@ components:
       properties:
         errorDetail:
           type: string
+          example: Timeout while requesting Digital Registry
           description: Detailed exception information.
           maxLength: 4000
         exception:
           type: string
           description: Exception name.
+          example: IrsTimeoutException
           maxLength: 100
         exceptionDate:
           type: string
           format: date-time
           description: Datetime error occurs.
+          example: 2022-02-03T14:48:54.709Z
     JobHandle:
       type: object
       additionalProperties: false
@@ -1958,8 +1977,10 @@ components:
       properties:
         aspects:
           type: string
+          example: SerialPart
         bomLifecycle:
           type: string
+          example: asBuilt
           description: The lifecycle context in which the child part was assembled
             into the parent part.
           enum:
@@ -1968,23 +1989,29 @@ components:
             - asSpecified
         bpn:
           type: string
+          example: BPNL00000003AYRE
         callbackUrl:
           type: string
+          example: https://hostname.com/callback?id={id}&state={state}
         collectAspects:
           type: boolean
+          example: false
         depth:
           type: integer
           format: int32
+          example: 1
           maximum: 2147483647
           minimum: 0
         direction:
           type: string
+          example: upward
           description: Item graph traversal direction.
           enum:
             - upward
             - downward
         lookupBPNs:
           type: boolean
+          example: false
     JobStatusResult:
       type: object
       additionalProperties: false
@@ -2053,8 +2080,10 @@ components:
       properties:
         language:
           type: string
+          example: en
         text:
           type: string
+          example: The shell for a vehicle
     LinkedItem:
       type: object
       additionalProperties: false
@@ -2065,6 +2094,7 @@ components:
           type: string
           format: date-time
           description: Datetime of assembly.
+          example: 2022-02-03T14:48:54.709Z
         childCatenaXId:
           type: string
           description: CatenaX child global asset id in the format urn:uuid:uuid4.
@@ -2074,10 +2104,12 @@ components:
           pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
         lastModifiedOn:
           type: string
+          example: 2022-02-03T14:48:54.709Z
           format: date-time
           description: Last datetime item was modified.
         lifecycleContext:
           type: string
+          example: asBuilt
           description: The lifecycle context in which the child part was assembled
             into the parent part.
           enum:
@@ -2092,8 +2124,10 @@ components:
       properties:
         datatypeURI:
           type: string
+          example: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece
         lexicalValue:
           type: string
+          example: piece
     PageResult:
       type: object
       additionalProperties: false
@@ -2143,6 +2177,7 @@ components:
       properties:
         action:
           type: string
+          example: ACCESS
           enum:
             - ACCESS
             - USE
@@ -2163,6 +2198,7 @@ components:
             $ref: '#/components/schemas/Permission'
         policyId:
           type: string
+          example: f253718e-a270-4367-901b-9d50d9bd8462
         validUntil:
           type: string
           format: date-time
@@ -2195,11 +2231,14 @@ components:
       additionalProperties: false
       properties:
         href:
+          example: https://edc.data.plane/{path}/submodel
           type: string
         endpointProtocol:
+          example: HTTPS
           type: string
         endpointProtocolVersion:
           type: array
+          example: ["1.0"]
           items:
             type: string
         subprotocol:
@@ -2217,6 +2256,7 @@ components:
           $ref: '#/components/schemas/MeasurementUnit'
         quantityNumber:
           type: number
+          example: 1.0
           format: double
           maximum: 2147483647
           minimum: 0
@@ -2463,8 +2503,10 @@ components:
       properties:
         aspectType:
           type: string
+          example: SingleLevelBomAsBuilt
         bpn:
           type: string
+          example: BPNL00000003AYRE
         catenaXId:
           type: string
           description: CATENA-X global asset id in the format urn:uuid:uuid4.
@@ -2486,8 +2528,10 @@ components:
       properties:
         type:
           type: string
+          example: urn:bamm:com.catenax.vehicle:0.1.1
         value:
           type: string
+          example: Submodel
     Submodel:
       type: object
       additionalProperties: false

irs-api/pom.xml

@@ -25,7 +25,7 @@
         <dependency>
             <groupId>org.eclipse.tractusx.irs</groupId>
             <artifactId>irs-edc-client</artifactId>
-            <version>${revision}</version>
+            <version>${irs-registry-client.version}</version>
         </dependency>
         <dependency>
             <groupId>org.eclipse.tractusx.irs</groupId>
@@ -148,7 +148,7 @@
         <dependency>
             <groupId>org.eclipse.tractusx.irs</groupId>
             <artifactId>irs-models</artifactId>
-            <version>${project.version}</version>
+            <version>${irs-registry-client.version}</version>
         </dependency>
         <dependency>
             <groupId>net.jimblackler</groupId>
@@ -171,7 +171,7 @@
         <dependency>
             <groupId>org.eclipse.tractusx.irs</groupId>
             <artifactId>irs-testing</artifactId>
-            <version>${revision}</version>
+            <version>${irs-registry-client.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>

irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiExamples.java

@@ -30,10 +30,9 @@
 
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.examples.Example;
-import org.eclipse.tractusx.irs.ess.service.NotificationSummary;
 import org.eclipse.tractusx.irs.component.AsyncFetchedItems;
-import org.eclipse.tractusx.irs.component.BatchResponse;
 import org.eclipse.tractusx.irs.component.BatchOrderResponse;
+import org.eclipse.tractusx.irs.component.BatchResponse;
 import org.eclipse.tractusx.irs.component.Bpn;
 import org.eclipse.tractusx.irs.component.FetchedItems;
 import org.eclipse.tractusx.irs.component.GlobalAssetIdentification;
@@ -67,6 +66,7 @@
 import org.eclipse.tractusx.irs.component.enums.ProcessStep;
 import org.eclipse.tractusx.irs.component.enums.ProcessingState;
 import org.eclipse.tractusx.irs.dtos.ErrorResponse;
+import org.eclipse.tractusx.irs.ess.service.NotificationSummary;
 import org.eclipse.tractusx.irs.semanticshub.AspectModel;
 import org.eclipse.tractusx.irs.semanticshub.AspectModels;
 import org.eclipse.tractusx.irs.util.JsonUtil;
@@ -82,8 +82,8 @@
 public class OpenApiExamples {
     private static final ZonedDateTime EXAMPLE_ZONED_DATETIME = ZonedDateTime.parse("2022-02-03T14:48:54.709Z");
     private static final String JOB_ID = "e5347c88-a921-11ec-b909-0242ac120002";
-
-    private static final UUID UUID_ID = UUID.fromString("f253718e-a270-4367-901b-9d50d9bd8462");
+    private static final String EXAMPLE_ID = "f253718e-a270-4367-901b-9d50d9bd8462";
+    private static final UUID UUID_ID = UUID.fromString(EXAMPLE_ID);
     private static final String GLOBAL_ASSET_ID = "urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0";
     private static final String SUBMODEL_IDENTIFICATION = "urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff";
     private static final String JOB_HANDLE_ID_1 = "6c311d29-5753-46d4-b32c-19b918ea93b0";

irs-common/pom.xml

@@ -74,7 +74,7 @@
         <dependency>
             <groupId>org.eclipse.tractusx.irs</groupId>
             <artifactId>irs-testing</artifactId>
-            <version>${revision}</version>
+            <version>${irs-registry-client.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>