Swagger Schema 2.0 ApiKey

[lidonis]

I just read schema.json for swagger v2.0 after trying swagger editor.

I have a problem with apiKeySecurity because there is only "header" and "query" but no "path" param.

I need to put my apiKey as path param. How can i do that ?

[webron]

Swagger 2.0 doesn't support an api key security as a path parameter. I don't think we ever encountered such a use case.

The only thing you can do is use a regular path parameter to define it, and it won't be part of the security schemes.

[lidonis]

OK, thank you for your response. I'll use a regular path parameter.

I hope it will be added in the next version.

[webron]

@lidonis - have you seen this kinda of REST design anywhere else?

The reason I ask is because this way of structuring your URL seems un-REST-ful. The path itself is normally used as a resource locator (hence, URL), and the API Key shouldn't really be part of the resource locator.

I'm not saying it's wrong - there isn't really right or wrong here - I'm just surprised at the design. So, I wonder if it is based on some common practice of which I'm not aware.

[lidonis]

Yeah, the API is quite "un-REST-ful". Thas not the only problem in the design but i have too deal with it.

I have seen this design at https://trakt.tv/api-docs.

[webron]

Thanks for the reference!

[webron]

Parent: #585.

[LasneF]

@webron, @MikeRalphson

looks very corner case, not seeing any API Management tooling doing like that

should the issue be closed to narrow down the feature list ? as not retains for OAS 3.0 neither 3.1 ?

[handrews]

2.0 is long past the point of patch releases, and the use case seems too small to track given the lack of engagement in the past 8 years. If there is a clear use case with enough support, this is probably best considered under Moonwalk and re-opened there.