Merge pull request #10 from catenax-ng/main

API Update - Release 2.0.0

.github/workflows/codeql.yml

@@ -13,10 +13,12 @@ name: "CodeQL code analysis"
 
 on:
  push:
- branches: [ main, master ]
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
  pull_request:
- # The branches below must be a subset of the branches above
- branches: [ main, master ]
+ branches: main
  paths-ignore:
  - '**/*.md'
  - '**/*.txt'
@@ -43,6 +45,12 @@ jobs:
  - name: Checkout repository
  uses: actions/checkout@v3
 
+ - name: Set up JDK 17
+ uses: actions/setup-java@v3
+ with:
+ java-version: '17'
+ distribution: 'temurin'
+
  # Initializes the CodeQL tools for scanning.
  - name: Initialize CodeQL
  uses: github/codeql-action/init@v2

.github/workflows/eclipse-dash.yml

@@ -1,9 +1,17 @@
 name: "Eclipse DASH IP Check"
 
 on:
- workflow_dispatch:
+ workflow_dispatch: # Trigger manually
  push:
-
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
+ pull_request:
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
 
 jobs:
  build:

.github/workflows/helm-chart-release.yaml

@@ -1,10 +1,10 @@
 name: Release Helm Charts
 
 on:
- workflow_dispatch:
+ workflow_dispatch: # Trigger manually
  push:
  branches:
- - "main"
+ - main
  paths:
  - 'charts/**'
 

.github/workflows/irs-build.yml

@@ -1,10 +1,14 @@
 name: IRS build
 
 on:
- workflow_dispatch:
+ workflow_dispatch: # Trigger manually
+ pull_request:
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
  push:
  branches:
- - '**'
+ - main
  tags:
  - '**'
 

.github/workflows/kics.yml

@@ -2,15 +2,17 @@ name: "KICS security and vulnerability scanner"
 
 on:
  push:
- branches: [main, master]
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
  pull_request:
- # The branches below must be a subset of the branches above
- branches: [main, master]
+ branches: main
  paths-ignore:
- - "**/*.md"
- - "**/*.txt"
+ - '**/*.md'
+ - '**/*.txt'
  schedule:
- - cron: "0 0 * * *"
+ - cron: '0 0 * * *' # Once a day
 
 jobs:
  analyze:

.github/workflows/owasp.yml

@@ -2,8 +2,17 @@ name: "OWASP dependency scanner"
 
 on:
  push:
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
+ pull_request:
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
  schedule:
- - cron:  "0 0 * * *"
+ - cron: '0 0 * * *' # Once a day
 
 jobs:
  analyze:

.github/workflows/publish-documentation.yaml

@@ -1,10 +1,10 @@
 name: Publish documentation
 
 on:
- workflow_dispatch:
+ workflow_dispatch: # Trigger manually
  push:
  branches:
- - "main"
+ - main
  paths:
  - 'docs/**'
 

.github/workflows/spotbugs.yml

@@ -2,8 +2,17 @@ name: "Spotbugs bug detection"
 
 on:
  push:
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
+ pull_request:
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
  schedule:
- - cron:  "0 0 * * *"
+ - cron: '0 0 * * *' # Once a day
 
 jobs:
  analyze:

.github/workflows/synch-env-branch.yml

@@ -0,0 +1,26 @@
+name: "Sync main to IRS-Env"
+
+on:
+ push:
+ branches:
+ - main
+
+jobs:
+ sync-branches:
+ name: Sync branches
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ - name: Merge main into catena-x-environments
+ run: |
+ git config user.name github-actions
+ git config user.email github-actions@github.com
+ git fetch --no-tags --progress
+ git checkout --progress -b catena-x-environments origin/catena-x-environments
+ git merge origin/main
+ git push
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tavern.yml

@@ -1,7 +1,7 @@
 name: Tavern IRS API test
 
 on:
- workflow_dispatch:
+ workflow_dispatch: # Trigger manually
  inputs:
  irs-host:
  type: choice
@@ -14,7 +14,7 @@ on:
  global-asset-id:
  type: string
  description: Global Asset ID to use for the tests
- default: 'urn:uuid:cce14502-958a-42e1-8bb7-f4f41a9457d0'
+ default: 'urn:uuid:513d7be8-e7e4-49f4-a22b-8cd31317e454'
  required: true
  schedule:
  - cron: '0 1 * * 1-5' # At 01:00 on every day-of-week from Monday through Friday.
@@ -43,7 +43,7 @@ jobs:
  KEYCLOAK_HOST: ${{ secrets.KEYCLOAK_OAUTH2_CLIENT_TOKEN_URI }}
  KEYCLOAK_CLIENT_ID: ${{ secrets.KEYCLOAK_OAUTH2_CLIENT_ID }}
  KEYCLOAK_CLIENT_SECRET: ${{ secrets.KEYCLOAK_OAUTH2_CLIENT_SECRET }}
- GLOBAL_ASSET_ID: ${{ github.event.inputs.global-asset-id || 'urn:uuid:cce14502-958a-42e1-8bb7-f4f41a9457d0' }}
+ GLOBAL_ASSET_ID: ${{ github.event.inputs.global-asset-id || 'urn:uuid:513d7be8-e7e4-49f4-a22b-8cd31317e454' }}
  run: |
  python -m pytest api-tests/irs-api-tests.tavern.yaml --junitxml=tavern-results.xml
 

.github/workflows/trivy.yml

@@ -4,19 +4,19 @@
 name: "Trivy vulnerability scanner"
 
 on:
+ workflow_dispatch: # Trigger manually
  push:
- branches: [ main, master ]
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
  pull_request:
- # The branches below must be a subset of the branches above
- branches: [ main, master ]
+ branches: main
  paths-ignore:
- - "**/*.md"
- - "**/*.txt"
+ - '**/*.md'
+ - '**/*.txt'
  schedule:
- # Once a day
- - cron: "0 0 * * *"
- workflow_dispatch:
- # Trigger manually
+ - cron: '0 0 * * *' # Once a day
 
 jobs:
  analyze-config:
@@ -34,7 +34,7 @@ jobs:
  uses: aquasecurity/trivy-action@master
  with:
  scan-type: "config"
- # ignore-unfixed: true
+ ignore-unfixed: true
  exit-code: "1"
  hide-progress: false
  format: "sarif"

.github/workflows/veracode.yaml

@@ -1,7 +1,7 @@
 name: Veracode SAST test
 on:
  schedule:
- - cron: "0 0 * * *"
+ - cron: '0 0 * * *' # Once a day
 
 jobs:
  static_analysis:

.github/workflows/xray-cucumber-integration.yaml

@@ -1,7 +1,7 @@
 name: IRS Cucumber Integration test Xray execution
 
 on:
- workflow_dispatch:
+ workflow_dispatch: # Trigger manually
  push:
  branches:
  - 'main'

.github/workflows/xray-cucumber.yaml

@@ -1,8 +1,17 @@
 name: IRS Cucumber Xray execution
 
 on:
- workflow_dispatch:
+ workflow_dispatch: # Trigger manually
  push:
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
+ pull_request:
+ branches: main
+ paths-ignore:
+ - '**/*.md'
+ - '**/*.txt'
 
 jobs:
  build:

CHANGELOG.md

@@ -9,6 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Known knowns
 - PLACEHOLDER REMOVE IF EMPTY: risks that were introduced or discovered in the release and are known but not resolved
 
+## [2.0.0] - 2022-12-09
+### Added
+- Added pagination to GET /irs/jobs endpoint (eg. {{IRS_HOST}}/irs/jobs?page=0&size=10&sort=completedOn,asc)
+
+### Changed
+- IRS API now requires 'view_irs' resource access inside Keycloak JWT token.
+- New 2.0.0 version of IRS API. Main goal was to remove 'job' prefix from attribute names
+ - change 'jobId' to 'id' in GET and POST calls
+ - change 'jobState' to 'state' in GET calls
+ - change 'jobCompleted' to 'completedOn' in GET calls
+ - change 'jobId' to 'id' and 'jobState' to 'state' in callback URI variables
+
 ## [1.6.0] - 2022-11-25
 ### Added
 - EDC client implementation (for negotiation and data exchange)
@@ -115,7 +127,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Unresolved
 - **Select Aspects you need** You are able to select the needed aspects for which you want to collect the correct endpoint information.
 
-[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.6.0...HEAD
+[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.0.0...HEAD
+[2.0.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.6.0...2.0.0
 [1.6.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.5.0...1.6.0
 [1.5.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.4.0...1.5.0
 [1.4.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.3.0...1.4.0