Standard location for Swagger 'definition'

[Alexander Henket]

Is there a defined way to find out of service X has a Swagger definition available? E.g. HTTP OPTIONS, a defined endpoint call, a GET with Accept: application/xml+swagger or any other method?

[tony tam]

No, it’s a matter of convention not policy how and where a swagger definition is located.

On Nov 21, 2016, at 11:21 AM, Alexander Henket <hen...@nictiz.nl> wrote:

Is there a defined way to find out of service X has a Swagger definition available? E.g. HTTP OPTIONS, a defined endpoint call, a GET with Accept: application/xml+swagger or any other method?

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Alexander Henket]

That is disappointing. Was standardizing that ever considered?

[tony tam]

It was too much to ask several years ago when the project was still young.  With 3.0 there is a chance we will have this.

[Alexander Henket]

Any idea towards what direction the solution is leaning?

You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/rT-FTHU-1RI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

[Tony Tam]

Getting it mounted at a specific location is impossible--my preference is options + accept header with a formally registered type. I hope we end up with that solution. 

[Alexander Henket]

That sounds like a fine candidate to me. We already have a service running at [base] with a defined call for the 'contract' we call CapabilityStatement. The functionality of that overlaps with the goals of Swagger. There's currently discussion on whether the same or most that info could be offered using Swagger too. Hence the question.

The defined call for getting the CapabilityStatement is [base]/metadata or with HTTP OPTIONS. This would be a good fit:

GET [base]/metadata {?_format=[mime-type]}

or

OPTIONS [base] {?_format=[mime-type]}

or using the Accept header obviously.

Thanks

Alexander Henket

[Tom Christie]

> With 3.0 there is a chance

Are the design discussions, issues, etc for v3 available publicly anywhere?

I've had a look around the swagger-api GitHub organisation but don't see anything obvious there.

Thanks & all the best,

  Tom

[tony tam]

Yes, if you look here:

https://github.com/OAI/OpenAPI-Specification/blob/master/README.md

You’ll see a link:

Looking for the next version of the OpenAPI Specification? See here.

That takes you to a branch, with an updated README explaining the process, etc.  Finally, the working version of the spec is here:

https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md

If you have suggestions for making it more obvious (you’re not the first to ask), please pass them on