Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Simplify 404 NotFound swagger text #1791

Merged
merged 1 commit into from
Feb 4, 2025

Conversation

oskogstad
Copy link
Collaborator

No description provided.

@oskogstad oskogstad requested a review from a team as a code owner February 4, 2025 09:35
Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

📝 Walkthrough

Walkthrough

The changes update the error message for 404 responses in the Dialogporten API. Specifically, the API specification and an internal constant have been modified by removing the phrase "or is already deleted" so that the error solely indicates that the dialog ID was not found. The endpoints affected include those used for retrieving a dialog, deleting a dialog, and fetching dialog transmissions.

Changes

File(s) Change Summary
docs/schema/V1/swagger.verified.json
src/Digdir.Domain.Dialogporten.WebApi/Common/Constants.cs
Updated the 404 response error message by removing the phrase “or is already deleted”, ensuring the error now only states “The given dialog ID was not found.”

Suggested Reviewers

  • arealmaas

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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
🪧 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.

@oskogstad oskogstad mentioned this pull request Feb 4, 2025
4 tasks
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/Digdir.Domain.Dialogporten.WebApi/Common/Constants.cs (1)

21-24: Consider consistent error message patterns across related constants.

While simplifying DialogNotFound is good, there's now an inconsistency with related constants that still include the "or was deleted" phrase:

  • DialogActivityNotFound
  • DialogTransmissionNotFound

Consider applying the same simplification to maintain a consistent error messaging pattern.

 internal const string DialogNotFound = "The given dialog ID was not found.";
 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 DialogActivityNotFound = "The given dialog ID or activity ID was not found.";
+internal const string DialogTransmissionNotFound = "The given dialog ID or transmission ID was not found.";
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 26abb48 and a42ad85.

📒 Files selected for processing (2)
  • docs/schema/V1/swagger.verified.json (11 hunks)
  • src/Digdir.Domain.Dialogporten.WebApi/Common/Constants.cs (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/schema/V1/swagger.verified.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build / build-and-test
🔇 Additional comments (1)
src/Digdir.Domain.Dialogporten.WebApi/Common/Constants.cs (1)

21-21: LGTM! The simplified error message is clearer.

The simplified error message is more concise and aligns with the PR objective.

@oskogstad oskogstad merged commit 1d4bc9a into main Feb 4, 2025
23 checks passed
@oskogstad oskogstad deleted the chore/simplify-not-found-message branch February 4, 2025 12:14
arealmaas pushed a commit that referenced this pull request Feb 4, 2025
🤖 I have created a release *beep* *boop*
---


##
[1.48.2](v1.48.1...v1.48.2)
(2025-02-04)


### Miscellaneous Chores

* Add DelayedShutdownHostLifetime to GraphQL and Service
([#1785](#1785))
([34dea8c](34dea8c))
* Reduce CPU load threshold, up initialDelays
([#1789](#1789))
([26abb48](26abb48))
* refactor production deployment flow
([#1771](#1771))
([1b79f01](1b79f01))
* Simplify 404 NotFound swagger text
([#1791](#1791))
([1d4bc9a](1d4bc9a))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants