Skip to content

OAS3: Style/Explode parameter serialization #1140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Sep 29, 2017

Conversation

shockey
Copy link
Contributor

@shockey shockey commented Sep 28, 2017

This PR:

  • adds support for style and explode
  • constructs OAS3 requests based on default style/explode modes for each parameter type
  • adds tests for every style/explode/value type combination found at https://swagger.io/docs/specification/serialization/
  • adds allowReserved functionality, along with tests

Limitations:

  • deepObject does not handle nested objects. The specification and swagger.io documentation does not provide an example for serializing deep objects. Flat objects will be serialized into the deepObject style just fine.

@shockey shockey requested a review from webron September 29, 2017 01:53
@shockey
Copy link
Contributor Author

shockey commented Sep 29, 2017

@webron, mostly looking for you to either sign off on this PR with the limitation mentioned above, or give guidance on how to go about implementing nested object support 😄 thanks!

@webron
Copy link
Contributor

webron commented Sep 29, 2017

Why do you hate me, @shockey.

@webron
Copy link
Contributor

webron commented Sep 29, 2017

Okay. If you followed the documentation in https://swagger.io/docs/specification/serialization, and made sure the default values mentioned there are taken into account when no value is explicitly provided, it should be fine.

As for deepObject and nested objects - that was explicitly left out of the spec, and it's ok to just Not Support It™.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants