Skip to content

Commit 1856e77

Browse files
committed
Remove unnecessary XML documentation and attributes from response DTOs
1 parent 33eb3be commit 1856e77

6 files changed

Lines changed: 1 addition & 74 deletions

File tree

source/AAS.TwinEngine.DataEngine/Api/AasRegistry/Responses/ShellDescriptorDto.cs

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,12 @@
77
using AasCore.Aas3_1;
88

99
namespace AAS.TwinEngine.DataEngine.Api.AasRegistry.Responses;
10-
11-
/// <summary>
12-
/// Descriptor metadata for one Asset Administration Shell.
13-
/// </summary>
1410
public class ShellDescriptorDto
1511
{
16-
/// <summary>
17-
/// Human-readable description texts.
18-
/// </summary>
1912
[JsonPropertyName("description")]
20-
[Description("Localized description entries for the shell descriptor.")]
2113
public IList<LangStringTextType>? Description { get; init; }
2214

23-
/// <summary>
24-
/// Human-readable display names.
25-
/// </summary>
2615
[JsonPropertyName("displayName")]
27-
[Description("Localized display name entries for the shell descriptor.")]
2816
public IList<LangStringNameType>? DisplayName { get; init; }
2917

3018
[JsonPropertyName("extensions")]
@@ -43,16 +31,13 @@ public class ShellDescriptorDto
4331
public IList<EndpointDto>? Endpoints { get; init; }
4432

4533
[JsonPropertyName("globalAssetId")]
46-
[Description("Global asset identifier associated with the shell.")]
4734
[DefaultValue("https://example.com/ids/asset/4711")]
4835
public string? GlobalAssetId { get; set; }
4936

5037
[JsonPropertyName("idShort")]
5138
public string? IdShort { get; set; }
5239

5340
[JsonPropertyName("id")]
54-
[Description("Global shell identifier.")]
55-
[DefaultValue("https://example.com/ids/aas/1170_1160_3052_6568")]
5641
public string? Id { get; set; }
5742

5843
[JsonPropertyName("specificAssetIds")]

source/AAS.TwinEngine.DataEngine/Api/AasRegistry/Responses/ShellDescriptorsDto.cs

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,12 @@
55

66
namespace AAS.TwinEngine.DataEngine.Api.AasRegistry.Responses;
77

8-
/// <summary>
9-
/// Paginated response containing shell descriptors.
10-
/// </summary>
118
public class ShellDescriptorsDto
129
{
13-
/// <summary>
14-
/// Cursor metadata for paginated result retrieval.
15-
/// </summary>
1610
[JsonPropertyName("paging_metadata")]
17-
[Description("Pagination metadata for shell descriptor retrieval.")]
1811
public PagingMetaDataDto? PagingMetaData { get; set; }
1912

20-
/// <summary>
21-
/// Shell descriptor list.
22-
/// </summary>
2313
[JsonPropertyName("result")]
24-
[Description("List of shell descriptors.")]
2514
public IList<ShellDescriptorDto>? Result { get; init; }
2615
}
2716

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,15 @@
11
using System.Text.Json.Nodes;
22
using System.Text.Json.Serialization;
3-
using System.ComponentModel;
43

54
using AAS.TwinEngine.DataEngine.Api.Shared;
65

76
namespace AAS.TwinEngine.DataEngine.Api.AasRepository.Responses;
87

9-
/// <summary>
10-
/// Paginated response containing Asset Administration Shell documents.
11-
/// </summary>
128
public class ShellsDto
139
{
14-
/// <summary>
15-
/// Cursor metadata for paginated result retrieval.
16-
/// </summary>
1710
[JsonPropertyName("paging_metadata")]
18-
[Description("Pagination metadata for shell retrieval.")]
1911
public PagingMetaDataDto? PagingMetaData { get; set; }
2012

21-
/// <summary>
22-
/// Shell documents in JSON form.
23-
/// </summary>
2413
[JsonPropertyName("result")]
25-
[Description("List of AAS JSON documents.")]
2614
public IList<JsonObject>? Result { get; init; }
2715
}
Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,16 @@
11
using System.Text.Json.Serialization;
2-
using System.ComponentModel;
32

43
using AAS.TwinEngine.DataEngine.Api.Shared;
54

65
using AasCore.Aas3_1;
76

87
namespace AAS.TwinEngine.DataEngine.Api.AasRepository.Responses;
98

10-
/// <summary>
11-
/// Paginated response containing submodel references.
12-
/// </summary>
139
public class SubmodelRefDto
1410
{
15-
/// <summary>
16-
/// Cursor metadata for paginated result retrieval.
17-
/// </summary>
1811
[JsonPropertyName("paging_metadata")]
19-
[Description("Pagination metadata for submodel reference retrieval.")]
2012
public PagingMetaDataDto? PagingMetaData { get; set; }
2113

22-
/// <summary>
23-
/// Submodel references linked to the selected shell.
24-
/// </summary>
2514
[JsonPropertyName("result")]
26-
[Description("List of submodel references.")]
2715
public IList<IReference>? Result { get; init; }
2816
}
Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,14 @@
1-
using System.Text.Json.Serialization;
2-
using System.ComponentModel;
1+
using System.Text.Json.Serialization;
32

43
using AAS.TwinEngine.DataEngine.Api.Shared;
54

65
namespace AAS.TwinEngine.DataEngine.Api.Discovery.Responses;
76

8-
/// <summary>
9-
/// Discovery result containing matching AAS identifiers.
10-
/// </summary>
117
public class ShellsByAssetLinkResponseDto
128
{
13-
/// <summary>
14-
/// Cursor metadata for paginated result retrieval.
15-
/// </summary>
169
[JsonPropertyName("paging_metadata")]
17-
[Description("Pagination metadata for continued discovery queries.")]
1810
public PagingMetaDataDto? PagingMetaData { get; set; }
1911

20-
/// <summary>
21-
/// Matching AAS identifiers.
22-
/// </summary>
23-
/// <example>["https://example.com/ids/aas/1170_1160_3052_6568"]</example>
2412
[JsonPropertyName("result")]
25-
[Description("AAS identifiers matching the submitted asset links.")]
2613
public IList<string>? Result { get; set; }
2714
}

source/AAS.TwinEngine.DataEngine/Api/SubmodelRegistry/Responses/SubmodelDescriptorDto.cs

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
11
using System.Text.Json.Serialization;
2-
using System.ComponentModel;
32

43
using AAS.TwinEngine.DataEngine.Api.Shared;
54

65
using AasCore.Aas3_1;
76

87
namespace AAS.TwinEngine.DataEngine.Api.SubmodelRegistry.Responses;
98

10-
/// <summary>
11-
/// Descriptor metadata for one submodel.
12-
/// </summary>
139
public class SubmodelDescriptorDto
1410
{
15-
/// <summary>
16-
/// Human-readable description texts.
17-
/// </summary>
1811
[JsonPropertyName("description")]
19-
[Description("Localized description entries for the submodel descriptor.")]
2012
public IList<LangStringTextType>? Description { get; init; }
2113

2214
[JsonPropertyName("displayName")]
@@ -32,8 +24,6 @@ public class SubmodelDescriptorDto
3224
public string? IdShort { get; set; }
3325

3426
[JsonPropertyName("id")]
35-
[Description("Global submodel identifier.")]
36-
[DefaultValue("https://example.com/ids/submodel/1234")]
3727
public string? Id { get; set; }
3828

3929
[JsonPropertyName("semanticId")]

0 commit comments

Comments
 (0)