Skip to content

Improve InstanceResponse XML doc #1232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ivarne merged 2 commits into from
Apr 7, 2025
Merged

Improve InstanceResponse XML doc #1232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb00e80
Improve 'InstanceResponse' XML doc
martinothamar Apr 4, 2025
12c8ec8
Accept changes to swager documnetation
ivarne Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions src/Altinn.App.Api/Models/InstanceResponse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,87 +12,87 @@ namespace Altinn.App.Api.Models;
public sealed class InstanceResponse
{
/// <summary>
/// Gets or sets the unique id of the instance {instanceOwnerId}/{instanceGuid}.
/// The unique id of the instance {instanceOwnerId}/{instanceGuid}.
/// </summary>
public required string Id { get; init; }

/// <summary>
/// Gets or sets the instance owner information.
/// The instance owner information.
/// </summary>
public required InstanceOwnerResponse InstanceOwner { get; init; }

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

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

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

/// <summary>
/// Gets or sets the due date to submit the instance to application owner.
/// The due date to submit the instance to application owner.
/// </summary>
public required DateTime? DueBefore { get; init; }

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

/// <summary>
/// Gets or sets an object containing the instance process state.
/// An object containing the instance process state.
/// </summary>
public required ProcessState Process { get; init; }

/// <summary>
/// Gets or sets the type of finished status of the instance.
/// The type of finished status of the instance.
/// </summary>
public required InstanceStatus Status { get; init; }

/// <summary>
/// Gets or sets a list of <see cref="CompleteConfirmation"/> elements.
/// A list of <see cref="CompleteConfirmation"/> elements.
/// </summary>
public required IReadOnlyList<CompleteConfirmation> CompleteConfirmations { get; init; }

/// <summary>
/// Gets or sets a list of data elements associated with the instance
/// A list of data elements associated with the instance
/// </summary>
public required IReadOnlyList<DataElement> Data { get; init; }

/// <summary>
/// Gets or sets the presentation texts for the instance.
/// The presentation texts for the instance.
/// </summary>
public required IReadOnlyDictionary<string, string> PresentationTexts { get; init; }

/// <summary>
/// Gets or sets the data values for the instance.
/// The data values for the instance.
/// </summary>
public required IReadOnlyDictionary<string, string> DataValues { get; init; }

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

/// <summary>
/// Gets or sets the id of the user who created this element.
/// The id of the user who created this element.
/// </summary>
public required string CreatedBy { get; init; }

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

/// <summary>
/// Gets or sets the id of the user who last changed this element.
/// The id of the user who last changed this element.
/// </summary>
public required string LastChangedBy { get; init; }

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

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

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

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

Expand All @@ -171,42 +171,42 @@ public sealed class InstanceOwnerResponse
public sealed class PartyResponse
{
/// <summary>
/// Gets or sets the ID of the party
/// The ID of the party
/// </summary>
public required int PartyId { get; init; }

/// <summary>
/// Gets or sets the UUID of the party
/// The UUID of the party
/// </summary>
public required Guid? PartyUuid { get; init; }

/// <summary>
/// Gets or sets the type of party
/// The type of party
/// </summary>
public required PartyType PartyTypeName { get; init; }

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

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

/// <summary>
/// Gets or sets the UnitType
/// The UnitType
/// </summary>
public required string UnitType { get; init; }

/// <summary>
/// Gets or sets the Name
/// The Name
/// </summary>
public required string Name { get; init; }

/// <summary>
/// Gets or sets the IsDeleted
/// The IsDeleted
/// </summary>
public required bool IsDeleted { get; init; }

Expand Down
48 changes: 24 additions & 24 deletions test/Altinn.App.Api.Tests/OpenApi/OpenApiSpecChangeDetection.SaveJsonSwagger.verified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6989,22 +6989,22 @@
"properties": {
"partyId": {
"type": "string",
"description": "Gets or sets the party id of the instance owner (also called instance owner party id).",
"description": "The party id of the instance owner (also called instance owner party id).",
"nullable": true
},
"personNumber": {
"type": "string",
"description": "Gets or sets person number (national identification number) of the party. Null if the party is not a person.",
"description": "Person number (national identification number) of the party. Null if the party is not a person.",
"nullable": true
},
"organisationNumber": {
"type": "string",
"description": "Gets or sets the organisation number of the party. Null if the party is not an organisation.",
"description": "The organisation number of the party. Null if the party is not an organisation.",
"nullable": true
},
"username": {
"type": "string",
"description": "Gets or sets the username of the party. Null if the party is not self identified.",
"description": "The username of the party. Null if the party is not self identified.",
"nullable": true
},
"party": {
Expand Down Expand Up @@ -7038,34 +7038,34 @@
"properties": {
"id": {
"type": "string",
"description": "Gets or sets the unique id of the instance {instanceOwnerId}/{instanceGuid}.",
"description": "The unique id of the instance {instanceOwnerId}/{instanceGuid}.",
"nullable": true
},
"instanceOwner": {
"$ref": "#/components/schemas/InstanceOwnerResponse"
},
"appId": {
"type": "string",
"description": "Gets or sets the id of the application this is an instance of, e.g. {org}/{app22}.",
"description": "The id of the application this is an instance of, e.g. {org}/{app22}.",
"nullable": true
},
"org": {
"type": "string",
"description": "Gets or sets application owner identifier, usually a abbreviation of organisation name. All in lower case.",
"description": "Application owner identifier, usually a abbreviation of organisation name. All in lower case.",
"nullable": true
},
"selfLinks": {
"$ref": "#/components/schemas/ResourceLinks"
},
"dueBefore": {
"type": "string",
"description": "Gets or sets the due date to submit the instance to application owner.",
"description": "The due date to submit the instance to application owner.",
"format": "date-time",
"nullable": true
},
"visibleAfter": {
"type": "string",
"description": "Gets or sets date and time for when the instance should first become visible for the instance owner.",
"description": "Date and time for when the instance should first become visible for the instance owner.",
"format": "date-time",
"nullable": true
},
Expand All @@ -7080,15 +7080,15 @@
"items": {
"$ref": "#/components/schemas/CompleteConfirmation"
},
"description": "Gets or sets a list of Altinn.Platform.Storage.Interface.Models.CompleteConfirmation elements.",
"description": "A list of Altinn.Platform.Storage.Interface.Models.CompleteConfirmation elements.",
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataElement"
},
"description": "Gets or sets a list of data elements associated with the instance",
"description": "A list of data elements associated with the instance",
"nullable": true
},
"presentationTexts": {
Expand All @@ -7097,7 +7097,7 @@
"type": "string",
"nullable": true
},
"description": "Gets or sets the presentation texts for the instance.",
"description": "The presentation texts for the instance.",
"nullable": true
},
"dataValues": {
Expand All @@ -7106,29 +7106,29 @@
"type": "string",
"nullable": true
},
"description": "Gets or sets the data values for the instance.",
"description": "The data values for the instance.",
"nullable": true
},
"created": {
"type": "string",
"description": "Gets or sets the date and time for when the element was created.",
"description": "The date and time for when the element was created.",
"format": "date-time",
"nullable": true
},
"createdBy": {
"type": "string",
"description": "Gets or sets the id of the user who created this element.",
"description": "The id of the user who created this element.",
"nullable": true
},
"lastChanged": {
"type": "string",
"description": "Gets or sets the date and time for when the element was last edited.",
"description": "The date and time for when the element was last edited.",
"format": "date-time",
"nullable": true
},
"lastChangedBy": {
"type": "string",
"description": "Gets or sets the id of the user who last changed this element.",
"description": "The id of the user who last changed this element.",
"nullable": true
}
},
Expand Down Expand Up @@ -7501,12 +7501,12 @@
"properties": {
"partyId": {
"type": "integer",
"description": "Gets or sets the ID of the party",
"description": "The ID of the party",
"format": "int32"
},
"partyUuid": {
"type": "string",
"description": "Gets or sets the UUID of the party",
"description": "The UUID of the party",
"format": "uuid",
"nullable": true
},
Expand All @@ -7515,27 +7515,27 @@
},
"ssn": {
"type": "string",
"description": "Gets the parties ssn",
"description": "Person number (national identification number) of the party. Null if the party is not a person.",
"nullable": true
},
"orgNumber": {
"type": "string",
"description": "Gets the parties org number",
"description": "The organisation number of the party. Null if the party is not an organisation.",
"nullable": true
},
"unitType": {
"type": "string",
"description": "Gets or sets the UnitType",
"description": "The UnitType",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the Name",
"description": "The Name",
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets the IsDeleted"
"description": "The IsDeleted"
}
},
"additionalProperties": false,
Expand Down
Loading