Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Cogs OCR] Remove optional mode parameter from CognitiveService OCR preview API for GA preparation #5931

Merged
merged 1 commit into from
May 16, 2019
Merged

[Cogs OCR] Remove optional mode parameter from CognitiveService OCR preview API for GA preparation #5931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,6 @@
"parameters": [
{
"$ref": "#/parameters/ImageUrl"
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was an SDK released for this already? These are breaking changes on a stable version of the API

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. There's was an SDK released already. But since there's a recent update from backend service, we want to remove the parameter.

Do you know which process we should follow for this kind of breaking change?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@toothache you will need to release new major versions for all the released SDKs so as to not break existing customers.
This will need an API review too

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dsgouda we have reviewed the GA version API, in which mode parameter is removed, with API review board before. But we're also sending mail to confirm it.

{
"$ref": "#/parameters/TextRecognitionMode"
}
],
"consumes": [
Expand Down Expand Up @@ -241,9 +238,6 @@
"parameters": [
{
"$ref": "#/parameters/ImageStream"
},
{
"$ref": "#/parameters/TextRecognitionMode"
}
],
"consumes": [
Expand Down
1 change: 0 additions & 1 deletion ...ces/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithStream.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"mode": "Printed",
"Image": "{binary}"
},
"responses": {
Expand Down
1 change: 0 additions & 1 deletion ...rvices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulBatchReadFileWithUrl.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"mode": "Printed",
"ImageUrl": "{url}"
},
"responses": {
Expand Down