fix(webapi): Add missing 404 status code in activity list swagger schema

[oskogstad]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request improves error handling and documentation in the Dialogporten API. The changes update the OpenAPI specification to introduce structured 404 responses for missing dialogs or activities. Modifications include a simplified error message constant, enhanced endpoint configurations with explicit response type declarations, and additions to the client interface for managing non-sensitive title and summary data. Overall, the changes ensure consistency and clarity in error responses across both API documentation and client interfaces.

Changes

File(s)	Change Summary
docs/schema/V1/...swagger.verified.json	Updates OpenAPI spec to add structured 404 responses (with application/problem+json and ProblemDetails schema) and simplifies existing 404 description text.
src/Digdir.Domain.Dialogporten.WebApi/Common/Constants.cs	Updates the DialogActivityNotFound constant to a more concise message: “The specified dialog ID or activity ID was not found.”
src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/EndUser/DialogActivities/Search/SearchDialogActivityEndpoint.cs src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/DialogActivities/Search/SearchDialogActivityEndpoint.cs	Introduces a new using directive and updates the Configure method to document response types (returning 200 with a list of ActivityDto or 404).
src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs	Adds properties for non-sensitive title/summary in related classes and updates error descriptions for 410 and 404 responses in the client API methods.

Possibly related PRs

• chore: Simplify 404 NotFound swagger text #1791: Modifies 404 error message phrasing to streamline responses for missing dialog or activity IDs.
• feat(webapi): Option to include deleted dialogs in ServiceOwner dialog search #1816: Simplifies error handling for missing dialogs or activities, aligning closely with the changes in this PR.
• fix(graphql): Add missing search parameters for paging and sorting #1671: Enhances error response structures in related endpoints by clarifying messaging for missing resources.

Suggested reviewers

• arealmaas
• MagnusSandgren

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a35403 and 76718fb.

📒 Files selected for processing (3)

• docs/schema/V1/swagger.verified.json (4 hunks)
• src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/DialogActivities/Search/SearchDialogActivityEndpoint.cs (2 hunks)
• src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs (8 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Dry run deploy apps / Deploy job sync-resource-policy-information-job to test
• GitHub Check: Dry run deploy apps / Deploy job sync-subject-resource-mappings-job to test
• GitHub Check: build / build-and-test

🔇 Additional comments (7)

src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/DialogActivities/Search/SearchDialogActivityEndpoint.cs (2)

4-4: LGTM!

The new using directive is required for the ProducesOneOf extension method.

---

25-27:

✅ Verification successful

LGTM! The swagger schema documentation now matches the implementation.

The description configuration properly documents the endpoint's response types (200 OK and 404 Not Found) in the OpenAPI/Swagger schema, which aligns with the actual error handling in the HandleAsync method.

Let's verify that the swagger schema has been updated correctly:

---

🏁 Script executed:

#!/bin/bash
# Description: Verify that the swagger schema includes the 404 response for the activities endpoint

# Test: Search for the endpoint path and its responses in the swagger schema
rg -A 10 '"/api/v1/serviceowner/dialogs/\{dialogId\}/activities".*get' docs/schema/V1/swagger.verified.json

Length of output: 109

---

Action Required: Verify Swagger Schema Manually

The updated endpoint configuration appears correct based on the code snippet:

Description(b => b.ProducesOneOf<List<ActivityDto>>(
    StatusCodes.Status200OK,
    StatusCodes.Status404NotFound));

However, the initial shell command did not produce any output when searching the swagger JSON schema for the expected endpoint details. To be absolutely sure that the swagger schema now includes both the 200 and 404 responses for the activities endpoint, please manually verify the contents of docs/schema/V1/swagger.verified.json.

You might also consider running an additional jq command such as:

This should output a list of status codes (including "200" and "404") if the documentation is correct.

Once you confirm that the swagger documentation has been updated as intended, the changes can be approved.

---

🏁 Script executed:

[run_scripts]
#!/bin/bash
# Retrieve and list the documented response status codes for the target endpoint
jq '.paths["/api/v1/serviceowner/dialogs/{dialogId}/activities"].get.responses | keys' docs/schema/V1/swagger.verified.json

Length of output: 286

---

Approval: Swagger Schema Documentation Verified

The updated endpoint configuration now accurately documents the responses. The swagger schema confirms that the explicit responses of 200 OK and 404 Not Found are correctly documented, while the additional 401 and 403 responses—likely provided by global security settings—are also present as expected. LGTM!

docs/schema/V1/swagger.verified.json (5)

5233-5242: LGTM! The 404 response schema is correctly defined.

The 404 response schema for the /api/v1/enduser/dialogs/{dialogId}/activities endpoint is properly defined with the ProblemDetails schema and appropriate content type.

---

6707-6716: LGTM! The 404 response schema is correctly defined.

The 404 response schema for the /api/v1/serviceowner/dialogs/{dialogId}/activities endpoint is properly defined with the ProblemDetails schema and appropriate content type.

---

6891-6899: LGTM! The 404 response description is correctly updated.

The description for the 404 response has been appropriately updated to "The specified dialog ID or activity ID was not found" which clearly indicates both possible failure cases.

---

5305-5305: LGTM! The 404 response description is correctly updated.

The description for the 404 response has been appropriately updated to "The specified dialog ID or activity ID was not found" which clearly indicates both possible failure cases.

---

7289-7293:

❓ Verification inconclusive

Verify the server URL configuration.

The server URL is currently set to localhost which may not be appropriate for production use.

---

🏁 Script executed:

#!/bin/bash
# Description: Check if there are any environment-specific server URLs defined in the codebase

# Search for server URL configurations in JSON/YAML files
rg -g '*.{json,yaml,yml}' -i 'servers.*url'

# Search for environment-specific configuration files
fd -g '*{.env,config}*'

Length of output: 1850

---

Action Required – Verify Server URL in Swagger Configuration

The file docs/schema/V1/swagger.verified.json (lines 7289-7293) currently hard-codes the server URL as:

  "servers": [
    {
      "url": "https://localhost:7214/"
    }
  ]

Please verify whether this configuration is intended only for local development or if it should be updated for production environments. If this swagger file is used in production, consider updating the URL (or parametrizing it using environment-specific variables) to reflect the correct server endpoint.

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.