ComputerVision - collection of fixes #3145
Conversation
* fix ocr language parameter to fix [bug](Azure/azure-sdk-for-net#4083) * language parameter missing for /tag path * language parameter missing for /models/*/analyze path * make /models/*/analyze return a more generic type * add specific types for /models/*/analyze to return for current models
Automation for azure-sdk-for-pythonThe initial PR has been merged into your service PR: |
Automation for azure-libraries-for-javaThe initial PR has been merged into your service PR: |
Automation for azure-sdk-for-nodeThe initial PR has been merged into your service PR: |
Automation for azure-sdk-for-rubyThe initial PR has been merged into your service PR: |
Automation for azure-sdk-for-goA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
Generated from [PR](Azure/azure-rest-api-specs#3145).
|
It's difficult to tell if Travis is having issues, but the breaking change is intentional. The OcrResult type was incorrect and un-serializable. |
| "Landmarks" | ||
| ] | ||
| "type": "string" | ||
| }, |
There was a problem hiding this comment.
Any specific reason to use raw string instead of enum? Are we are doing this to ensure customer can use SDK with content values those are not listed as known enum values (Celebrities, Landmarks)? If yes, then we could simply change "modelAsString": false to "modelAsString": true.
There was a problem hiding this comment.
Today we only have two custom (domain) models, but we want to reserve the right to add one without requiring a client SDK refresh. There's a method (/model) that will return the permissible values. Note that the hand-crafted version only takes a string.
| @@ -895,7 +895,8 @@ | |||
| "type": "object", | |||
| "properties": { | |||
| "language": { | |||
| "$ref": "#/definitions/OcrResult" | |||
| "type": "string", | |||
| "description": "The BCP-47 language code of the text in the image." | |||
There was a problem hiding this comment.
is this a breaking change in the server side? i.e. returning string instead of complex type?
There was a problem hiding this comment.
No the server for this type is unchanged for 2+ years. The swagger was just wrong.
There was a problem hiding this comment.
A bit of background - up to now most of our customers have been using a hand-built .net client SDK. We're bringing the swagger to par so that this will be the official package source moving forward.
There was a problem hiding this comment.
@cthrash thank you Chris for clarifying.
|
Are there more changes required? |
|
@cthrash merging this. |
[Communication] Fix linter validation errors and blocking GA issues
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger