Repository navigation
Use OpenAPI path templates instead of Koa params - #325
Merged
Merged
Conversation
Paths like /1/shops/:id failed Swagger validation (parameter is not
defined within path template). Generated and recorded paths now use
/1/shops/{id}; the docs portal maps its :id route strings to match.
API ChangesOperations
|
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.
What
services/api/src/utils/openapi.js: generated and recorded path keys now use OpenAPI templates (/1/shops/{id}) instead of Koa params (/1/shops/:id), via a newtoOpenApiPath().services/api/openapi.json: existing path keys renamed in place, so recorded examples and edited descriptions are kept.services/web/src/docs/utils/index.js:getRoutePathmaps:idto{id}, so the MDX<Route route="GET /1/shops/:id" />tags work without changes.Why
Swagger rejected the spec with "parameter is not defined within path template". 25 path params across the spec had this error.
Notes for reviewers
items must be a schema or array of schemasonShop.address.geometry.coordinates(prefixItems+items: false). This PR leaves it alone: it is a valid OpenAPI 3.1 / JSON Schema 2020-12 tuple, and the error comes from Swagger's validator.