Skip to content
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

Request Body examples should respect media-type #6739

Merged
merged 2 commits into from
Jan 4, 2021

Conversation

mathis-m
Copy link
Contributor

Description

Request Body samples do not respect the media type selected.
It just stringifies the json representation of the sample provided via examples or example keyword.
It should use the getSampleSchema method, which does take care of the content-type // media-type.

Motivation and Context

How Has This Been Tested?

Fixes #6475

Screenshots (if appropriate):

see #6475

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@mathis-m mathis-m marked this pull request as draft December 20, 2020 17:53
@mathis-m mathis-m marked this pull request as ready for review December 20, 2020 18:40
@mathis-m
Copy link
Contributor Author

@tim-lai its been a while, could you have a look at this PR and pull it into mainline. It fixes the sample generation for request body related to #6470 .

@tim-lai tim-lai merged commit 68e9b1b into swagger-api:master Jan 4, 2021
@tim-lai
Copy link
Contributor

tim-lai commented Jan 4, 2021

@mathis-m Catching up on holiday backlog. This PR is now merged. Thanks for the fix!

@mathis-m
Copy link
Contributor Author

mathis-m commented Jan 4, 2021

@tim-lai nice :) best wishes for the new year!

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.

requestBody examples do not respect media-type
2 participants