Refactor API controllers and DTOs to remove unnecessary attributes and improve method signatures for better readability

mm-hsh · mm-hsh · commit 0e2a388866e6 · 2026-07-01T14:41:59.000+05:30
diff --git a/source/AAS.TwinEngine.DataEngine/Api/AasRegistry/Responses/ShellDescriptorDto.cs b/source/AAS.TwinEngine.DataEngine/Api/AasRegistry/Responses/ShellDescriptorDto.cs
@@ -1,5 +1,4 @@
 ﻿using System.Text.Json.Serialization;
-using System.ComponentModel;
 
 using AAS.TwinEngine.DataEngine.Api.Shared;
 using AAS.TwinEngine.DataEngine.Api.SubmodelRegistry.Responses;
@@ -31,7 +30,6 @@ public class ShellDescriptorDto
     public IList<EndpointDto>? Endpoints { get; init; }
 
     [JsonPropertyName("globalAssetId")]
-    [DefaultValue("https://example.com/ids/asset/4711")]
     public string? GlobalAssetId { get; set; }
 
     [JsonPropertyName("idShort")]
diff --git a/source/AAS.TwinEngine.DataEngine/Api/AasRegistry/Responses/ShellDescriptorsDto.cs b/source/AAS.TwinEngine.DataEngine/Api/AasRegistry/Responses/ShellDescriptorsDto.cs
@@ -1,5 +1,4 @@
 ﻿using System.Text.Json.Serialization;
-using System.ComponentModel;
 
 using AAS.TwinEngine.DataEngine.Api.Shared;
 
diff --git a/source/AAS.TwinEngine.DataEngine/Api/AasRegistry/ShellDescriptorController.cs b/source/AAS.TwinEngine.DataEngine/Api/AasRegistry/ShellDescriptorController.cs
@@ -38,10 +38,7 @@ public class ShellDescriptorController(
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.NotFound)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
-    public async Task<ActionResult<ShellDescriptorsDto>> GetAllShellDescriptorsAsync(
-        [FromQuery] int? limit,
-        [FromQuery] string? cursor,
-        CancellationToken cancellationToken)
+    public async Task<ActionResult<ShellDescriptorsDto>> GetAllShellDescriptorsAsync([FromQuery] int? limit, [FromQuery] string? cursor, CancellationToken cancellationToken)
     {
         logger.LogInformation("Get All ShellDescriptors");
         var request = new GetShellDescriptorsRequest(limit, cursor);
@@ -63,9 +60,7 @@ public async Task<ActionResult<ShellDescriptorsDto>> GetAllShellDescriptorsAsync
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.NotFound)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
-    public async Task<ActionResult<ShellDescriptorDto>> GetShellDescriptorByIdAsync(
-        [FromRoute, Description("Base64url encoded AAS identifier.")] string aasIdentifier,
-        CancellationToken cancellationToken)
+    public async Task<ActionResult<ShellDescriptorDto>> GetShellDescriptorByIdAsync([FromRoute] string aasIdentifier, CancellationToken cancellationToken)
     {
         logger.LogInformation("Get ShellDescriptor");
         var request = new GetShellDescriptorRequest(aasIdentifier);
diff --git a/source/AAS.TwinEngine.DataEngine/Api/AasRepository/AasRepositoryController.cs b/source/AAS.TwinEngine.DataEngine/Api/AasRepository/AasRepositoryController.cs
@@ -39,10 +39,7 @@ public class AasRepositoryController(
     [ProducesResponseType(typeof(ShellsDto), (int)HttpStatusCode.OK)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
-    public async Task<ActionResult<ShellsDto>> GetShellsByAssetIdAsync(
-        [FromQuery] string[]? assetIds,
-        [FromQuery] int? limit,
-        [FromQuery] string? cursor,
+    public async Task<ActionResult<ShellsDto>> GetShellsByAssetIdAsync([FromQuery] string[]? assetIds, [FromQuery] int? limit, [FromQuery] string? cursor,
         CancellationToken cancellationToken)
     {
         logger.LogInformation("Start request to get shells by asset identifiers");
@@ -64,9 +61,7 @@ public async Task<ActionResult<ShellsDto>> GetShellsByAssetIdAsync(
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.NotFound)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
-    public async Task<ActionResult<JsonObject>> GetShellByIdAsync(
-        [FromRoute] string aasIdentifier,
-        CancellationToken cancellationToken)
+    public async Task<ActionResult<JsonObject>> GetShellByIdAsync([FromRoute] string aasIdentifier, CancellationToken cancellationToken)
     {
         logger.LogInformation("Start request to get shell");
         var request = new GetShellRequest(aasIdentifier);
@@ -88,9 +83,7 @@ public async Task<ActionResult<JsonObject>> GetShellByIdAsync(
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.NotFound)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
-    public async Task<ActionResult<JsonObject>> GetAssetInformationByIdAsync(
-        [FromRoute] string aasIdentifier,
-        CancellationToken cancellationToken)
+    public async Task<ActionResult<JsonObject>> GetAssetInformationByIdAsync([FromRoute] string aasIdentifier, CancellationToken cancellationToken)
     {
         logger.LogInformation("Start request to get asset information");
         var request = new GetAssetInformationRequest(aasIdentifier);
@@ -114,11 +107,7 @@ public async Task<ActionResult<JsonObject>> GetAssetInformationByIdAsync(
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.NotFound)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
-    public async Task<ActionResult<SubmodelRefDto>> GetSubmodelRefByIdAsync(
-        [FromRoute] string aasIdentifier,
-        [FromQuery] int? limit,
-        [FromQuery] string? cursor,
-        CancellationToken cancellationToken)
+    public async Task<ActionResult<JsonObject>> GetSubmodelRefByIdAsync([FromRoute] string aasIdentifier, [FromQuery] int? limit, [FromQuery] string? cursor, CancellationToken cancellationToken)
     {
         logger.LogInformation("Start request to get submodel-refs for shell");
         var request = new GetSubmodelRefRequest(aasIdentifier, limit, cursor);
diff --git a/source/AAS.TwinEngine.DataEngine/Api/Discovery/Requests/AssetLinkDto.cs b/source/AAS.TwinEngine.DataEngine/Api/Discovery/Requests/AssetLinkDto.cs
@@ -4,9 +4,6 @@
 
 namespace AAS.TwinEngine.DataEngine.Api.Discovery.Requests;
 
-/// <summary>
-/// IDTA discovery asset link used to search for matching AAS identifiers.
-/// </summary>
 public class AssetLinkDto
 {
     [JsonPropertyName("name")]
diff --git a/source/AAS.TwinEngine.DataEngine/Api/Shared/PagingMetadataDto.cs b/source/AAS.TwinEngine.DataEngine/Api/Shared/PagingMetadataDto.cs
@@ -1,18 +1,9 @@
 ﻿using System.Text.Json.Serialization;
-using System.ComponentModel;
 
 namespace AAS.TwinEngine.DataEngine.Api.Shared;
 
-/// <summary>
-/// Cursor-based pagination metadata.
-/// </summary>
 public class PagingMetaDataDto
 {
-    /// <summary>
-    /// Opaque cursor token that can be used to request the next page.
-    /// </summary>
-    /// <example>eyJvZmZzZXQiOjEwMH0</example>
     [JsonPropertyName("cursor")]
-    [Description("Opaque cursor token for pagination continuation.")]
     public string? Cursor { get; set; }
 }
diff --git a/source/AAS.TwinEngine.DataEngine/Api/SubmodelRegistry/SubmodelDescriptorController.cs b/source/AAS.TwinEngine.DataEngine/Api/SubmodelRegistry/SubmodelDescriptorController.cs
@@ -37,9 +37,7 @@ public class SubmodelDescriptorController(
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.NotFound)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
-    public async Task<ActionResult<SubmodelDescriptorDto>> GetSubmodelDescriptorByIdAsync(
-        [FromRoute] string submodelIdentifier,
-        CancellationToken cancellationToken)
+    public async Task<ActionResult<SubmodelDescriptorDto>> GetSubmodelDescriptorByIdAsync([FromRoute] string submodelIdentifier, CancellationToken cancellationToken)
     {
         logger.LogInformation("Get Submodel Descriptor");
         var request = new GetSubmodelDescriptorRequest(submodelIdentifier);
diff --git a/source/AAS.TwinEngine.DataEngine/Api/SubmodelRepository/SubmodelRepositoryController.cs b/source/AAS.TwinEngine.DataEngine/Api/SubmodelRepository/SubmodelRepositoryController.cs
@@ -1,5 +1,6 @@
 ﻿using System.ComponentModel;
 using System.Net;
+using System.Text.Json.Nodes;
 
 using AAS.TwinEngine.DataEngine.Api.SubmodelRepository.Handler;
 using AAS.TwinEngine.DataEngine.Api.SubmodelRepository.Requests;
@@ -37,9 +38,7 @@ public class SubmodelRepositoryController(
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.NotFound)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
-    public async Task<ActionResult<Submodel>> GetSubmodelAsync(
-        [FromRoute] string submodelIdentifier,
-        CancellationToken cancellationToken)
+    public async Task<ActionResult<Submodel>> GetSubmodelAsync([FromRoute] string submodelIdentifier, CancellationToken cancellationToken)
     {
         logger.LogInformation("Get Submodel");
         var request = new GetSubmodelRequest(submodelIdentifier);
@@ -61,14 +60,11 @@ public async Task<ActionResult<Submodel>> GetSubmodelAsync(
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.BadRequest)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.NotFound)]
     [ProducesResponseType(typeof(ServiceErrorResponse), (int)HttpStatusCode.InternalServerError)]
-    public async Task<ActionResult<ISubmodelElement>> GetSubmodelElementAsync(
-        [FromRoute] string submodelIdentifier,
-        [FromRoute] string idShortPath,
-        CancellationToken cancellationToken)
+    public async Task<ActionResult<JsonObject>> GetSubmodelElementAsync([FromRoute] string submodelIdentifier, [FromRoute] string idShortPath, CancellationToken cancellationToken)
     {
         logger.LogInformation("Get Submodel Element");
         var request = new GetSubmodelElementRequest(submodelIdentifier, idShortPath);
         var response = await submodelRepositoryHandler.GetSubmodelElement(request, cancellationToken).ConfigureAwait(false);
-        return Ok(response);
+        return Ok(Jsonization.Serialize.ToJsonObject(response));
     }
 }
diff --git a/source/AAS.TwinEngine.Plugin.TestPlugin/AAS.TwinEngine.Plugin.TestPlugin.csproj b/source/AAS.TwinEngine.Plugin.TestPlugin/AAS.TwinEngine.Plugin.TestPlugin.csproj
@@ -4,8 +4,6 @@
 	  <TargetFramework>net10.0</TargetFramework>
 	  <Nullable>enable</Nullable>
 	  <ImplicitUsings>enable</ImplicitUsings>
-	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
-	  <NoWarn>$(NoWarn);1591</NoWarn>
 	  <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
 	  <DockerfileContext>.</DockerfileContext>
       <UserSecretsId>2ba5fa1c-2588-4655-bd1f-bc7cd274eba9</UserSecretsId>

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`using System.Text.Json.Serialization;`
`2`		`-using System.ComponentModel;`
`3`	`2`
`4`	`3`	`using AAS.TwinEngine.DataEngine.Api.Shared;`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,6 @@`
`4`	`4`
`5`	`5`	`namespace AAS.TwinEngine.DataEngine.Api.Discovery.Requests;`
`6`	`6`
`7`		`-/// <summary>`
`8`		`-/// IDTA discovery asset link used to search for matching AAS identifiers.`
`9`		`-/// </summary>`
`10`	`7`	`public class AssetLinkDto`
`11`	`8`	`{`
`12`	`9`	`[JsonPropertyName("name")]`