-
Notifications
You must be signed in to change notification settings - Fork 3
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
Conversation
📝 WalkthroughWalkthroughThe 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
Suggested Reviewers
Tip 🌐 Web search-backed reviews and chat
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this 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
📒 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.
🤖 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).
No description provided.