Skip to content

Commit

Permalink
chore: Fix actor DTO summaries (#1997)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
elsand authored Mar 4, 2025
1 parent f60249a commit de7b915
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 22 deletions.
12 changes: 6 additions & 6 deletions docs/schema/V1/swagger.verified.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,20 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.EndUser.Common.Acto
public sealed class ActorDto
{
/// <summary>
/// The type of actor that sent the transmission.
/// The type of actor; either the service owner, or someone representing the party.
/// </summary>
public ActorType.Values ActorType { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <example>Ola Nordmann</example>
public string? ActorName { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <example>urn:altinn:person:identifier-no:12018212345</example>
public string? ActorId { get; set; }

}

Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,18 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.ServiceOwner.Common
public sealed class ActorDto
{
/// <summary>
/// The type of actor that sent the transmission.
/// The type of actor; either the service owner, or someone representing the party.
/// </summary>
public ActorType.Values ActorType { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <example>Ola Nordmann</example>
public string? ActorName { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <example>urn:altinn:person:identifier-no:12018212345</example>
public string? ActorId { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -994,24 +994,22 @@ public enum DialogsEntitiesTransmissions_DialogTransmissionType
public partial class V1ServiceOwnerCommonActors_Actor
{
/// <summary>
/// The type of actor that sent the transmission.
/// The type of actor; either the service owner, or someone representing the party.
/// </summary>

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

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

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

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

[JsonPropertyName("actorId")]
Expand Down

0 comments on commit de7b915

Please sign in to comment.