chore: Change 400 to 410 for update/delete on deleted dialogs (#1552)

<!--- Provide a general summary of your changes in the Title above -->

## Description

<!--- Describe your changes in detail -->

## Related Issue(s)

- #1541 

## Verification

- [x] **Your** code builds clean without any errors or warnings
- [x] Manual testing done (required)
- [ ] Relevant automated test added (if you find this hard, leave it and
we'll help out)

## Documentation

- [ ] Documentation is updated (either in `docs`-directory, Altinnpedia
or a separate linked PR in
[altinn-studio-docs.](https://github.com/Altinn/altinn-studio-docs), if
applicable)


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

## Release Notes

- **New Features**
- Introduced `410 Gone` response status for `DELETE`, `PUT`, and `POST`
operations related to dialog management, enhancing clarity on resource
deletion.
- Added specific responses for deleted dialogs in various endpoints,
improving error handling.

- **Bug Fixes**
- Updated response handling in dialog update and delete operations to
return more accurate status when dealing with deleted entities.

- **Tests**
- Modified tests to reflect changes in response expectations for
attempts to update deleted dialogs.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

docs/schema/V1/swagger.verified.json

@@ -5945,6 +5945,9 @@
             },
             "description": "The given dialog ID was not found or is already deleted."
           },
+          "410": {
+            "description": "Entity with the given key(s) is removed."
+          },
           "412": {
             "content": {
               "application/problem\u002Bjson": {
@@ -6193,6 +6196,9 @@
             },
             "description": "The given dialog ID was not found or is already deleted."
           },
+          "410": {
+            "description": "Entity with the given key(s) is removed."
+          },
           "412": {
             "content": {
               "application/problem\u002Bjson": {
@@ -6488,6 +6494,9 @@
             },
             "description": "The given dialog ID was not found or is already deleted."
           },
+          "410": {
+            "description": "Entity with the given key(s) is removed."
+          },
           "412": {
             "content": {
               "application/problem\u002Bjson": {
@@ -6830,6 +6839,9 @@
             },
             "description": "The given dialog ID was not found or is already deleted."
           },
+          "410": {
+            "description": "Entity with the given key(s) is removed."
+          },
           "412": {
             "content": {
               "application/problem\u002Bjson": {

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Delete/DeleteDialogCommand.cs

@@ -19,7 +19,7 @@ public sealed class DeleteDialogCommand : IRequest<DeleteDialogResult>
 }
 
 [GenerateOneOf]
-public sealed partial class DeleteDialogResult : OneOfBase<Success, EntityNotFound, BadRequest, Forbidden, ConcurrencyError>;
+public sealed partial class DeleteDialogResult : OneOfBase<Success, EntityNotFound, EntityDeleted, Forbidden, ConcurrencyError>;
 
 internal sealed class DeleteDialogCommandHandler : IRequestHandler<DeleteDialogCommand, DeleteDialogResult>
 {
@@ -56,7 +56,7 @@ public async Task<DeleteDialogResult> Handle(DeleteDialogCommand request, Cancel
         {
             // TODO: https://github.com/digdir/dialogporten/issues/1543
             // When restoration is implemented, add a hint to the error message.
-            return new BadRequest($"Entity '{nameof(DialogEntity)}' with key '{request.Id}' has already been removed and cannot be deleted again.");
+            return new EntityDeleted<DialogEntity>(request.Id);
         }
 
         if (!_userResourceRegistry.UserCanModifyResourceType(dialog.ServiceResourceType))

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Update/UpdateDialogCommand.cs

@@ -31,7 +31,7 @@ public sealed class UpdateDialogCommand : IRequest<UpdateDialogResult>
 }
 
 [GenerateOneOf]
-public sealed partial class UpdateDialogResult : OneOfBase<Success, EntityNotFound, BadRequest, ValidationError, Forbidden, DomainError, ConcurrencyError>;
+public sealed partial class UpdateDialogResult : OneOfBase<Success, EntityNotFound, EntityDeleted, ValidationError, Forbidden, DomainError, ConcurrencyError>;
 
 internal sealed class UpdateDialogCommandHandler : IRequestHandler<UpdateDialogCommand, UpdateDialogResult>
 {
@@ -95,7 +95,7 @@ public async Task<UpdateDialogResult> Handle(UpdateDialogCommand request, Cancel
         {
             // TODO: https://github.com/digdir/dialogporten/issues/1543
             // When restoration is implemented, add a hint to the error message.
-            return new BadRequest($"Entity '{nameof(DialogEntity)}' with key '{request.Id}' is removed, and cannot be updated.");
+            return new EntityDeleted<DialogEntity>(request.Id);
         }
 
         // Ensure transmissions have a UUIDv7 ID, needed for the transmission hierarchy validation.

src/Digdir.Domain.Dialogporten.WebApi/Common/Constants.cs

@@ -18,6 +18,7 @@ internal static class SwaggerSummary
         internal const string ServiceOwnerAuthenticationFailure = "Missing or invalid authentication token. Requires a Maskinporten-token with the scope \"{0}\".";
         internal const string EndUserAuthenticationFailure = "Missing or invalid authentication token. Requires a Maskinporten-token with the scope \"digdir:dialogporten\".";
         internal const string DialogNotFound = "The given dialog ID was not found or is already deleted.";
+        internal const string DialogDeleted = $"Entity with the given key(s) is removed.";
         internal const string DialogActivityNotFound = "The given dialog ID was not found or was deleted, or the given activity ID was not found.";
         internal const string DialogTransmissionNotFound = "The given dialog ID was not found or was deleted, or the given transmission ID was not found.";
         internal const string RevisionMismatch = "The supplied If-Match header did not match the current Revision value for the dialog. The request was not applied.";

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/DialogActivities/Create/CreateDialogActivityEndpoint.cs

@@ -35,6 +35,7 @@ public override void Configure()
             StatusCodes.Status201Created,
             StatusCodes.Status400BadRequest,
             StatusCodes.Status404NotFound,
+            StatusCodes.Status410Gone,
             StatusCodes.Status412PreconditionFailed,
             StatusCodes.Status422UnprocessableEntity));
     }
@@ -66,7 +67,7 @@ await errors.Match(
         await result.Match(
             success => SendCreatedAtAsync<GetDialogActivityEndpoint>(new GetActivityQuery { DialogId = dialog.Id, ActivityId = req.Id.Value }, req.Id, cancellation: ct),
             notFound => this.NotFoundAsync(notFound, ct),
-            badRequest => this.BadRequestAsync(badRequest, ct),
+            gone => this.GoneAsync(gone, ct),
             validationError => this.BadRequestAsync(validationError, ct),
             forbidden => this.ForbiddenAsync(forbidden, ct),
             domainError => this.UnprocessableEntityAsync(domainError, ct),

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/DialogActivities/Create/CreateDialogActivityEndpointSummary.cs

@@ -23,6 +23,7 @@ The activity is created with the given configuration. For more information see t
         Responses[StatusCodes.Status401Unauthorized] = Constants.SwaggerSummary.ServiceOwnerAuthenticationFailure.FormatInvariant(AuthorizationScope.ServiceProvider);
         Responses[StatusCodes.Status403Forbidden] = Constants.SwaggerSummary.AccessDeniedToDialogForChildEntity.FormatInvariant("create");
         Responses[StatusCodes.Status404NotFound] = Constants.SwaggerSummary.DialogNotFound;
+        Responses[StatusCodes.Status410Gone] = Constants.SwaggerSummary.DialogDeleted;
         Responses[StatusCodes.Status412PreconditionFailed] = Constants.SwaggerSummary.RevisionMismatch;
         Responses[StatusCodes.Status422UnprocessableEntity] = Constants.SwaggerSummary.DomainError;
     }

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/DialogTransmissions/Create/CreateDialogTransmissionEndpoint.cs

@@ -35,6 +35,7 @@ public override void Configure()
             StatusCodes.Status201Created,
             StatusCodes.Status400BadRequest,
             StatusCodes.Status404NotFound,
+            StatusCodes.Status410Gone,
             StatusCodes.Status412PreconditionFailed,
             StatusCodes.Status422UnprocessableEntity));
     }
@@ -67,7 +68,7 @@ await errors.Match(
         await result.Match(
             success => SendCreatedAtAsync<GetDialogTransmissionEndpoint>(new GetTransmissionQuery { DialogId = dialog.Id, TransmissionId = req.Id.Value }, req.Id, cancellation: ct),
             notFound => this.NotFoundAsync(notFound, ct),
-            badRequest => this.BadRequestAsync(badRequest, ct),
+            gone => this.GoneAsync(gone, ct),
             validationError => this.BadRequestAsync(validationError, ct),
             forbidden => this.ForbiddenAsync(forbidden, ct),
             domainError => this.UnprocessableEntityAsync(domainError, ct),

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/DialogTransmissions/Create/CreateDialogTransmissionEndpointSummary.cs

@@ -23,6 +23,7 @@ The transmission is created with the given configuration. For more information s
         Responses[StatusCodes.Status401Unauthorized] = Constants.SwaggerSummary.ServiceOwnerAuthenticationFailure.FormatInvariant(AuthorizationScope.ServiceProvider);
         Responses[StatusCodes.Status403Forbidden] = Constants.SwaggerSummary.AccessDeniedToDialogForChildEntity.FormatInvariant("create");
         Responses[StatusCodes.Status404NotFound] = Constants.SwaggerSummary.DialogNotFound;
+        Responses[StatusCodes.Status410Gone] = Constants.SwaggerSummary.DialogDeleted;
         Responses[StatusCodes.Status412PreconditionFailed] = Constants.SwaggerSummary.RevisionMismatch;
         Responses[StatusCodes.Status422UnprocessableEntity] = Constants.SwaggerSummary.DomainError;
     }

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Delete/DeleteDialogEndpoint.cs

@@ -27,6 +27,7 @@ public override void Configure()
             StatusCodes.Status204NoContent,
             StatusCodes.Status400BadRequest,
             StatusCodes.Status404NotFound,
+            StatusCodes.Status410Gone,
             StatusCodes.Status412PreconditionFailed));
     }
 
@@ -37,7 +38,7 @@ public override async Task HandleAsync(DeleteDialogRequest req, CancellationToke
         await result.Match(
             success => SendNoContentAsync(ct),
             notFound => this.NotFoundAsync(notFound, ct),
-            badRequest => this.BadRequestAsync(badRequest, ct),
+            gone => this.GoneAsync(gone, ct),
             forbidden => this.ForbiddenAsync(forbidden, ct),
             concurrencyError => this.PreconditionFailed(ct));
     }

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Delete/DeleteDialogEndpointSummary.cs

@@ -23,6 +23,7 @@ Deletes a given dialog (soft delete). For more information see the documentation
         Responses[StatusCodes.Status403Forbidden] = Constants.SwaggerSummary.AccessDeniedToDialog.FormatInvariant("delete");
         Responses[StatusCodes.Status400BadRequest] = Constants.SwaggerSummary.ValidationError;
         Responses[StatusCodes.Status404NotFound] = Constants.SwaggerSummary.DialogNotFound;
+        Responses[StatusCodes.Status410Gone] = Constants.SwaggerSummary.DialogDeleted;
         Responses[StatusCodes.Status412PreconditionFailed] = Constants.SwaggerSummary.RevisionMismatch;
     }
 }

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogEndpoint.cs

@@ -27,6 +27,7 @@ public override void Configure()
             StatusCodes.Status204NoContent,
             StatusCodes.Status400BadRequest,
             StatusCodes.Status404NotFound,
+            StatusCodes.Status410Gone,
             StatusCodes.Status412PreconditionFailed,
             StatusCodes.Status422UnprocessableEntity));
     }
@@ -44,7 +45,7 @@ public override async Task HandleAsync(UpdateDialogRequest req, CancellationToke
         await updateDialogResult.Match(
             success => SendNoContentAsync(ct),
             notFound => this.NotFoundAsync(notFound, ct),
-            badRequest => this.BadRequestAsync(badRequest, ct),
+            gone => this.GoneAsync(gone, ct),
             validationFailed => this.BadRequestAsync(validationFailed, ct),
             forbidden => this.ForbiddenAsync(forbidden, ct),
             domainError => this.UnprocessableEntityAsync(domainError, ct),

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogEndpointSummary.cs

@@ -23,6 +23,7 @@ Replaces a given dialog with the supplied model. For more information see the do
         Responses[StatusCodes.Status403Forbidden] =
             Constants.SwaggerSummary.AccessDeniedToDialog.FormatInvariant("update");
         Responses[StatusCodes.Status404NotFound] = Constants.SwaggerSummary.DialogNotFound;
+        Responses[StatusCodes.Status410Gone] = Constants.SwaggerSummary.DialogDeleted;
         Responses[StatusCodes.Status412PreconditionFailed] = Constants.SwaggerSummary.RevisionMismatch;
         Responses[StatusCodes.Status422UnprocessableEntity] = Constants.SwaggerSummary.DomainError;
     }

tests/Digdir.Domain.Dialogporten.Application.Integration.Tests/Features/V1/ServiceOwner/Dialogs/Commands/DeleteDialogTests.cs

@@ -32,7 +32,7 @@ public async Task Deleting_Dialog_Should_Set_DeletedAt()
     }
 
     [Fact]
-    public async Task Updating_Deleted_Dialog_Should_Return_BadRequest()
+    public async Task Updating_Deleted_Dialog_Should_Return_EntityDeleted()
     {
         // Arrange
         var createDialogCommand = DialogGenerator.GenerateSimpleFakeDialog();
@@ -54,9 +54,8 @@ public async Task Updating_Deleted_Dialog_Should_Return_BadRequest()
         var updateDialogResponse = await Application.Send(updateDialogCommand);
 
         // Assert
-        updateDialogResponse.TryPickT2(out var validationError, out _).Should().BeTrue();
-        validationError.Should().NotBeNull();
-        validationError.Reasons.Should().Contain(e => e.Contains("cannot be updated"));
-        validationError.Reasons.Should().Contain(e => e.Contains(dialogId.ToString()));
+        updateDialogResponse.TryPickT2(out var entityDeleted, out _).Should().BeTrue();
+        entityDeleted.Should().NotBeNull();
+        entityDeleted.Message.Should().Contain(dialogId.ToString());
     }
 }