Refactor AAS and Submodel repository to use updated query options and improve parameter handling

Author: mm-omdi

example/basyx/aas-env.properties

@@ -7,10 +7,10 @@ basyx.submodelrepository.feature.registryintegration=http://sm-template-registry
 spring.servlet.multipart.max-file-size=128MB
 spring.servlet.multipart.max-request-size=128MB
 basyx.backend=MongoDB
-spring.data.mongodb.host=mongo
-spring.data.mongodb.port=27017
-spring.data.mongodb.database=aasenvironment
-spring.data.mongodb.authentication-database=admin
-spring.data.mongodb.username=mongoAdmin
-spring.data.mongodb.password=mongoPassword
+spring.mongodb.host=mongo
+spring.mongodb.port=27017
+spring.mongodb.database=aasenvironment
+spring.mongodb.authentication-database=admin
+spring.mongodb.username=mongoAdmin
+spring.mongodb.password=mongoPassword
 

example/docker-compose.yml

@@ -145,7 +145,7 @@ services:
       - twinengine-network
 
   template-repository:
-    image: eclipsebasyx/aas-environment:2.0.0-milestone-11
+    image: eclipsebasyx/aas-environment:2.0.0-milestone-15
     container_name: template-repository
     volumes:
       - ./aas:/application/aas
@@ -162,28 +162,28 @@ services:
       - twinengine-network
 
   aas-template-registry:
-    image: eclipsebasyx/aas-registry-log-mongodb:2.0.0-milestone-11
+    image: eclipsebasyx/aas-registry-log-mongodb:2.0.0-milestone-15
     container_name: aas-template-registry
     restart: always
     depends_on:
       - mongo
     environment:
-      - SPRING_DATA_MONGODB_URI=mongodb://mongoAdmin:mongoPassword@mongo:27017
+      - SPRING_MONGODB_URI=mongodb://mongoAdmin:mongoPassword@mongo:27017
     networks:
       - twinengine-network
 
   sm-template-registry:
-    image: eclipsebasyx/submodel-registry-log-mongodb:2.0.0-milestone-11
+    image: eclipsebasyx/submodel-registry-log-mongodb:2.0.0-milestone-15
     container_name: sm-template-registry
     depends_on:
       - mongo
     environment:
-      - SPRING_DATA_MONGODB_URI=mongodb://mongoAdmin:mongoPassword@mongo:27017
+      - SPRING_MONGODB_URI=mongodb://mongoAdmin:mongoPassword@mongo:27017
     networks:
       - twinengine-network
 
   aas-web-ui:
-    image: eclipsebasyx/aas-gui:v2-260526
+    image: eclipsebasyx/aas-gui:v2-260801
     container_name: aas-ui
     volumes:
       - ./logo:/usr/src/app/dist/Logo

source/AAS.TwinEngine.DataEngine/Api/AasRepository/Handler/AasRepositoryHandler.cs

@@ -107,12 +107,13 @@ public Task<ISubmodelElement> GetSubmodelElementByAasIdAsync(GetSubmodelElementB
     {
         var decodedIdShortPath = Uri.UnescapeDataString(request?.IdShortPath ?? string.Empty);
         decodedIdShortPath.ValidateIdShortPath(nameof(request.IdShortPath), logger);
+        var queryOptions = new SubmodelQueryOptions(request?.Level.ToString(), request?.Extent.ToString());
 
         return GetResourceByIdAsync(
             request?.AasIdentifier,
             request?.SubmodelId,
             "submodel element By AasID",
-            async (aasId, submodelId) => await aasRepositoryService.GetSubmodelElementByAasIdAsync(aasId, submodelId, decodedIdShortPath, cancellationToken).ConfigureAwait(false));
+            async (aasId, submodelId) => await aasRepositoryService.GetSubmodelElementByAasIdAsync(aasId, submodelId, decodedIdShortPath, queryOptions, cancellationToken).ConfigureAwait(false));
     }
 
     public Task<FileAttachmentResult> GetFileByPathByAasIdAsync(GetFileByPathByAasIdRequest request, CancellationToken cancellationToken)

source/AAS.TwinEngine.DataEngine/Api/AasRepository/Requests/GetSubmodelElementByAasRequest.cs

@@ -2,4 +2,4 @@
 
 namespace AAS.TwinEngine.DataEngine.Api.AasRepository.Requests;
 
-public record GetSubmodelElementByAasRequest(string AasIdentifier, string SubmodelId, string IdShortPath, Level level, Extent extent);
+public record GetSubmodelElementByAasRequest(string AasIdentifier, string SubmodelId, string IdShortPath, Level Level, Extent Extent);

source/AAS.TwinEngine.DataEngine/Api/SubmodelRepository/Handler/SubmodelRepositoryHandler.cs

@@ -17,10 +17,10 @@ public class SubmodelRepositoryHandler(
 {
     public Task<ISubmodel> GetSubmodel(GetSubmodelRequest request, CancellationToken cancellationToken)
     {
-        var queryOptions = request?.Level is not null || request?.Extent is not null ? new SubmodelQueryOptions(request.Level?.ToString(), request.Extent?.ToString()) : null;
+        var queryOptions = request?.level is not null || request?.extent is not null ? new SubmodelQueryOptions(request.level?.ToString(), request.extent?.ToString()) : null;
 
         return GetResourceByIdAsync(
-            request?.SubmodelId,
+            request?.submodelId,
             "submodel",
             id => submodelRepositoryService.GetSubmodelAsync(id, queryOptions, cancellationToken)!);
     }
@@ -30,8 +30,8 @@ public Task<ISubmodelElement> GetSubmodelElement(GetSubmodelElementRequest reque
         var decodedIdShortPath = Uri.UnescapeDataString(request?.IdShortPath ?? string.Empty);
         decodedIdShortPath.ValidateIdShortPath(nameof(request.IdShortPath), logger);
 
-        var queryOptions = request?.Level is not null || request?.Extent is not null
-            ? new SubmodelQueryOptions(request.Level?.ToString(), request.Extent?.ToString())
+        var queryOptions = request?.level is not null || request?.extent is not null
+            ? new SubmodelQueryOptions(request.level?.ToString(), request.extent?.ToString())
             : null;
 
         return GetResourceByIdAsync(

source/AAS.TwinEngine.DataEngine/Api/SubmodelRepository/Requests/GetSubmodelElementRequest.cs

@@ -1,8 +1,3 @@
 namespace AAS.TwinEngine.DataEngine.Api.SubmodelRepository.Requests;
 
-public record GetSubmodelElementRequest(string SubmodelId, string IdShortPath)
-{
-    public Level? Level { get; set; }
-
-    public Extent? Extent { get; set; }
-}
+public record GetSubmodelElementRequest(string SubmodelId, string IdShortPath, Level? level = Level.deep, Extent? extent = Extent.withoutBlobValue);

source/AAS.TwinEngine.DataEngine/Api/SubmodelRepository/Requests/GetSubmodelRequest.cs

@@ -1,10 +1,3 @@
 namespace AAS.TwinEngine.DataEngine.Api.SubmodelRepository.Requests;
 
-public record GetSubmodelRequest(string submodelId)
-{
-    public string SubmodelId { get; } = submodelId;
-
-    public Level? Level { get; set; }
-
-    public Extent? Extent { get; set; }
-}
+public record GetSubmodelRequest(string submodelId, Level? level = Level.deep, Extent? extent = Extent.withoutBlobValue);

source/AAS.TwinEngine.DataEngine/Api/SubmodelRepository/SubmodelRepositoryController.cs

@@ -34,8 +34,8 @@ public class SubmodelRepositoryController(
     /// <param name="idShort">The Asset Administration Shell's IdShort.</param>
     /// <param name="limit">The maximum number of elements in the response array.</param>
     /// <param name="cursor">A server-generated identifier retrieved from pagingMetadata.</param>
-    /// <param name="level">Determines the structural depth of the returned content. Accepted values: <c>deep</c>, <c>core</c>.</param>
-    /// <param name="extent">Determines the serialization of the returned content. Accepted values: <c>withBlobValue</c>, <c>withoutBlobValue</c>.</param>
+    /// <param name="level">Determines the structural depth of the returned content.</param>
+    /// <param name="extent">Determines the serialization of the returned content.</param>
     /// <response code="200">Returns the requested Submodels.</response>
     /// <response code="400">Bad Request, e.g. the request parameters or request format are invalid.</response>
     /// <response code="404">Not Found.</response>
@@ -50,9 +50,9 @@ public async Task<ActionResult<SubmodelsDto>> GetAllSubmodelsAsync(
         [FromQuery] string? idShort,
         [FromQuery] int? limit,
         [FromQuery] string? cursor,
-        [FromQuery] Level? level,
-        [FromQuery] Extent? extent,
-        CancellationToken cancellationToken)
+        CancellationToken cancellationToken,
+        [FromQuery] Level level = Level.deep,
+        [FromQuery] Extent extent = Extent.withoutBlobValue)
     {
         logger.LogInformation("Get All Submodels");
 
@@ -77,8 +77,8 @@ public async Task<ActionResult<SubmodelsDto>> GetAllSubmodelsAsync(
     /// Returns a specific Submodel.
     /// </summary>
     /// <param name="submodelIdentifier">The Submodel's unique id (UTF8-BASE64-URL-encoded)</param>
-    /// <param name="level">Determines the structural depth of the returned content. Accepted values: <c>deep</c>, <c>core</c>.</param>
-    /// <param name="extent">Controls how blob values are serialized. Accepted values: <c>withBlobValue</c>, <c>withoutBlobValue</c>.</param>
+    /// <param name="level">Determines the structural depth of the returned content.</param>
+    /// <param name="extent">Controls how blob values are serialized.</param>
     /// <response code="200">Requested Submodel</response>
     /// <response code="400">Bad Request, e.g.the request parameters of the format of the request body is wrong.</response>
     /// <response code="404">Not Found</response>
@@ -95,7 +95,7 @@ public async Task<ActionResult<JsonObject>> GetSubmodelAsync(
         CancellationToken cancellationToken)
     {
         logger.LogInformation("Get Submodel");
-        var request = new GetSubmodelRequest(submodelIdentifier) { Level = level, Extent = extent };
+        var request = new GetSubmodelRequest(submodelIdentifier, level, extent);
         var response = await submodelRepositoryHandler.GetSubmodel(request, cancellationToken).ConfigureAwait(false);
         return Ok(Jsonization.Serialize.ToJsonObject(response));
     }
@@ -106,8 +106,8 @@ public async Task<ActionResult<JsonObject>> GetSubmodelAsync(
     /// <param name="submodelIdentifier">The Submodel's unique id (UTF8-BASE64-URL-encoded)</param>
     /// <param name="limit">The maximum number of elements in the response array.</param>
     /// <param name="cursor">A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue.</param>
-    /// <param name="level">Determines the structural depth of the returned content. Accepted values: <c>deep</c>, <c>core</c>.</param>
-    /// <param name="extent">Determines the serialization of the returned content. Accepted values: <c>withBlobValue</c>, <c>withoutBlobValue</c>.</param>
+    /// <param name="level">Determines the structural depth of the returned content.</param>
+    /// <param name="extent">Determines the serialization of the returned content.</param>
     /// <response code="200">List of found submodel elements</response>
     /// <response code="400">Bad Request, e.g. the request parameters or request format are invalid.</response>
     /// <response code="404">Not Found</response>
@@ -121,9 +121,10 @@ public async Task<ActionResult<SubmodelElementsDto>> GetAllSubmodelElementsAsync
         [FromRoute] string submodelIdentifier,
         [FromQuery] int? limit,
         [FromQuery] string? cursor,
-        [FromQuery] Level? level,
-        [FromQuery] Extent? extent,
-        CancellationToken cancellationToken)
+        CancellationToken cancellationToken,
+        [FromQuery] Level level = Level.deep,
+        [FromQuery] Extent extent = Extent.withoutBlobValue
+        )
     {
         logger.LogInformation("Get All Submodel Elements");
         var request = new GetAllSubmodelElementsRequest(submodelIdentifier, limit, cursor, level, extent);
@@ -136,8 +137,8 @@ public async Task<ActionResult<SubmodelElementsDto>> GetAllSubmodelElementsAsync
     /// </summary>
     /// <param name="submodelIdentifier">The Submodel's unique id (UTF8-BASE64-URL-encoded)</param>
     /// <param name="idShortPath">The IdShort path to the submodel element (dot-separated)</param>
-    /// <param name="level">Determines the structural depth of the returned content. Accepted values: <c>deep</c>, <c>core</c>.</param>
-    /// <param name="extent">Controls how blob values are serialized. Accepted values: <c>withBlobValue</c>, <c>withoutBlobValue</c>.</param>
+    /// <param name="level">Determines the structural depth of the returned content.</param>
+    /// <param name="extent">Controls how blob values are serialized.</param>
     /// <response code="200">Requested submodel element</response>
     /// <response code="400">Bad Request, e.g.the request parameters of the format of the request body is wrong.</response>
     /// <response code="404">Not Found</response>
@@ -155,7 +156,7 @@ public async Task<ActionResult<JsonObject>> GetSubmodelElementAsync(
         CancellationToken cancellationToken)
     {
         logger.LogInformation("Get Submodel Element");
-        var request = new GetSubmodelElementRequest(submodelIdentifier, idShortPath) { Level = level, Extent = extent };
+        var request = new GetSubmodelElementRequest(submodelIdentifier, idShortPath, level, extent);
         var response = await submodelRepositoryHandler.GetSubmodelElement(request, cancellationToken).ConfigureAwait(false);
         return Ok(Jsonization.Serialize.ToJsonObject(response));
     }

source/AAS.TwinEngine.DataEngine/ApplicationLogic/Services/AasRepository/AasRepositoryService.cs

@@ -194,11 +194,11 @@ public async Task<SubmodelElementsPage> GetAllSubmodelElementsByAasIdAsync(strin
         return await submodelRepositoryService.GetAllSubmodelElementsAsync(submodelIdentifier, queryOptions, limit, cursor, cancellationToken).ConfigureAwait(false);
     }
 
-    public async Task<ISubmodelElement> GetSubmodelElementByAasIdAsync(string aasIdentifier, string submodelIdentifier, string idShortPath, CancellationToken cancellationToken)
+    public async Task<ISubmodelElement> GetSubmodelElementByAasIdAsync(string aasIdentifier, string submodelIdentifier, string idShortPath, SubmodelQueryOptions? queryOptions, CancellationToken cancellationToken)
     {
         await ValidateSubmodelBelongsToAasAsync(aasIdentifier, submodelIdentifier, cancellationToken).ConfigureAwait(false);
 
-        return await submodelRepositoryService.GetSubmodelElementAsync(submodelIdentifier, idShortPath, null, cancellationToken).ConfigureAwait(false);
+        return await submodelRepositoryService.GetSubmodelElementAsync(submodelIdentifier, idShortPath, queryOptions, cancellationToken).ConfigureAwait(false);
     }
 
     public async Task<FileAttachmentResult> GetFileAttachmentByAasIdAsync(string aasIdentifier, string submodelId, string idShortPath, CancellationToken cancellationToken)

source/AAS.TwinEngine.DataEngine/ApplicationLogic/Services/AasRepository/IAasRepositoryService.cs

@@ -22,7 +22,7 @@ public interface IAasRepositoryService
 
     Task<SubmodelElementsPage> GetAllSubmodelElementsByAasIdAsync(string aasIdentifier, string submodelIdentifier, SubmodelQueryOptions queryOptions, int? limit, string? cursor, CancellationToken cancellationToken);
 
-    Task<ISubmodelElement> GetSubmodelElementByAasIdAsync(string aasIdentifier, string submodelIdentifier, string idShortPath, CancellationToken cancellationToken);
+    Task<ISubmodelElement> GetSubmodelElementByAasIdAsync(string aasIdentifier, string submodelIdentifier, string idShortPath, SubmodelQueryOptions queryOptions, CancellationToken cancellationToken);
 
     Task<FileAttachmentResult> GetFileAttachmentByAasIdAsync(string aasIdentifier, string submodelId, string idShortPath, CancellationToken cancellationToken);