[DDO-3219] Fix upsert API methods and add Swagger comment test #329
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Kudos, SonarCloud Quality Gate passed!
|
What's New
|
mikeflinn
approved these changes
Oct 13, 2023
Codecov Report
@@ Coverage Diff @@
## main #329 +/- ##
=======================================
Coverage 63.23% 63.23%
=======================================
Files 147 147
Lines 8671 8671
=======================================
Hits 5483 5483
Misses 2813 2813
Partials 375 375
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a mismatch between what the router was configured for (PUT) and what the Swagger comments were building the client libraries to use (POST).
Tiny fix, but like #327, an easy mistake to make.
Testing
This PR adds an introspective test that mocks the router configuration to collect the API routes that the running server will end up supporting. With that list assembled, it will then iterate over the raw source code files to assert that each configured route is declared exactly once (and nothing else is declared).
This catches a wide variety of mismatches between the Swagger comments and the Gin configuration, including method mismatches like this one, route typos, or omitted Swagger documentation.
Risk
Very low