Skip to content

Commit de7b915

Browse files
authored
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.
1 parent f60249a commit de7b915

File tree

4 files changed

+16
-22
lines changed

4 files changed

+16
-22
lines changed

docs/schema/V1/swagger.verified.json

+6-6
Original file line numberDiff line numberDiff line change
@@ -378,19 +378,19 @@
378378
"additionalProperties": false,
379379
"properties": {
380380
"actorId": {
381-
"description": "The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName.\nMight be omitted if ActorType is \u0022ServiceOwner\u0022.",
381+
"description": "The identifier (national identity number or organization number) of the actor.",
382382
"example": "urn:altinn:person:identifier-no:12018212345",
383383
"nullable": true,
384384
"type": "string"
385385
},
386386
"actorName": {
387-
"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.",
387+
"description": "The name of the actor.",
388388
"example": "Ola Nordmann",
389389
"nullable": true,
390390
"type": "string"
391391
},
392392
"actorType": {
393-
"description": "The type of actor that sent the transmission.",
393+
"description": "The type of actor; either the service owner, or someone representing the party.",
394394
"oneOf": [
395395
{
396396
"$ref": "#/components/schemas/Actors_ActorType"
@@ -1876,19 +1876,19 @@
18761876
"additionalProperties": false,
18771877
"properties": {
18781878
"actorId": {
1879-
"description": "The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName.\nMight be omitted if ActorType is \u0022ServiceOwner\u0022.",
1879+
"description": "The identifier (national identity number or organization number) of the actor.",
18801880
"example": "urn:altinn:person:identifier-no:12018212345",
18811881
"nullable": true,
18821882
"type": "string"
18831883
},
18841884
"actorName": {
1885-
"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.",
1885+
"description": "The name of the actor.",
18861886
"example": "Ola Nordmann",
18871887
"nullable": true,
18881888
"type": "string"
18891889
},
18901890
"actorType": {
1891-
"description": "The type of actor that sent the transmission.",
1891+
"description": "The type of actor; either the service owner, or someone representing the party.",
18921892
"oneOf": [
18931893
{
18941894
"$ref": "#/components/schemas/Actors_ActorType"

src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Common/Actors/ActorDto.cs

+4-6
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,20 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.EndUser.Common.Acto
55
public sealed class ActorDto
66
{
77
/// <summary>
8-
/// The type of actor that sent the transmission.
8+
/// The type of actor; either the service owner, or someone representing the party.
99
/// </summary>
1010
public ActorType.Values ActorType { get; set; }
1111

1212
/// <summary>
13-
/// Specifies the name of the entity that sent the transmission. Mutually exclusive with ActorId. If ActorId
14-
/// is supplied, the name will be automatically populated from the name registries.
13+
/// The name of the actor.
1514
/// </summary>
1615
/// <example>Ola Nordmann</example>
1716
public string? ActorName { get; set; }
1817

1918
/// <summary>
20-
/// The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName.
21-
/// Might be omitted if ActorType is "ServiceOwner".
19+
/// The identifier (national identity number or organization number) of the actor.
2220
/// </summary>
2321
/// <example>urn:altinn:person:identifier-no:12018212345</example>
2422
public string? ActorId { get; set; }
25-
2623
}
24+

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Common/Actors/ActorDto.cs

+3-5
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,18 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.ServiceOwner.Common
55
public sealed class ActorDto
66
{
77
/// <summary>
8-
/// The type of actor that sent the transmission.
8+
/// The type of actor; either the service owner, or someone representing the party.
99
/// </summary>
1010
public ActorType.Values ActorType { get; set; }
1111

1212
/// <summary>
13-
/// Specifies the name of the entity that sent the transmission. Mutually exclusive with ActorId. If ActorId
14-
/// is supplied, the name will be automatically populated from the name registries.
13+
/// The name of the actor.
1514
/// </summary>
1615
/// <example>Ola Nordmann</example>
1716
public string? ActorName { get; set; }
1817

1918
/// <summary>
20-
/// The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName.
21-
/// Might be omitted if ActorType is "ServiceOwner".
19+
/// The identifier (national identity number or organization number) of the actor.
2220
/// </summary>
2321
/// <example>urn:altinn:person:identifier-no:12018212345</example>
2422
public string? ActorId { get; set; }

src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs

+3-5
Original file line numberDiff line numberDiff line change
@@ -994,24 +994,22 @@ public enum DialogsEntitiesTransmissions_DialogTransmissionType
994994
public partial class V1ServiceOwnerCommonActors_Actor
995995
{
996996
/// <summary>
997-
/// The type of actor that sent the transmission.
997+
/// The type of actor; either the service owner, or someone representing the party.
998998
/// </summary>
999999

10001000
[JsonPropertyName("actorType")]
10011001
[JsonConverter(typeof(JsonStringEnumConverter))]
10021002
public Actors_ActorType ActorType { get; set; }
10031003

10041004
/// <summary>
1005-
/// Specifies the name of the entity that sent the transmission. Mutually exclusive with ActorId. If ActorId
1006-
/// <br/>is supplied, the name will be automatically populated from the name registries.
1005+
/// The name of the actor.
10071006
/// </summary>
10081007

10091008
[JsonPropertyName("actorName")]
10101009
public string ActorName { get; set; }
10111010

10121011
/// <summary>
1013-
/// The identifier of the person or organization that sent the transmission. Mutually exclusive with ActorName.
1014-
/// <br/>Might be omitted if ActorType is "ServiceOwner".
1012+
/// The identifier (national identity number or organization number) of the actor.
10151013
/// </summary>
10161014

10171015
[JsonPropertyName("actorId")]

0 commit comments

Comments
 (0)