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

Response examples should respect media-type #6456

Merged
merged 15 commits into from
Oct 16, 2020

Conversation

mathis-m
Copy link
Contributor

@mathis-m mathis-m commented Oct 2, 2020

Description

Response examples 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

Fixes #6442

How Has This Been Tested?

  • in browser
  • via new tests for the bug

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.

@tim-lai
Copy link
Contributor

tim-lai commented Oct 2, 2020

@mathis-m looks like linting errors that fail CI

@mathis-m
Copy link
Contributor Author

mathis-m commented Oct 2, 2020

@tim-lai gonna fix that in some hours

@mathis-m
Copy link
Contributor Author

mathis-m commented Oct 4, 2020

My approach is to override the response schema's example in case there is a matching media type example defined.
And use the new schema with the getSampleSchema util to generate a matching example.

src/core/components/response.jsx Outdated Show resolved Hide resolved
@tim-lai
Copy link
Contributor

tim-lai commented Oct 7, 2020

still failing CI. this time in bugs/5458.js

should pass json instead of map upsi fixes ci
@mathis-m
Copy link
Contributor Author

mathis-m commented Oct 8, 2020

still failing CI. this time in bugs/5458.js

fixed.

@mathis-m
Copy link
Contributor Author

mathis-m commented Oct 8, 2020

My approach is to override the response schema's example in case there is a matching media type example defined.
And use the new schema with the getSampleSchema util to generate a matching example.

In case of xml this will not work as described in #6470

@tim-lai tim-lai merged commit 87ab4e9 into swagger-api:master Oct 16, 2020
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.

Response examples do not respect media-type
3 participants