Skip to content
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.

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

chore(webapi): Swagger punctuation clean-up #1351

Merged
merged 4 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
140 changes: 70 additions & 70 deletions docs/schema/V1/swagger.verified.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.Common.Content;
public sealed class ContentValueDto
{
/// <summary>
/// A list of localizations for the content
/// A list of localizations for the content.
/// </summary>
public List<LocalizationDto> Value { get; set; } = [];

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.Common.Content;

/// <summary>
/// TODO: Discuss this with the team later. It works for now
/// This class is used to map bewteen the incoming dto object and the internal dialog content structure.
/// This class is used to map between the incoming dto object and the internal dialog content structure.
/// Value needs to be mapped from a list of LocalizationDto in order for merging to work.
/// </summary>
internal sealed class IntermediateDialogContent
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.Common.Content;

/// <summary>
/// TODO: Discuss this with the team later. It works for now
/// This class is used to map bewteen the incoming dto object and the internal transmission content structure.
/// This class is used to map between the incoming dto object and the internal transmission content structure.
/// Value needs to be mapped from a list of LocalizationDto in order for merging to work.
///
/// We might want to consider combining this class with DialogContentInputConverter later.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ public sealed class LocalizationDto
private readonly string _languageCode = null!;

/// <summary>
/// The localized text or URI reference
/// The localized text or URI reference.
/// </summary>
public required string Value { get; init; }

/// <summary>
/// The language code of the localization in ISO 639-1 format
/// The language code of the localization in ISO 639-1 format.
/// </summary>
/// <example>nb</example>
public required string LanguageCode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public sealed class GetDialogTransmissionDto

/// <summary>
/// Flag indicating if the authenticated user is authorized for this transmission. If not, embedded content and
/// the attachments will not be available
/// the attachments will not be available.
/// </summary>
public bool IsAuthorized { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public sealed class SearchDialogTransmissionDto

/// <summary>
/// Flag indicating if the authenticated user is authorized for this transmission. If not, embedded content and
/// the attachments will not be available
/// the attachments will not be available.
/// </summary>
public bool IsAuthorized { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ public sealed class GetDialogDto
public string ServiceResource { get; set; } = null!;

/// <summary>
/// The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)
/// The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType).
/// </summary>
public string ServiceResourceType { get; set; } = null!;

/// <summary>
/// The party code representing the organization or person that the dialog belongs to in URN format
/// The party code representing the organization or person that the dialog belongs to in URN format.
/// </summary>
/// <example>
/// urn:altinn:person:identifier-no:01125512345
Expand All @@ -59,7 +59,7 @@ public sealed class GetDialogDto
public int? Progress { get; set; }

/// <summary>
/// Optional process identifier used to indicate a business process this dialog belongs to
/// Optional process identifier used to indicate a business process this dialog belongs to.
/// </summary>
public string? Process { get; set; }

Expand Down Expand Up @@ -122,23 +122,23 @@ public sealed class GetDialogDto
public SystemLabel.Values SystemLabel { get; set; }

/// <summary>
/// The dialog unstructured text content
/// The dialog unstructured text content.
/// </summary>
public GetDialogContentDto Content { get; set; } = null!;

/// <summary>
/// The dialog token. May be used (if supported) against external URLs referred to in this dialog's apiActions,
/// transmissions or attachments. Should also be used for front-channel embeds.
/// transmissions or attachments. It should also be used for front-channel embeds.
/// </summary>
public string? DialogToken { get; set; }

/// <summary>
/// The attachments associated with the dialog (on an aggregate level)
/// The attachments associated with the dialog (on an aggregate level).
/// </summary>
public List<GetDialogDialogAttachmentDto> Attachments { get; set; } = [];

/// <summary>
/// The immutable list of transmissions associated with the dialog
/// The immutable list of transmissions associated with the dialog.
/// </summary>
public List<GetDialogDialogTransmissionDto> Transmissions { get; set; } = [];

Expand Down Expand Up @@ -193,7 +193,7 @@ public sealed class GetDialogDialogTransmissionDto

/// <summary>
/// Flag indicating if the authenticated user is authorized for this transmission. If not, embedded content and
/// the attachments will not be available
/// the attachments will not be available.
/// </summary>
public bool IsAuthorized { get; set; }

Expand All @@ -220,12 +220,12 @@ public sealed class GetDialogDialogTransmissionDto
public GetDialogDialogTransmissionSenderActorDto Sender { get; set; } = null!;

/// <summary>
/// The transmission unstructured text content
/// The transmission unstructured text content.
/// </summary>
public GetDialogDialogTransmissionContentDto Content { get; set; } = null!;

/// <summary>
/// The transmission-level attachments
/// The transmission-level attachments.
/// </summary>
public List<GetDialogDialogTransmissionAttachmentDto> Attachments { get; set; } = [];
}
Expand All @@ -238,12 +238,12 @@ public sealed class GetDialogDialogSeenLogDto
public Guid Id { get; set; }

/// <summary>
/// The timestamp when the dialog revision was seen
/// The timestamp when the dialog revision was seen.
/// </summary>
public DateTimeOffset SeenAt { get; set; }

/// <summary>
/// The actor that saw the dialog revision
/// The actor that saw the dialog revision.
/// </summary>
public GetDialogDialogSeenLogSeenByActorDto SeenBy { get; set; } = null!;

Expand Down Expand Up @@ -418,7 +418,7 @@ public sealed class GetDialogDialogApiActionDto

/// <summary>
/// String identifier for the action, corresponding to the "action" attributeId used in the XACML service policy,
/// which by default is the policy belonging to the service referred to by "serviceResource" in the dialog
/// which by default is the policy belonging to the service referred to by "serviceResource" in the dialog.
/// </summary>
/// <example>write</example>
public string Action { get; set; } = null!;
Expand Down Expand Up @@ -518,7 +518,7 @@ public sealed class GetDialogDialogGuiActionDto
public Guid Id { get; set; }

/// <summary>
/// The action identifier for the action, corresponding to the "action" attributeId used in the XACML service policy,
/// The action identifier for the action, corresponding to the "action" attributeId used in the XACML service policy.
/// </summary>
public string Action { get; set; } = null!;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.EndUser.Dialogs.Que
public sealed class SearchDialogDto : SearchDialogDtoBase
{
/// <summary>
/// The content of the dialog in search results
/// The content of the dialog in search results.
/// </summary>
[JsonPropertyOrder(100)] // ILU MAGNUS
public SearchDialogContentDto Content { get; set; } = null!;
Expand Down Expand Up @@ -37,8 +37,8 @@ public sealed class SearchDialogContentDto
}

/// <summary>
/// TOOD: Discuss this with the team later. It works for now
/// This class is used in order to keep using ProjectTo and existing PaginationList code.
/// TODO: Discuss this with the team later. It works for now
/// This class is used to keep using ProjectTo and existing PaginationList code.
/// We first map to this using ProjectTo, then map to the new DialogContent structure
/// in the SearchDialog handlers, after EF core is done loading the data.
/// Then we create a new PaginatedList with the outwards facing dto
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ public class SearchDialogDtoBase
public string ServiceResource { get; set; } = null!;

/// <summary>
/// The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)
/// The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType).
/// </summary>
public string ServiceResourceType { get; set; } = null!;

/// <summary>
/// The party code representing the organization or person that the dialog belongs to in URN format
/// The party code representing the organization or person that the dialog belongs to in URN format.
/// </summary>
/// <example>
/// urn:altinn:person:identifier-no:01125512345
Expand All @@ -48,12 +48,12 @@ public class SearchDialogDtoBase
public int? Progress { get; set; }

/// <summary>
/// Optional process identifier used to indicate a business process this dialog belongs to
/// Optional process identifier used to indicate a business process this dialog belongs to.
/// </summary>
public string? Process { get; set; }

/// <summary>
/// Optional preceding process identifier to indicate the business process that preceded the process indicated in the "Process" field. Cannot be set without also "Process" being set.
/// Optional preceding process identifier to indicate the business process that preceded the process indicated in the "Process" field. Cannot be set without also "Process" being set.
/// </summary>
public string? PrecedingProcess { get; set; }

Expand Down Expand Up @@ -117,12 +117,12 @@ public sealed class SearchDialogDialogSeenLogDto
public Guid Id { get; set; }

/// <summary>
/// The timestamp when the dialog revision was seen
/// The timestamp when the dialog revision was seen.
/// </summary>
public DateTimeOffset SeenAt { get; set; }

/// <summary>
/// The actor that saw the dialog revision
/// The actor that saw the dialog revision.
/// </summary>
public SearchDialogDialogSeenLogSeenByActorDto SeenBy { get; set; } = null!;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.ServiceOwner.Dialog
public class CreateDialogDto
{
/// <summary>
/// A self-defined UUIDv7 may be provided in order to support idempotent creation of dialogs. If not provided, a new UUIDv7 will be generated.
/// A self-defined UUIDv7 may be provided to support idempotent creation of dialogs. If not provided, a new UUIDv7 will be generated.
/// </summary>
/// <example>01913cd5-784f-7d3b-abef-4c77b1f0972d</example>
public Guid? Id { get; set; }
Expand All @@ -28,7 +28,7 @@ public class CreateDialogDto
public string ServiceResource { get; set; } = null!;

/// <summary>
/// The party code representing the organization or person that the dialog belongs to in URN format
/// The party code representing the organization or person that the dialog belongs to in URN format.
/// </summary>
/// <example>
/// urn:altinn:person:identifier-no:01125512345
Expand Down Expand Up @@ -67,7 +67,7 @@ public class CreateDialogDto
public DateTimeOffset? DueAt { get; set; }

/// <summary>
/// Optional process identifier used to indicate a business process this dialog belongs to
/// Optional process identifier used to indicate a business process this dialog belongs to.
/// </summary>
public string? Process { get; set; }
/// <summary>
Expand All @@ -85,14 +85,14 @@ public class CreateDialogDto
public DateTimeOffset? ExpiresAt { get; set; }

/// <summary>
/// If set, will override the date and time when the dialog is set as created
/// If set, will override the date and time when the dialog is set as created.
/// If not supplied, the current date /time will be used.
/// </summary>
/// <example>2022-12-31T23:59:59Z</example>
public DateTimeOffset CreatedAt { get; set; }

/// <summary>
/// If set, will override the date and time when the dialog is set as last updated
/// If set, will override the date and time when the dialog is set as last updated.
/// If not supplied, the current date /time will be used.
/// </summary>
/// <example>2022-12-31T23:59:59Z</example>
Expand All @@ -104,11 +104,11 @@ public class CreateDialogDto
public DialogStatus.Values Status { get; set; }

/// <summary>
/// Set the system label of the dialog Migration purposes
/// Set the system label of the dialog Migration purposes.
/// </summary>
public SystemLabel.Values? SystemLabel { get; set; }
/// <summary>
/// The dialog unstructured text content
/// The dialog unstructured text content.
/// </summary>
public CreateDialogContentDto Content { get; set; } = null!;

Expand All @@ -118,12 +118,12 @@ public class CreateDialogDto
public List<CreateDialogSearchTagDto> SearchTags { get; set; } = [];

/// <summary>
/// The attachments associated with the dialog (on an aggregate level)
/// The attachments associated with the dialog (on an aggregate level).
/// </summary>
public List<CreateDialogDialogAttachmentDto> Attachments { get; set; } = [];

/// <summary>
/// The immutable list of transmissions associated with the dialog
/// The immutable list of transmissions associated with the dialog.
/// </summary>
public List<CreateDialogDialogTransmissionDto> Transmissions { get; set; } = [];

Expand All @@ -146,13 +146,13 @@ public class CreateDialogDto
public sealed class CreateDialogDialogTransmissionDto
{
/// <summary>
/// A self-defined UUIDv7 may be provided in order to support idempotent creation of transmissions. If not provided, a new UUIDv7 will be generated.
/// A self-defined UUIDv7 may be provided to support idempotent creation of transmissions. If not provided, a new UUIDv7 will be generated.
/// </summary>
/// <example>01913cd5-784f-7d3b-abef-4c77b1f0972d</example>
public Guid? Id { get; set; }

/// <summary>
/// If supplied, overrides the creating date and time for the transmission
/// If supplied, overrides the creating date and time for the transmission.
/// If not supplied, the current date /time will be used.
/// </summary>
public DateTimeOffset CreatedAt { get; set; }
Expand Down Expand Up @@ -196,12 +196,12 @@ public sealed class CreateDialogDialogTransmissionDto
public CreateDialogDialogTransmissionSenderActorDto Sender { get; set; } = null!;

/// <summary>
/// The transmission unstructured text content
/// The transmission unstructured text content.
/// </summary>
public CreateDialogDialogTransmissionContentDto Content { get; set; } = null!;

/// <summary>
/// The transmission-level attachments
/// The transmission-level attachments.
/// </summary>
public List<CreateDialogTransmissionAttachmentDto> Attachments { get; set; } = [];
}
Expand Down Expand Up @@ -275,7 +275,7 @@ public sealed class CreateDialogSearchTagDto
public sealed class CreateDialogDialogActivityDto
{
/// <summary>
/// A self-defined UUIDv7 may be provided in order to support idempotent creation of activities. If not provided, a new UUIDv7 will be generated.
/// A self-defined UUIDv7 may be provided to support idempotent creation of activities. If not provided, a new UUIDv7 will be generated.
/// </summary>
/// <example>01913cd5-784f-7d3b-abef-4c77b1f0972d</example>
public Guid? Id { get; set; }
Expand Down Expand Up @@ -361,7 +361,7 @@ public sealed class CreateDialogDialogApiActionDto
{
/// <summary>
/// String identifier for the action, corresponding to the "action" attributeId used in the XACML service policy,
/// which by default is the policy belonging to the service referred to by "serviceResource" in the dialog
/// which by default is the policy belonging to the service referred to by "serviceResource" in the dialog.
/// </summary>
/// <example>write</example>
public string Action { get; set; } = null!;
Expand Down Expand Up @@ -438,7 +438,7 @@ public sealed class CreateDialogDialogApiActionEndpointDto
public sealed class CreateDialogDialogGuiActionDto
{
/// <summary>
/// The action identifier for the action, corresponding to the "action" attributeId used in the XACML service policy,
/// The action identifier for the action, corresponding to the "action" attributeId used in the XACML service policy.
/// </summary>
public string Action { get; set; } = null!;

Expand Down
Loading
Loading