Skip to content

Commit cadd7ac

Browse files
martinothamarivarne
martinothamar
and
ivarne
authored
Improve InstanceResponse XML doc (#1232)
* Improve 'InstanceResponse' XML doc * Accept changes to swager documnetation --------- Co-authored-by: Ivar Nesje <[email protected]>
1 parent 451a2b6 commit cadd7ac

File tree

2 files changed

+53
-53
lines changed

2 files changed

+53
-53
lines changed

‎src/Altinn.App.Api/Models/InstanceResponse.cs

+29-29
Original file line numberDiff line numberDiff line change
@@ -12,87 +12,87 @@ namespace Altinn.App.Api.Models;
1212
public sealed class InstanceResponse
1313
{
1414
/// <summary>
15-
/// Gets or sets the unique id of the instance {instanceOwnerId}/{instanceGuid}.
15+
/// The unique id of the instance {instanceOwnerId}/{instanceGuid}.
1616
/// </summary>
1717
public required string Id { get; init; }
1818

1919
/// <summary>
20-
/// Gets or sets the instance owner information.
20+
/// The instance owner information.
2121
/// </summary>
2222
public required InstanceOwnerResponse InstanceOwner { get; init; }
2323

2424
/// <summary>
25-
/// Gets or sets the id of the application this is an instance of, e.g. {org}/{app22}.
25+
/// The id of the application this is an instance of, e.g. {org}/{app22}.
2626
/// </summary>
2727
public required string AppId { get; init; }
2828

2929
/// <summary>
30-
/// Gets or sets application owner identifier, usually a abbreviation of organisation name. All in lower case.
30+
/// Application owner identifier, usually a abbreviation of organisation name. All in lower case.
3131
/// </summary>
3232
public required string Org { get; init; }
3333

3434
/// <summary>
35-
/// Gets or sets a set of URLs to access the instance metadata resource.
35+
/// A set of URLs to access the instance metadata resource.
3636
/// </summary>
3737
public required ResourceLinks SelfLinks { get; init; }
3838

3939
/// <summary>
40-
/// Gets or sets the due date to submit the instance to application owner.
40+
/// The due date to submit the instance to application owner.
4141
/// </summary>
4242
public required DateTime? DueBefore { get; init; }
4343

4444
/// <summary>
45-
/// Gets or sets date and time for when the instance should first become visible for the instance owner.
45+
/// Date and time for when the instance should first become visible for the instance owner.
4646
/// </summary>
4747
public required DateTime? VisibleAfter { get; init; }
4848

4949
/// <summary>
50-
/// Gets or sets an object containing the instance process state.
50+
/// An object containing the instance process state.
5151
/// </summary>
5252
public required ProcessState Process { get; init; }
5353

5454
/// <summary>
55-
/// Gets or sets the type of finished status of the instance.
55+
/// The type of finished status of the instance.
5656
/// </summary>
5757
public required InstanceStatus Status { get; init; }
5858

5959
/// <summary>
60-
/// Gets or sets a list of <see cref="CompleteConfirmation"/> elements.
60+
/// A list of <see cref="CompleteConfirmation"/> elements.
6161
/// </summary>
6262
public required IReadOnlyList<CompleteConfirmation> CompleteConfirmations { get; init; }
6363

6464
/// <summary>
65-
/// Gets or sets a list of data elements associated with the instance
65+
/// A list of data elements associated with the instance
6666
/// </summary>
6767
public required IReadOnlyList<DataElement> Data { get; init; }
6868

6969
/// <summary>
70-
/// Gets or sets the presentation texts for the instance.
70+
/// The presentation texts for the instance.
7171
/// </summary>
7272
public required IReadOnlyDictionary<string, string> PresentationTexts { get; init; }
7373

7474
/// <summary>
75-
/// Gets or sets the data values for the instance.
75+
/// The data values for the instance.
7676
/// </summary>
7777
public required IReadOnlyDictionary<string, string> DataValues { get; init; }
7878

7979
/// <summary>
80-
/// Gets or sets the date and time for when the element was created.
80+
/// The date and time for when the element was created.
8181
/// </summary>
8282
public required DateTime? Created { get; init; }
8383

8484
/// <summary>
85-
/// Gets or sets the id of the user who created this element.
85+
/// The id of the user who created this element.
8686
/// </summary>
8787
public required string CreatedBy { get; init; }
8888

8989
/// <summary>
90-
/// Gets or sets the date and time for when the element was last edited.
90+
/// The date and time for when the element was last edited.
9191
/// </summary>
9292
public required DateTime? LastChanged { get; init; }
9393

9494
/// <summary>
95-
/// Gets or sets the id of the user who last changed this element.
95+
/// The id of the user who last changed this element.
9696
/// </summary>
9797
public required string LastChangedBy { get; init; }
9898

@@ -140,22 +140,22 @@ internal static InstanceResponse From(Instance instance, Party instanceOwnerPart
140140
public sealed class InstanceOwnerResponse
141141
{
142142
/// <summary>
143-
/// Gets or sets the party id of the instance owner (also called instance owner party id).
143+
/// The party id of the instance owner (also called instance owner party id).
144144
/// </summary>
145145
public required string PartyId { get; init; }
146146

147147
/// <summary>
148-
/// Gets or sets person number (national identification number) of the party. Null if the party is not a person.
148+
/// Person number (national identification number) of the party. Null if the party is not a person.
149149
/// </summary>
150150
public required string PersonNumber { get; init; }
151151

152152
/// <summary>
153-
/// Gets or sets the organisation number of the party. Null if the party is not an organisation.
153+
/// The organisation number of the party. Null if the party is not an organisation.
154154
/// </summary>
155155
public required string OrganisationNumber { get; init; }
156156

157157
/// <summary>
158-
/// Gets or sets the username of the party. Null if the party is not self identified.
158+
/// The username of the party. Null if the party is not self identified.
159159
/// </summary>
160160
public required string Username { get; init; }
161161

@@ -171,42 +171,42 @@ public sealed class InstanceOwnerResponse
171171
public sealed class PartyResponse
172172
{
173173
/// <summary>
174-
/// Gets or sets the ID of the party
174+
/// The ID of the party
175175
/// </summary>
176176
public required int PartyId { get; init; }
177177

178178
/// <summary>
179-
/// Gets or sets the UUID of the party
179+
/// The UUID of the party
180180
/// </summary>
181181
public required Guid? PartyUuid { get; init; }
182182

183183
/// <summary>
184-
/// Gets or sets the type of party
184+
/// The type of party
185185
/// </summary>
186186
public required PartyType PartyTypeName { get; init; }
187187

188188
/// <summary>
189-
/// Gets the parties ssn
189+
/// Person number (national identification number) of the party. Null if the party is not a person.
190190
/// </summary>
191191
public required string SSN { get; init; }
192192

193193
/// <summary>
194-
/// Gets the parties org number
194+
/// The organisation number of the party. Null if the party is not an organisation.
195195
/// </summary>
196196
public required string OrgNumber { get; init; }
197197

198198
/// <summary>
199-
/// Gets or sets the UnitType
199+
/// The UnitType
200200
/// </summary>
201201
public required string UnitType { get; init; }
202202

203203
/// <summary>
204-
/// Gets or sets the Name
204+
/// The Name
205205
/// </summary>
206206
public required string Name { get; init; }
207207

208208
/// <summary>
209-
/// Gets or sets the IsDeleted
209+
/// The IsDeleted
210210
/// </summary>
211211
public required bool IsDeleted { get; init; }
212212

‎test/Altinn.App.Api.Tests/OpenApi/OpenApiSpecChangeDetection.SaveJsonSwagger.verified.json

+24-24
Original file line numberDiff line numberDiff line change
@@ -6989,22 +6989,22 @@
69896989
"properties": {
69906990
"partyId": {
69916991
"type": "string",
6992-
"description": "Gets or sets the party id of the instance owner (also called instance owner party id).",
6992+
"description": "The party id of the instance owner (also called instance owner party id).",
69936993
"nullable": true
69946994
},
69956995
"personNumber": {
69966996
"type": "string",
6997-
"description": "Gets or sets person number (national identification number) of the party. Null if the party is not a person.",
6997+
"description": "Person number (national identification number) of the party. Null if the party is not a person.",
69986998
"nullable": true
69996999
},
70007000
"organisationNumber": {
70017001
"type": "string",
7002-
"description": "Gets or sets the organisation number of the party. Null if the party is not an organisation.",
7002+
"description": "The organisation number of the party. Null if the party is not an organisation.",
70037003
"nullable": true
70047004
},
70057005
"username": {
70067006
"type": "string",
7007-
"description": "Gets or sets the username of the party. Null if the party is not self identified.",
7007+
"description": "The username of the party. Null if the party is not self identified.",
70087008
"nullable": true
70097009
},
70107010
"party": {
@@ -7038,34 +7038,34 @@
70387038
"properties": {
70397039
"id": {
70407040
"type": "string",
7041-
"description": "Gets or sets the unique id of the instance {instanceOwnerId}/{instanceGuid}.",
7041+
"description": "The unique id of the instance {instanceOwnerId}/{instanceGuid}.",
70427042
"nullable": true
70437043
},
70447044
"instanceOwner": {
70457045
"$ref": "#/components/schemas/InstanceOwnerResponse"
70467046
},
70477047
"appId": {
70487048
"type": "string",
7049-
"description": "Gets or sets the id of the application this is an instance of, e.g. {org}/{app22}.",
7049+
"description": "The id of the application this is an instance of, e.g. {org}/{app22}.",
70507050
"nullable": true
70517051
},
70527052
"org": {
70537053
"type": "string",
7054-
"description": "Gets or sets application owner identifier, usually a abbreviation of organisation name. All in lower case.",
7054+
"description": "Application owner identifier, usually a abbreviation of organisation name. All in lower case.",
70557055
"nullable": true
70567056
},
70577057
"selfLinks": {
70587058
"$ref": "#/components/schemas/ResourceLinks"
70597059
},
70607060
"dueBefore": {
70617061
"type": "string",
7062-
"description": "Gets or sets the due date to submit the instance to application owner.",
7062+
"description": "The due date to submit the instance to application owner.",
70637063
"format": "date-time",
70647064
"nullable": true
70657065
},
70667066
"visibleAfter": {
70677067
"type": "string",
7068-
"description": "Gets or sets date and time for when the instance should first become visible for the instance owner.",
7068+
"description": "Date and time for when the instance should first become visible for the instance owner.",
70697069
"format": "date-time",
70707070
"nullable": true
70717071
},
@@ -7080,15 +7080,15 @@
70807080
"items": {
70817081
"$ref": "#/components/schemas/CompleteConfirmation"
70827082
},
7083-
"description": "Gets or sets a list of Altinn.Platform.Storage.Interface.Models.CompleteConfirmation elements.",
7083+
"description": "A list of Altinn.Platform.Storage.Interface.Models.CompleteConfirmation elements.",
70847084
"nullable": true
70857085
},
70867086
"data": {
70877087
"type": "array",
70887088
"items": {
70897089
"$ref": "#/components/schemas/DataElement"
70907090
},
7091-
"description": "Gets or sets a list of data elements associated with the instance",
7091+
"description": "A list of data elements associated with the instance",
70927092
"nullable": true
70937093
},
70947094
"presentationTexts": {
@@ -7097,7 +7097,7 @@
70977097
"type": "string",
70987098
"nullable": true
70997099
},
7100-
"description": "Gets or sets the presentation texts for the instance.",
7100+
"description": "The presentation texts for the instance.",
71017101
"nullable": true
71027102
},
71037103
"dataValues": {
@@ -7106,29 +7106,29 @@
71067106
"type": "string",
71077107
"nullable": true
71087108
},
7109-
"description": "Gets or sets the data values for the instance.",
7109+
"description": "The data values for the instance.",
71107110
"nullable": true
71117111
},
71127112
"created": {
71137113
"type": "string",
7114-
"description": "Gets or sets the date and time for when the element was created.",
7114+
"description": "The date and time for when the element was created.",
71157115
"format": "date-time",
71167116
"nullable": true
71177117
},
71187118
"createdBy": {
71197119
"type": "string",
7120-
"description": "Gets or sets the id of the user who created this element.",
7120+
"description": "The id of the user who created this element.",
71217121
"nullable": true
71227122
},
71237123
"lastChanged": {
71247124
"type": "string",
7125-
"description": "Gets or sets the date and time for when the element was last edited.",
7125+
"description": "The date and time for when the element was last edited.",
71267126
"format": "date-time",
71277127
"nullable": true
71287128
},
71297129
"lastChangedBy": {
71307130
"type": "string",
7131-
"description": "Gets or sets the id of the user who last changed this element.",
7131+
"description": "The id of the user who last changed this element.",
71327132
"nullable": true
71337133
}
71347134
},
@@ -7501,12 +7501,12 @@
75017501
"properties": {
75027502
"partyId": {
75037503
"type": "integer",
7504-
"description": "Gets or sets the ID of the party",
7504+
"description": "The ID of the party",
75057505
"format": "int32"
75067506
},
75077507
"partyUuid": {
75087508
"type": "string",
7509-
"description": "Gets or sets the UUID of the party",
7509+
"description": "The UUID of the party",
75107510
"format": "uuid",
75117511
"nullable": true
75127512
},
@@ -7515,27 +7515,27 @@
75157515
},
75167516
"ssn": {
75177517
"type": "string",
7518-
"description": "Gets the parties ssn",
7518+
"description": "Person number (national identification number) of the party. Null if the party is not a person.",
75197519
"nullable": true
75207520
},
75217521
"orgNumber": {
75227522
"type": "string",
7523-
"description": "Gets the parties org number",
7523+
"description": "The organisation number of the party. Null if the party is not an organisation.",
75247524
"nullable": true
75257525
},
75267526
"unitType": {
75277527
"type": "string",
7528-
"description": "Gets or sets the UnitType",
7528+
"description": "The UnitType",
75297529
"nullable": true
75307530
},
75317531
"name": {
75327532
"type": "string",
7533-
"description": "Gets or sets the Name",
7533+
"description": "The Name",
75347534
"nullable": true
75357535
},
75367536
"isDeleted": {
75377537
"type": "boolean",
7538-
"description": "Gets or sets the IsDeleted"
7538+
"description": "The IsDeleted"
75397539
}
75407540
},
75417541
"additionalProperties": false,

0 commit comments

Comments
 (0)