Merge pull request #353 from bci-oss/update-version-v3.1.0-to-v3

Feat: Changed API Path to V3
eclipse-tractusx · Mar 20, 2024 · d8a7602 · d8a7602
2 parents b75a266 + b759e21
commit d8a7602
Show file tree

Hide file tree

Showing 12 changed files with 93 additions and 92 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,11 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 0.4.1-RC3
+## 0.4.1
 ### Added
 - Added API POST lookup/shellsByAssetLink to retrieve shell ids without base64 encryption.
 - Added v3.1.0 postman collection for new API.
 ## fixed
+- Changed API path from api/v3.0/ to api/v3/
 
 ## 0.4.1-RC2
 ### Added

diff --git a/access-control-service-sql-impl/src/main/resources/static/access-control-openapi.yaml b/access-control-service-sql-impl/src/main/resources/static/access-control-openapi.yaml
@@ -50,9 +50,9 @@ servers:
           - "443"
           - "4243"
       version_prefix:
-        default: v3.0
+        default: v3
         enum:
-          - v3.0
+          - v3
       context_root:
         description: Context root for the API
         default: ""

diff --git a/backend/loadtests/locust/locustfile.py b/backend/loadtests/locust/locustfile.py
@@ -37,22 +37,22 @@ class AasRegistryTask(HttpUser):
     def createAndQueryAasDescriptor(self):
         shell = generate_shell()
         headers = { 'Content-Type' : 'application/json', 'Edc-Bpn' : 'BPN_COMPANY_1'}
-        with self.client.post("/api/v3.0/shell-descriptors", data=json.dumps(shell), headers= headers, catch_response=True) as response:
+        with self.client.post("/api/v3/shell-descriptors", data=json.dumps(shell), headers= headers, catch_response=True) as response:
             if response.status_code != 201:
                 response.failure(f"Expected 201 but status code was {response.status_code}")
                 raise RescheduleTask()
 
         shell_id = shell['id']
         shell_id_encoded = str(base64.urlsafe_b64encode(shell_id.encode("utf-8")), "utf-8")
 
-        with self.client.get(f"/api/v3.0/shell-descriptors/{shell_id_encoded}", name = "/api/v3.0/shell-descriptors/{id}", headers= headers, catch_response=True) as response:
+        with self.client.get(f"/api/v3/shell-descriptors/{shell_id_encoded}", name = "/api/v3/shell-descriptors/{id}", headers= headers, catch_response=True) as response:
             if response.status_code != 200:
                 response.failure(f"Expected 200 but status code was {response.status_code}")
                 raise RescheduleTask()
 
         specificAssetIds = shell['specificAssetIds']
         decodedAssetIds = urllib.parse.quote_plus(json.dumps(specificAssetIds))
-        with self.client.get(f"/api/v3.0/lookup/shells?assetIds={decodedAssetIds}", name = "/api/v3.0/lookup/shells?assetIds={assetIds}", headers= headers, catch_response=True) as response:
+        with self.client.get(f"/api/v3/lookup/shells?assetIds={decodedAssetIds}", name = "/api/v3/lookup/shells?assetIds={assetIds}", headers= headers, catch_response=True) as response:
             if response.status_code != 200:
                 response.failure(f"Expected 200 but status code was {response.status_code}")
                 raise RescheduleTask()

diff --git a/backend/src/main/resources/static/aas-registry-openapi.yaml b/backend/src/main/resources/static/aas-registry-openapi.yaml
@@ -53,9 +53,9 @@ servers:
           - "443"
           - "4243"
       version_prefix:
-        default: v3.0
+        default: v3
         enum:
-          - v3.0
+          - v3
       context_root:
         description: Context root for the API
         default: ""

diff --git a/...est/java/org/eclipse/tractusx/semantics/registry/AbstractAssetAdministrationShellApi.java b/...est/java/org/eclipse/tractusx/semantics/registry/AbstractAssetAdministrationShellApi.java
@@ -46,13 +46,13 @@
 @EnableConfigurationProperties( RegistryProperties.class)
 public abstract class AbstractAssetAdministrationShellApi {
 
-    protected static final String SHELL_BASE_PATH = "/api/v3.0/shell-descriptors";
-    protected static final String SINGLE_SHELL_BASE_PATH = "/api/v3.0/shell-descriptors/{aasIdentifier}";
-    protected static final String LOOKUP_SHELL_BASE_PATH = "/api/v3.0/lookup/shells";
-    protected static final String LOOKUP_SHELL_BASE_PATH_POST = "/api/v3.0/lookup/shellsByAssetLink";
-    protected static final String SINGLE_LOOKUP_SHELL_BASE_PATH = "/api/v3.0/lookup/shells/{aasIdentifier}";
-    protected static final String SUB_MODEL_BASE_PATH = "/api/v3.0/shell-descriptors/{aasIdentifier}/submodel-descriptors";
-    protected static final String SINGLE_SUB_MODEL_BASE_PATH = "/api/v3.0/shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}";
+    protected static final String SHELL_BASE_PATH = "/api/v3/shell-descriptors";
+    protected static final String SINGLE_SHELL_BASE_PATH = "/api/v3/shell-descriptors/{aasIdentifier}";
+    protected static final String LOOKUP_SHELL_BASE_PATH = "/api/v3/lookup/shells";
+    protected static final String LOOKUP_SHELL_BASE_PATH_POST = "/api/v3/lookup/shellsByAssetLink";
+    protected static final String SINGLE_LOOKUP_SHELL_BASE_PATH = "/api/v3/lookup/shells/{aasIdentifier}";
+    protected static final String SUB_MODEL_BASE_PATH = "/api/v3/shell-descriptors/{aasIdentifier}/submodel-descriptors";
+    protected static final String SINGLE_SUB_MODEL_BASE_PATH = "/api/v3/shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}";
 
     protected static final String EXTERNAL_SUBJECT_ID_HEADER = "Edc-Bpn";
 

diff --git a/...java/org/eclipse/tractusx/semantics/registry/AssetAdministrationShellApiSecurityTest.java b/...java/org/eclipse/tractusx/semantics/registry/AssetAdministrationShellApiSecurityTest.java
@@ -1276,7 +1276,7 @@ class DescriptionApiTest {
       public void testGetDescriptionOnlyDeleteRoleExpectForbidden() throws Exception {
          mvc.perform(
                      MockMvcRequestBuilders
-                           .get( "/api/v3.0/description" )
+                           .get( "/api/v3/description" )
                            .accept( MediaType.APPLICATION_JSON )
                            .with( jwtTokenFactory.deleteTwin() )
                )
@@ -1288,7 +1288,7 @@ public void testGetDescriptionOnlyDeleteRoleExpectForbidden() throws Exception {
       public void testGetDescriptionNoRoleExpectForbidden() throws Exception {
          mvc.perform(
                      MockMvcRequestBuilders
-                           .get( "/api/v3.0/description" )
+                           .get( "/api/v3/description" )
                            .accept( MediaType.APPLICATION_JSON )
                            .with( jwtTokenFactory.withoutRoles() )
                )
@@ -1300,7 +1300,7 @@ public void testGetDescriptionNoRoleExpectForbidden() throws Exception {
       public void testGetDescriptionReadRoleExpectSuccess() throws Exception {
          mvc.perform(
                      MockMvcRequestBuilders
-                           .get( "/api/v3.0/description" )
+                           .get( "/api/v3/description" )
                            .accept( MediaType.APPLICATION_JSON )
                            .with( jwtTokenFactory.readTwin() )
                )
@@ -1312,7 +1312,7 @@ public void testGetDescriptionReadRoleExpectSuccess() throws Exception {
       public void testGetDescriptionReadRoleExpectUnauthorized() throws Exception {
          mvc.perform(
                      MockMvcRequestBuilders
-                           .get( "/api/v3.0/description" )
+                           .get( "/api/v3/description" )
                            .accept( MediaType.APPLICATION_JSON )
                )
                .andDo( MockMvcResultHandlers.print() )

diff --git a/...rc/test/java/org/eclipse/tractusx/semantics/registry/AssetAdministrationShellApiTest.java b/...rc/test/java/org/eclipse/tractusx/semantics/registry/AssetAdministrationShellApiTest.java
@@ -1231,7 +1231,7 @@ class DescriptionApiTest {
       public void testGetDescriptionExpectSuccess() throws Exception {
          mvc.perform(
                      MockMvcRequestBuilders
-                           .get( "/api/v3.0/description" )
+                           .get( "/api/v3/description" )
                            .accept( MediaType.APPLICATION_JSON )
                            .with( jwtTokenFactory.allRoles() )
                )