Skip to content

feat(sample-gen): yaml sample generation #6858

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

Conversation

mathis-m
Copy link
Contributor

@mathis-m mathis-m commented Jan 20, 2021

Description

if content / media type matches yaml or yml it will generate stringified sample like for json
in addition to that it will proccess the json sample vis js-yaml to the final yaml sample result

Motivation and Context

Fixes #6857
Originally requested by @deltafsdevelopment in #6470 (comment)

How Has This Been Tested?

browser
Todo: cypress tests

Screenshots (if appropriate):

image

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 Jan 21, 2021

So... while application/yaml isn't an actual media type, and that there exists multiple ways to express yaml, e.g. 'text/yaml', based on the xml implementation as precedence, we can move forward with this as a new feature.

Copy link
Contributor

@tim-lai tim-lai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add a test for media-type 'text/yaml'

if content / media type matches yaml or yml it will generate stringified sample like for json
in addition to that it will generate yaml out of the json sample

Signed-off-by: mathis-m <[email protected]>
@mathis-m mathis-m force-pushed the feature/yaml-content-type-sample-en branch from 6904350 to b6e3bf9 Compare January 24, 2021 01:27
@mathis-m
Copy link
Contributor Author

@tim-lai done

@mathis-m mathis-m requested a review from tim-lai January 25, 2021 20:36
@tim-lai tim-lai merged commit 470e2fe into swagger-api:master Jan 25, 2021
@tim-lai
Copy link
Contributor

tim-lai commented Jan 25, 2021

@mathis-m Thanks again! This PR is now merged!

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.

Are there any plans to add support for yaml media type examples?
2 participants