Adding azure accounts APIs by omarelhariry · Pull Request #4524 · Azure/azure-rest-api-specs

omarelhariry · 2018-11-20T20:17:38Z

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.

msftclas · 2018-11-20T20:17:49Z

All CLA requirements met.

AutorestCI · 2018-11-20T20:18:07Z

Automation for azure-sdk-for-js

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

AutorestCI · 2018-11-20T20:18:09Z

Automation for azure-sdk-for-python

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

AutorestCI · 2018-11-20T20:18:21Z

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

AutorestCI · 2018-11-20T20:18:45Z

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

AutorestCI · 2018-11-20T20:21:26Z

Automation for azure-sdk-for-go

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

AutorestCI · 2018-11-20T20:22:32Z

Automation for azure-sdk-for-node

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

azuresdkci · 2018-11-20T20:26:55Z

Can one of the admins verify this patch?

yangyuan · 2018-11-20T21:06:06Z

Hi @omarelhariry,

Have you reviewed changes with Azure API Review Board?
Feel free to contact me alias: yuanyang for further information.

Adding Publishing To Regions Status

specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json

...lane/LUIS/Authoring/stable/v2.0/examples/dispatch/SuccessfulAddConnectedServicesRequest.json

...e/LUIS/Authoring/stable/v2.0/examples/dispatch/SuccessfulDeleteConnectedServicesRequest.json

...lane/LUIS/Authoring/stable/v2.0/examples/dispatch/SuccessfulAddConnectedServicesRequest.json

...e/LUIS/Authoring/stable/v2.0/examples/dispatch/SuccessfulUpdateConnectedServicesRequest.json

...e/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json

sarangan12 · 2018-11-27T18:47:22Z

Please check the output of https://travis-ci.org/Azure/azure-rest-api-specs/jobs/460227670 and fix the errors

omarelhariry · 2018-11-28T12:25:27Z

@sarangan12 Fixed, please check now.

yangyuan · 2018-11-28T18:46:31Z

Hi @omarelhariry, any update from API review board?

omarelhariry · 2018-11-29T12:33:25Z

I believe @sarangan12 review is sufficient for that as per their response.

yangyuan · 2018-11-29T19:23:01Z

Hi @omarelhariry,
API Review Board will review the API design which won't be fully reviewed in here.
For example they will probably suggest to use lowerCamelCase in actions like azureaccounts.

AmirGeorge · 2018-12-02T12:06:03Z

specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json

+        }
+      }
+    },
+    "PackageBinaryStreamObject": {


@yangyuan can you advise on what needs to be done here? The API returns a byte array (binary octet stream) in the response. How could we document its response here?

For context, we do not want to give the users visibility on how to deserialize the object. We just instruct our users to call that API to export the model and import it back in a different place. So we want to expose the minimum amount of details about the response format.

We tried have this as type array, type string & type object but the three fail giving the following error:

FATAL: System.Collections.Generic.KeyNotFoundException: Please specify a field with type of System.Byte[] to deserialize the file contents to at AutoRest.Modeler.OperationBuilder.VerifyFirstPropertyIsByteArray(CompositeType serviceType) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\OperationBuilder.cs:line 441 at AutoRest.Modeler.OperationBuilder.TryBuildStreamResponse(HttpStatusCode responseStatusCode, OperationResponse response, Method method, List`1 types, IModelType headerType) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\OperationBuilder.cs:line 422 at AutoRest.Modeler.OperationBuilder.BuildResponses(Method method, CompositeType headerType) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\OperationBuilder.cs:line 336 at AutoRest.Modeler.OperationBuilder.BuildMethod(HttpMethod httpMethod, String url, String methodName, String methodGroup) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\OperationBuilder.cs:line 195 at AutoRest.Modeler.SwaggerModeler.BuildMethod(HttpMethod httpMethod, String url, String name, Operation operation) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\SwaggerModeler.cs:line 366 at AutoRest.Modeler.SwaggerModeler.Build(ServiceDefinition serviceDefinition) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\SwaggerModeler.cs:line 105 at AutoRest.Modeler.Program.<ProcessInternal>d__2.MoveNext() in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\Program.cs:line 60 --- End of stack trace from previous location where exception was thrown --- at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) at NewPlugin.<Process>d__15.MoveNext() FATAL: nodejs/imodeler1 - FAILED FATAL: Error: Plugin imodeler1 reported failure. Process() cancelled due to exception : Plugin imodeler1 reported failure. Error: Plugin imodeler1 reported failure.

Didn't test but I think it should be "format": "binary":

"PackageBinaryStreamObject": { "description": "The binary stream of the application package.", "type": "string", "format": "binary" }

You should also add "content": "application/octet-stream" in response.

About "we do not want to give the users visibility on how to deserialize the object."
Why not just exclude this from swagger?

@yangyuan format binary is also not working, giving same error.

On adding content type, I already have:

"produces": [ "application/octet-stream" ]

This is what we use in all our APIs to specify content type, is this what you mean? If there is another place to add "content": "application/octet-stream", please advise where.

And to answer your suggestion about excluding from swagger, we want the API to be visible for our users to call it but we do not want them to parse the response. Just call this API to export the app and import it elsewhere.

Weird, format binary is pretty common, surprisingly it's not supported.

But if that's the case, please refer to https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/ComputerVision.json
and use "type": "file"

For octet-stream, produces should be good enough.

@yangyuan a gentle reminder.

Please give me the exact command which causes the given error.
I started to think this might be other issues.

I checked travis log, didn't see this error.

I am not running any manual commands, I see the error in the automated PR build checks:
https://github.com/Azure/azure-rest-api-specs/pull/4524/checks?check_run_id=37479764

I pulled your branch, and run
autorest specification/cognitiveservices/data-plane/LUIS/Authoring/ --go
And I can see the exact same error.

Then I modify the "responses" of "/package/{appId}/versions/{versionId}/gzip" "/package/{appId}/slot/{slotName}/gzip" into below

"responses": { "200": { "description": "The GZip binary stream of the published application package.", "schema": { "type": "file" } } }

And the problem gone.
Which means "type": "file" is valid, and I suspect "format": "binary" can work too.

I debugged a little bit, this is the solution.

"produces": [ "application/octet-stream", "application/json" ],

The problem is you define the response can only be application/octet-stream, so autorest try to assert that all response should be binary format and gives error. :)

This reverts commit 3495ee0.

...ata-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json

praries880 · 2018-12-05T18:52:45Z

specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json

+              "$ref": "#/definitions/ProductionOrStagingEndpointInfo"
+            }
+          },
+          "503": {


error response modelling is not supported in autorest as of now.

praries880 · 2018-12-05T18:53:26Z

specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json

+              "$ref": "#/definitions/OperationStatus"
+            }
+          },
+          "429": {


Error responses are not supported by autorest as of now.

Add the error response to the default section. This applies all through this file.

@praries880 Can you explain more as the SDKs were generated successfully and the error responses were included in the SDKs with no problem like here.

Any update on this? @praries880

@praries880 any updates ? this is blocking our release before the holidays, appreciate if we can close on that before end of week

…describe the error responses

specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json

a-hohaze · 2018-12-06T14:36:43Z

specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json

+              "$ref": "#/definitions/ProductionOrStagingEndpointInfo"
+            }
+          },
+          "503": {


We don't document 5xx responses for now

But this one is thrown on purpose, it is not an arbitrary exception. Should it be removed too?

specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json

* Adding azure accounts APIs * Adding Publishing To Regions Status * fixes * fixing build errors * Fixing OAV errors * Add packaging APIs * fixing build errors * apply yangyuan suggestion * adding response content for gzip apis * Revert "adding response content for gzip apis" This reverts commit 3495ee0. * PackageBinaryStreamObject type as file * remove PackageBinaryStreamObject and directly add file type in response * specify body format in packaging response examples * adding content type in packaging response examples parameters * maybe a casing issue? * trying to remove the binary body from response parameters * Add application-json as a 2nd prdocues format for packaging APIs, to describe the error responses * fix * Updating operation ids * fix oav and remove error responses

Adding azure accounts APIs

4dd5524

omarelhariry requested a review from yangyuan as a code owner November 20, 2018 20:17

azuresdkci assigned sarangan12 Nov 20, 2018

azuresdkci requested a review from sarangan12 November 20, 2018 20:29

mohabghanem and others added 3 commits November 21, 2018 14:04

Adding Publishing To Regions Status

216d290

fixes

9834b9b

fixing build errors

431fada

Merge pull request #1 from omarelhariry/a-moghan/PublishingResponses

82cee8e

Adding Publishing To Regions Status

mo-abbas reviewed Nov 27, 2018

View reviewed changes

Fixing OAV errors

4289fc2

omar-el-hariry force-pushed the a-omelha/Azure_Accounts_APIs branch from 73291e5 to 4289fc2 Compare November 28, 2018 11:29

Azure deleted a comment from openapi-portal-comment bot Nov 30, 2018

omar-el-hariry force-pushed the a-omelha/Azure_Accounts_APIs branch from 5c1a516 to b3044bd Compare December 2, 2018 11:33

fixing build errors

ed6ee40

omar-el-hariry force-pushed the a-omelha/Azure_Accounts_APIs branch from b3044bd to ed6ee40 Compare December 2, 2018 11:41

AmirGeorge reviewed Dec 2, 2018

View reviewed changes

AmirGeorge added 3 commits December 3, 2018 21:06

apply yangyuan suggestion

0385ed2

adding response content for gzip apis

3495ee0

Revert "adding response content for gzip apis"

1ac86ec

This reverts commit 3495ee0.

sarangan12 removed their assignment Dec 3, 2018

sarangan12 removed their request for review December 3, 2018 21:46

sarangan12 added the Reassign label Dec 3, 2018

azuresdkci removed the Reassign label Dec 3, 2018

azuresdkci assigned praries880 Dec 3, 2018

azuresdkci requested a review from praries880 December 3, 2018 22:44

AmirGeorge added 6 commits December 4, 2018 14:10

PackageBinaryStreamObject type as file

2ded1b1

remove PackageBinaryStreamObject and directly add file type in response

c0f9f6b

specify body format in packaging response examples

3e12737

adding content type in packaging response examples parameters

c6429a1

maybe a casing issue?

8dacd4d

trying to remove the binary body from response parameters

631669e

KrzysztofCwalina reviewed Dec 4, 2018

View reviewed changes

...ata-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json Show resolved Hide resolved

praries880 suggested changes Dec 5, 2018

View reviewed changes

Add application-json as a 2nd prdocues format for packaging APIs, to …

c7d11c5

…describe the error responses

a-hohaze reviewed Dec 6, 2018

View reviewed changes

AmirGeorge and others added 2 commits December 6, 2018 16:57

fix

34ed7bb

Updating operation ids

b8ee038

nschonni mentioned this pull request Dec 11, 2018

fix: Example cognitiveservices\data-plane\LUIS\Authoring #4874

Closed

fix oav and remove error responses

32e19a3

praries880 approved these changes Dec 13, 2018

View reviewed changes

praries880 merged commit 7d344e2 into Azure:master Dec 13, 2018

Comments

Conversation

omarelhariry commented Nov 20, 2018

Latest improvements:

Contribution checklist:

Uh oh!

msftclas commented Nov 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AutorestCI commented Nov 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-js

Uh oh!

AutorestCI commented Nov 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Nov 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-ruby

Uh oh!

AutorestCI commented Nov 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-java

Uh oh!

AutorestCI commented Nov 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

AutorestCI commented Nov 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

azuresdkci commented Nov 20, 2018

Uh oh!

yangyuan commented Nov 20, 2018

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sarangan12 commented Nov 27, 2018

Uh oh!

omarelhariry commented Nov 28, 2018

Uh oh!

yangyuan commented Nov 28, 2018

Uh oh!

omarelhariry commented Nov 29, 2018

Uh oh!

yangyuan commented Nov 29, 2018

Uh oh!

AmirGeorge Dec 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AmirGeorge Dec 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

msftclas commented Nov 20, 2018 •

edited

Loading

AutorestCI commented Nov 20, 2018 •

edited

Loading

AutorestCI commented Nov 20, 2018 •

edited

Loading

AutorestCI commented Nov 20, 2018 •

edited

Loading

AutorestCI commented Nov 20, 2018 •

edited

Loading

AutorestCI commented Nov 20, 2018 •

edited

Loading

AutorestCI commented Nov 20, 2018 •

edited

Loading

AmirGeorge Dec 2, 2018 •

edited

Loading

AmirGeorge Dec 5, 2018 •

edited

Loading