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

fix: response examples fallback #7065

Merged
merged 2 commits into from
Mar 18, 2021

Conversation

mathis-m
Copy link
Contributor

Description

Just some minor bug fix which I found randomly.
Base line for fixing #5433

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

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.

Signed-off-by: mathis-m <mathis.michel@outlook.de>
@tim-lai
Copy link
Contributor

tim-lai commented Mar 18, 2021

@mathis-m what does this fix?

@mathis-m
Copy link
Contributor Author

mathis-m commented Mar 18, 2021

Add media-type examples with externalValue key on a response and see the rendered version it will be the actual value of the example. E.g. It will currently render a object containing summary and other keys of the actual oas example.

https://editor.swagger.io/?url=https://gist.githubusercontent.com/mathis-m/ee4df1970042b4ec95e44a1b9a647547/raw/322738cc65896eec853b5b324080783dba0d7d52/3FMuum97cx.txt

@mathis-m
Copy link
Contributor Author

mathis-m commented Mar 18, 2021

So the logic is if there is a media type example use it if no value could be found in the schema for this example key then it should just use the first example key's value.
This fallback logic was wrong it returned the examples/*/ instead of examples/*/vaule

@tim-lai tim-lai merged commit 9a2b646 into swagger-api:master Mar 18, 2021
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.

None yet

2 participants