Repository navigation
test: hold the Postman collection to the OpenAPI spec - #275
Merged
Merged
Conversation
The collection says it is generated from docs/openapi/viron-api.json, but nothing regenerates or checks it. PostmanCollectionDriftTest fails the build when the collection's operations, request names, raw URLs, query parameters, JSON bodies or bearer auth disagree with the spec. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (head 7f81bb7):
Judgment notes (non-blocking):
Do-not-auto-merge paths: none matched ( This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
This file contains hidden or 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
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.
Summary
postman/Viron.postman_collection.jsondescribes itself as "generated from docs/openapi/viron-api.json", but nothing regenerated or checked it, so it could drift silently.OpenApiSpecDriftTestalready holds the spec to the controllers; the newPostmanCollectionDriftTestholds the collection to the spec, closing the chain.VERB /pathset differs from the spec's operations (reported asmissing=/undocumented=), or a route appears twice;url.rawdisagrees with the method, path and query it actually sends;Content-Type: application/json;{{authToken}}, or any request overrides it.README.md's project-structure line forpostman/names the test.No tracking issue — gap found during triage. The committed collection currently agrees with the spec on all 36 operations, so no collection change was needed.
Test plan
mvn -B test— 752 tests, 0 failures (5 new inPostmanCollectionDriftTest).environmentz), an undeclared body property (bogus), an undeclared query parameter (nope) and a request-levelnoauthoverride, all 5 new tests fail, each naming the offending request.pytestis not affected by this change.Deferred issues
pom.xml) is beyond a single-cycle scope ceiling, as recorded on the issue.This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson