search

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.64k stars 5.08k forks source link

Cognitive Services API missing #731

Closed kpfaulkner closed 6 years ago

kpfaulkner commented 7 years ago

Are the Azure Cognitive Services APIs going to be added to this repo? I see on the API sites (eg https://dev.projectoxford.ai/docs/services/56f91f2d778daf23d8ec6739/operations/56f91f2e778daf14a499e1fa ) that a Swagger definition is available.

If I were to contribute, would I simply need to gather these misc swagger files and add them to a forked repo and then PR? Or is this repo a lot more than that?

Thanks

Ken

mcardosos commented 7 years ago

There already is a swagger for cognitive services, but it look quite different than the one @kpfaulkner is linking. Maybe someone in Cognitive Services team knows a bit more? cc @daniel-ms

kpfaulkner commented 7 years ago

Hi

I thought the existing swagger was for management of the Cognitive services as opposed to actually "using" them (so to speak).

Actually nearly every swagger definition I've looked at in this repo seems to be about managing as opposed to using, or maybe I'm just looking at the wrong ones?

On 17 Nov. 2016, at 05:42, mcardosos notifications@github.com wrote:

There already is a swagger for cognitive services, but it look quite different than the one @kpfaulkner is linking. Maybe someone in Cognitive Services team knows a bit more? cc @daniel-ms

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

mcardosos commented 7 years ago

No, you are right. Most of this swaggers are for managing. The ones for using are the ones outside an arm folder.

kpfaulkner commented 7 years ago

In that case, doesn't that explain why the swagger is different? The existing one is for managing but from what I see each section of CSvcs (Face, Vision, Speech etc) all have their own Swagger definitions for the actual using of the APIs and not just managing?

mcardosos commented 7 years ago

Then my question for @daniel-ms would be more on the side of why that swagger doesn't live in this repo as a dataplane swagger.

salameer commented 7 years ago

Pinging @daniel-ms

felixwa commented 7 years ago

This swagger file is for managing Cognitive Services "accounts", that is, create/update/delete accounts. For using each individual Cognitive Services API (like Face, Vision etc.), you may want to use their own SDK in GitHub. And so far as I know they don't have swagger files. Hope this clarifies the situation and can we get this issue closed?

mcardosos commented 7 years ago

@felixwa The checked-in swagger if for managing accounts, yes. About the individual APIs there is a swagger available in the link @kpfaulkner provided (there is an API definition button in the corner that includes the swagger). We were wondering if there is a plan to merge that swagger here in this repo.

felixwa commented 7 years ago

@mcardosos , I see but no, we don't have plan to merge them here. In fact those swagger files are automatically generated by Azure API Management, not maintain by us. I don't think it provides much value we put them into this repo.

EDIT: for some APIs like Translator API this could be meaningful as they are not behind APIM. Let me sync up with the team and DEV owners of those APIs and get back to you.

salameer commented 6 years ago

Closing based on @felixwa last comment