Fix contract so it matches the backend Swagger#600
Open
chetanr25 wants to merge 1 commit into
Open
Conversation
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.
Fix contract so it matches the backend Swagger
Why
Once we could render
contracts/as Swagger, a few things did not match what the backend serves at/docs. The contract is meant to be the source of truth, so these gaps needed fixing.Error logs
What was wrong
Broken zipcode paths. The root
openapi.yamlpointed atpath/zipcode.yaml#/postal_codeandpath/zipcode.yaml#/location. Neither exists. The zipcode file only ever defined one operation, and the real route isGET /api/v1/zipcode/lookup-address. Swagger threw two errors over the missing references and the actual endpoint was not shown at all.Wrong grouping for weather and zipcode. The backend shows weather and zipcode as their own sections. The contract put both under one
external-apistag, so the rendered docs grouped them differently from the running API.What changed
lookup-address, pointing at the operation actually defined in the file.weatherandzipcodeto match the backend, and updated the tag list inopenapi.yaml.Result
The contract now resolves with no broken references and groups endpoints the same way the backend
/docsdoes.Related issue: #599