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

OAS3 multi examples in requestbody #3616

Closed
wants to merge 37 commits into from
Closed

OAS3 multi examples in requestbody #3616

wants to merge 37 commits into from

Conversation

biggates
Copy link

This provides multiple examples in OAS3 examples in requestBody.

@biggates
Copy link
Author

biggates commented Aug 28, 2017

visual_effect

using OAS3 spec attached here

@biggates
Copy link
Author

The rendering of externalValue as a link (<a href="location" target="_blank">) is a bit odd here. Should it be fetched and displayed directly in a <HighlightCode> component ? Maybe only apply to text/* is better?

@webron
Copy link
Contributor

webron commented Sep 11, 2017

@biggates thanks for the contribution and sorry for the delayed response. I'd like to take a bit of a closer look into the implementation. This is not exactly what I had in mind for implementing it, though it's definitely a needed solution.

Would you be open to change it based on feedback and also apply the same behavior to responses and regular parameters?

@shockey shockey mentioned this pull request Sep 12, 2017
22 tasks
@biggates
Copy link
Author

Would you be open to change it based on feedback and also apply the same behavior to responses and regular parameters?

@webron Sure, I'm glad to contribute on this.

So this branch will work with 3.2.2
which causes 'There are multiple modules with names that only differ in
casing.'
@shockey
Copy link
Contributor

shockey commented Sep 29, 2017

@webron, bump 😄

@biggates
Copy link
Author

biggates commented Sep 30, 2017

@shockey I'm still working on this, the current progress looks like this:

image

using the definition https://gist.github.com/biggates/4955d608379a8b1b3224e815c7dd0dc9

I'm not sure whether this is what you have in mind, so I still keep the examples in response as my previous implmentation.

Also the examples in parameters is not finished yet. Maybe I should close this PR for now and re-open one later?

…as3/multi-examples-in-requestBody

# Conflicts:
#	src/core/plugins/oas3/components/index.js
Added support for parameter examples in OAS3.

Known Issues:

* In "Try It Out" mode, all example tabs are redered as "active" and
their values are all displayed
@biggates
Copy link
Author

biggates commented Nov 1, 2017

Oops, this breaks RequestBodyEditor. 😭

@galuszkak
Copy link

@biggates is it possible to rebase it to the master and merge in near future?

ffissore added a commit to engagetech/swagger-ui that referenced this pull request Jan 9, 2018
Merged from swagger-api#3616, then
collected and re-applied the diff to have a nice git history
@ffissore ffissore mentioned this pull request Jan 10, 2018
10 tasks
@shockey
Copy link
Contributor

shockey commented Feb 10, 2018

Closing in favor of #4092.

@shockey shockey closed this Feb 10, 2018
ffissore pushed a commit to engagetech/swagger-ui that referenced this pull request May 14, 2018
Merged from swagger-api#3616, then
collected and re-applied the diff to have a nice git history
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.

5 participants