From de7b915b261b92b0440c7bc496982a04c99c3de7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Dybvik=20Langfors?= Date: Tue, 4 Mar 2025 09:58:31 +0100 Subject: [PATCH] chore: Fix actor DTO summaries (#1997) The summaries used on the common ActorDto was referring to transmissions, and including information only relevant for serviceowner POST. Reworded/simplified so that the summaries make sense in any context. --- docs/schema/V1/swagger.verified.json | 12 ++++++------ .../Features/V1/EndUser/Common/Actors/ActorDto.cs | 10 ++++------ .../V1/ServiceOwner/Common/Actors/ActorDto.cs | 8 +++----- .../Features/V1/RefitterInterface.cs | 8 +++----- 4 files changed, 16 insertions(+), 22 deletions(-) diff --git a/docs/schema/V1/swagger.verified.json b/docs/schema/V1/swagger.verified.json index 4a2156647..a122e4b31 100644 --- a/docs/schema/V1/swagger.verified.json +++ b/docs/schema/V1/swagger.verified.json @@ -378,19 +378,19 @@ "additionalProperties": false, "properties": { "actorId": { - "description": "The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName.\nMight be omitted if ActorType is \u0022ServiceOwner\u0022.", + "description": "The identifier (national identity number or organization number) of the actor.", "example": "urn:altinn:person:identifier-no:12018212345", "nullable": true, "type": "string" }, "actorName": { - "description": "Specifies the name of the entity that sent the transmission. Mutually exclusive with ActorId. If ActorId\nis supplied, the name will be automatically populated from the name registries.", + "description": "The name of the actor.", "example": "Ola Nordmann", "nullable": true, "type": "string" }, "actorType": { - "description": "The type of actor that sent the transmission.", + "description": "The type of actor; either the service owner, or someone representing the party.", "oneOf": [ { "$ref": "#/components/schemas/Actors_ActorType" @@ -1876,19 +1876,19 @@ "additionalProperties": false, "properties": { "actorId": { - "description": "The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName.\nMight be omitted if ActorType is \u0022ServiceOwner\u0022.", + "description": "The identifier (national identity number or organization number) of the actor.", "example": "urn:altinn:person:identifier-no:12018212345", "nullable": true, "type": "string" }, "actorName": { - "description": "Specifies the name of the entity that sent the transmission. Mutually exclusive with ActorId. If ActorId\nis supplied, the name will be automatically populated from the name registries.", + "description": "The name of the actor.", "example": "Ola Nordmann", "nullable": true, "type": "string" }, "actorType": { - "description": "The type of actor that sent the transmission.", + "description": "The type of actor; either the service owner, or someone representing the party.", "oneOf": [ { "$ref": "#/components/schemas/Actors_ActorType" diff --git a/src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Common/Actors/ActorDto.cs b/src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Common/Actors/ActorDto.cs index e32459496..cd41fc167 100644 --- a/src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Common/Actors/ActorDto.cs +++ b/src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Common/Actors/ActorDto.cs @@ -5,22 +5,20 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.EndUser.Common.Acto public sealed class ActorDto { /// - /// The type of actor that sent the transmission. + /// The type of actor; either the service owner, or someone representing the party. /// public ActorType.Values ActorType { get; set; } /// - /// Specifies the name of the entity that sent the transmission. Mutually exclusive with ActorId. If ActorId - /// is supplied, the name will be automatically populated from the name registries. + /// The name of the actor. /// /// Ola Nordmann public string? ActorName { get; set; } /// - /// The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName. - /// Might be omitted if ActorType is "ServiceOwner". + /// The identifier (national identity number or organization number) of the actor. /// /// urn:altinn:person:identifier-no:12018212345 public string? ActorId { get; set; } - } + diff --git a/src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Common/Actors/ActorDto.cs b/src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Common/Actors/ActorDto.cs index 3cea258a3..6f6a16c08 100644 --- a/src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Common/Actors/ActorDto.cs +++ b/src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Common/Actors/ActorDto.cs @@ -5,20 +5,18 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.ServiceOwner.Common public sealed class ActorDto { /// - /// The type of actor that sent the transmission. + /// The type of actor; either the service owner, or someone representing the party. /// public ActorType.Values ActorType { get; set; } /// - /// Specifies the name of the entity that sent the transmission. Mutually exclusive with ActorId. If ActorId - /// is supplied, the name will be automatically populated from the name registries. + /// The name of the actor. /// /// Ola Nordmann public string? ActorName { get; set; } /// - /// The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName. - /// Might be omitted if ActorType is "ServiceOwner". + /// The identifier (national identity number or organization number) of the actor. /// /// urn:altinn:person:identifier-no:12018212345 public string? ActorId { get; set; } diff --git a/src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs b/src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs index 0f9545f44..ee4b5ac74 100644 --- a/src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs +++ b/src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs @@ -994,7 +994,7 @@ public enum DialogsEntitiesTransmissions_DialogTransmissionType public partial class V1ServiceOwnerCommonActors_Actor { /// - /// The type of actor that sent the transmission. + /// The type of actor; either the service owner, or someone representing the party. /// [JsonPropertyName("actorType")] @@ -1002,16 +1002,14 @@ public partial class V1ServiceOwnerCommonActors_Actor public Actors_ActorType ActorType { get; set; } /// - /// Specifies the name of the entity that sent the transmission. Mutually exclusive with ActorId. If ActorId - ///
is supplied, the name will be automatically populated from the name registries. + /// The name of the actor. /// [JsonPropertyName("actorName")] public string ActorName { get; set; } /// - /// The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName. - ///
Might be omitted if ActorType is "ServiceOwner". + /// The identifier (national identity number or organization number) of the actor. /// [JsonPropertyName("actorId")]