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.

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

Conversation

toothache
Copy link
Member

@toothache toothache commented May 13, 2019

Now read/core/asyncBatchAnalyze API is in public preview state. It will be GA soon.

In our public preview version, we have an optional parameter Mode. In GA, this parameter is not necessary anymore, because we introduce auto mode detection for better user experience.

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@AutorestCI
Copy link

AutorestCI commented May 13, 2019

Automation for azure-sdk-for-ruby

Encountered a Subprocess error: (azure-sdk-for-ruby)

Command: ['/usr/local/bin/autorest', '/tmp/tmplns6z1_t/rest/specification/cognitiveservices/data-plane/ComputerVision/readme.md', '--perform-load=false', '--swagger-to-sdk', '--output-artifact=configuration.json', '--input-file=foo', '--output-folder=/tmp/tmpink6zz3n']
Finished with return code 7
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.12.0]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
Failure:
Error: Unable to start AutoRest Core from /root/.autorest/@microsoft.azure_autorest-core@2.0.4370/node_modules/@microsoft.azure/autorest-core
Error: Unable to start AutoRest Core from /root/.autorest/@microsoft.azure_autorest-core@2.0.4370/node_modules/@microsoft.azure/autorest-core
    at main (/opt/node_modules/autorest/dist/app.js:232:19)
    at <anonymous>

/root/.autorest/@microsoft.azure_autorest-core@2.0.4370/node_modules/@microsoft.azure/autorest-core/dist/app.js:33
    autorest_core_1.Shutdown();
    ^
ReferenceError: autorest_core_1 is not defined
    at process.on (/root/.autorest/@microsoft.azure_autorest-core@2.0.4370/node_modules/@microsoft.azure/autorest-core/dist/app.js:33:5)
    at emitOne (events.js:121:20)
    at process.emit (events.js:211:7)
    at process.emit (/node_modules/source-map-support/source-map-support.js:439:21)
fs.js:612
  return binding.close(fd);
                 ^

Error: EBADF: bad file descriptor, close
    at Object.fs.closeSync (fs.js:612:18)
    at StaticVolumeFile.shutdown (/opt/node_modules/autorest/dist/static-loader.js:352:10)
    at StaticFilesystem.shutdown (/opt/node_modules/autorest/dist/static-loader.js:406:17)
    at process.exit.n [as exit] (/opt/node_modules/autorest/dist/static-loader.js:169:11)
    at printErrorAndExit (/node_modules/source-map-support/source-map-support.js:423:11)
    at process.emit (/node_modules/source-map-support/source-map-support.js:435:16)
    at process._fatalException (bootstrap_node.js:391:26)

@AutorestCI
Copy link

AutorestCI commented May 13, 2019

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#4946

@AutorestCI
Copy link

AutorestCI commented May 13, 2019

Automation for azure-sdk-for-js

A 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:
Azure/azure-sdk-for-js#2968

@AutorestCI
Copy link

AutorestCI commented May 13, 2019

Automation for azure-sdk-for-java

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-java#3039

@AutorestCI
Copy link

AutorestCI commented May 13, 2019

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#4819

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@toothache
Copy link
Member Author

toothache commented May 13, 2019

Hi, @dsgouda . SDK python conversion is failing. However, it also fails at master branch. Any idea why this is happening?

FATAL: python/transform - FAILED
FATAL: TypeError: Cannot read property 'replace' of null
Process() cancelled due to exception : Cannot read property 'replace' of null
  TypeError: Cannot read property 'replace' of null

@dsgouda
Copy link
Contributor

dsgouda commented May 13, 2019

@daschult could you take a look at the failures

@ghost
Copy link

ghost commented May 13, 2019

@dsgouda I wish I could help, but I really don't know anything about the existing Swagger To SDK service. You need to bring in @lmazuel for that.

@dsgouda
Copy link
Contributor

dsgouda commented May 13, 2019

@lmazuel can you take a look

@@ -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.

@lmazuel
Copy link
Member

lmazuel commented May 13, 2019

@dsgouda Autorest for Python cannot generate the Swagger in this PR. I don't know at this point if it's a Swagger issue where Autorest should be smart with a clear message, or if this a bug in Autorest for Python.

@dsgouda dsgouda added the APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. label May 13, 2019
@toothache toothache changed the title [Cogs OCR] Remove mode parameter from CognitiveService OCR GA API. [Cogs OCR] Remove mode parameter from CognitiveService OCR API May 14, 2019
@toothache toothache changed the title [Cogs OCR] Remove mode parameter from CognitiveService OCR API [Cogs OCR] Remove optional mode parameter from CognitiveService OCR preview API for GA preparation May 14, 2019
Copy link
Contributor

@dsgouda dsgouda left a comment

Choose a reason for hiding this comment

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

API review board approved it offline

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. potential-sdk-breaking-change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants