Microsoft

How can we improve Computer Vision API?

Generate Human friendly operationId in swagger

Almost all tools that can generate API Client out of Swagger API defenition, will use OperationId to generate method name in a client. In your swagger API, OperationIds looks like "56f91f2e778daf14a499e1fa", and in C# it will produce method name public System.Threading.Tasks.Task 56f91f2e778daf14a499e1faAsync();
It's extremely hard to recognize what method doing, based on this operationID

Please, modify operationIds in a swagger documentation https://westus.dev.cognitive.microsoft.com/docs/services/5adf991815e1060e6355ad44/export?DocumentFormat=Swagger&ApiName=Computer%20Vision%20API%20-%20v2.0 to make it human and code generator tools friendly.

P.S. I got this swagger file from https://westus.dev.cognitive.microsoft.com/docs/services/5adf991815e1060e6355ad44/operations/587f2c6a154055056008f200

2 votes
Sign in
(thinking…)
Sign in with: Facebook Google
Signed in as (Sign out)

We’ll send you updates on this idea

Igor Sychev shared this idea  ·   ·  Flag idea as inappropriate…  ·  Admin →

0 comments

Sign in
(thinking…)
Sign in with: Facebook Google
Signed in as (Sign out)
Submitting...

Feedback and Knowledge Base