chore(webapi): Remove old UpdateDialog Swagger config

[oskogstad]

• Chores
  • Removed outdated methods related to request example bodies in Swagger documentation.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request encompasses significant modifications to the OpenAPI specification for the Dialogporten API, particularly in the swagger.verified.json file. It introduces new schemas and endpoints, updates existing schemas with additional properties, and enhances documentation. Notable changes include the addition of new endpoints for dialog management and the definition of security schemes using JWT for authorization. Additionally, the request example handling in the Swagger generation process has been simplified, and new classes have been created to summarize endpoint responses.

Changes

File	Change Summary
docs/schema/V1/swagger.verified.json	- New schemas added: V1ServiceOwnerDialogsCommandsUpdate_Dialog, V1ServiceOwnerDialogsCommandsCreate_DialogCommand, V1ServiceOwnerDialogTransmissionsCreate_TransmissionRequest. - Existing schemas updated with additional properties. - New endpoints added for dialog activities and management.
src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogEndpointSummary.cs	- Class UpdateDialogEndpointSummary added to provide structured summaries for the UpdateDialogEndpoint.
src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogSwaggerConfig.cs	- Class UpdateDialogSwaggerConfig and its methods removed, including example data for the update dialog endpoint.
src/Digdir.Domain.Dialogporten.WebApi/OpenApiDocumentExtensions.cs	- Methods ReplaceRequestExampleBodies and ReplaceRequestExampleBody removed from OpenApiDocumentExtensions.
src/Digdir.Domain.Dialogporten.WebApi/Program.cs	- Updated Swagger generation process with new method IgnoreEmptyCollections to modify serialization behavior for collections.

Possibly related PRs

• feat(GraphQL): Add DialogToken requirement for subscriptions #1124: Introduces a requirement for a valid DialogToken in GraphQL subscriptions, related to security enhancements in the main PR.
• fix: Add missing events to dialog subscription #1163: Updates the GraphQL schema to replace the dialogUpdated subscription with dialogEvents, aligning with new schemas and endpoints for dialog management.
• fix: Add missing return types for Transmissions and Activities in OpenAPI spec #1244: Adds missing return types for Transmissions and Activities in the OpenAPI spec, directly related to modifications in the main PR.
• feat(webAPI): Make all lists nullable in OpenAPI schema #1359: Modifies serialization behavior for collections in the OpenAPI schema, complementing changes in the main PR.
• feat(webapi): Return 410 GONE for notification checks on deleted dialogs #1387: Enhances API response behavior for deleted dialogs, relevant to new endpoints and schemas introduced in the main PR.

Suggested reviewers

• MagnusSandgren

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

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

18-28: Consider improving response message handling

While the current implementation is functional, consider these improvements:

1. Format the response messages more consistently by extracting the format strings to constants
2. Consider creating a dedicated method for setting up responses to improve readability and maintainability

Example refactor:

 public sealed class UpdateDialogEndpointSummary : Summary<UpdateDialogEndpoint>
 {
+    private void SetupResponses()
+    {
+        Responses[StatusCodes.Status204NoContent] = Constants.SwaggerSummary.Updated.FormatInvariant("aggregate");
+        Responses[StatusCodes.Status400BadRequest] = Constants.SwaggerSummary.ValidationError;
+        // ... other responses
+    }
+
     public UpdateDialogEndpointSummary()
     {
         Summary = "Replaces a dialog";
         Description = $"""
                      Replaces a given dialog with the supplied model. For more information see the documentation (link TBD).

                      {Constants.SwaggerSummary.OptimisticConcurrencyNote}
                      """;
-        Responses[StatusCodes.Status204NoContent] = Constants.SwaggerSummary.Updated.FormatInvariant("aggregate");
-        // ... other responses
+        SetupResponses();
     }
 }

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 326b8b8 and 9ec2edc.

📒 Files selected for processing (5)

• docs/schema/V1/swagger.verified.json (0 hunks)
• src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogEndpointSummary.cs (1 hunks)
• src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogSwaggerConfig.cs (0 hunks)
• src/Digdir.Domain.Dialogporten.WebApi/OpenApiDocumentExtensions.cs (0 hunks)
• src/Digdir.Domain.Dialogporten.WebApi/Program.cs (0 hunks)

💤 Files with no reviewable changes (4)

• docs/schema/V1/swagger.verified.json
• src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogSwaggerConfig.cs
• src/Digdir.Domain.Dialogporten.WebApi/OpenApiDocumentExtensions.cs
• src/Digdir.Domain.Dialogporten.WebApi/Program.cs

🔇 Additional comments (2)

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

1-6: LGTM: Well-organized imports and namespace

The imports are clean, focused, and properly organized, bringing in only the necessary dependencies.

---

8-9: LGTM: Well-designed class declaration

Good use of sealed modifier and proper inheritance from Summary<UpdateDialogEndpoint>.