Repository navigation
feat(openapi): support serialization of path parameters - #957
Open
abhi-byte62 wants to merge 1 commit into
Open
abhi-byte62 wants to merge 1 commit into
abhi-byte62 wants to merge 1 commit into
Conversation
Adds support for OpenAPI 3 path parameter serialization options (style and explode), matching query/header/cookie parameters in plainJsonObjectToOpenapi3. Fixes fastify#912
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
1 participant
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.
Problem
OpenAPI 3.0/3.1 specifies serialization rules (\style\ and \explode) for path parameters in addition to query, header, and cookie parameters (e.g. \matrix, \label, and \simple\ styles). In \lib/spec/openapi/utils.js, \plainJsonObjectToOpenapi3()\ supported \style\ and \explode\ for query/header/cookie parameters, but the \path\ container case omitted them when building the parameter object.
Fix
Add \style\ and \explode\ propagation in \ oOpenapiProp\ for the \path\ container in \lib/spec/openapi/utils.js, matching the serialization behavior of query parameters. Also update README documentation to reference path parameter serialization support.
Tests
pm test\ — passed (all 299 tests pass, TypeScript typings pass, 100% test coverage maintained).
pm run lint\ — passed (eslint clean, 0 errors/warnings).
Related issue
Fixes #912
Checklist
pm run test\