Allow providing sample requests and responses about openapi-specification

[vad]

I don't understand how to use this... I don't see any reference in the specification

[Siva]

HI, I see this a very useful feature for our project documentation. Any idea when this can be included in the spec?

[fehguy]

We're working on this for the 2.0 spec right now.

[fehguy]

and thanks @vlcinsky for putting down all these thoughts.

[Siva]

Awesome. thanks! Any idea when 2.0 spec will be out?

[fehguy]

july :)

[Siva]

Hi, I wanted to ping and check on the status of 2.0 spec since we are getting near the end of july. Are you guys still planning on releasing this july? Appreciate your help.

BTW we already started using the spec recently. You guys are doing great job with spec and it really helped us a lot on documenting our services. great work. Kudos!!!

[fehguy]

Hi, we're just about there--might be a week behind but it's worth the wait.

[Siva]

Great thank you!!!

[webron]

This has been added to Swagger 2.0.

[webron]

@vad - for responses, check out https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responseExamples. For requests, watch out for a more elaborate explanation in the upcoming weeks.

[gmannos]

@webron @vlcinsky - Any update for request example thing?
another question - is basePathExamples not going to be used now ? as i saw for response, example can be published in 'elements' filed of Response Object.

[Nouhi]

@fehguy is there any news regarding this issue it's seems to be closed but the functionality isn't available

[foragerr]

@webron @fehguy Any updates on request example documentation?

[webron]

@foragerr it's not supported explicitly at the current version but is under discussion for the next version. We introduced a vendor extension in swagger-ui to support it, but it's not an official part of the spec.

[foragerr]

Thanks @webron ! Is that how you do this?

What is the vendor-extension called?

[webron]

No, that's just derived from the 'example' in model definitions that exists today. For body parameters it is called x-examples, for others x-example.

[marians]

Just to get this right, describing request examples is not part of the 2.0 spec?

[darrelmiller]

@marians You can put an example on a schema that is used by a body parameter. So it is possible, but parameter objects do not support example objects directly in 2.0.