[ADLA - ADLS] - Adding existing account APIs that are missing in Swagger by ro-joowan · Pull Request #1807 · Azure/azure-rest-api-specs

ro-joowan · 2017-10-05T22:07:08Z

Added the following existing APIs
- Account_CheckNameAvailability
- Location_GetCapability
- Operation_List
Successfully tested these APIs by generating the C# SDK and executing them
Added example files for these APIs

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

The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

anuchandy

@ro-joowan, overall looks good, added some minor feedback, please take a look.

Given that you are just adding existing APIs to the swagger, I am assuming these APIs are approved by ARM review board, right?

anuchandy · 2017-10-06T17:25:54Z

...tion/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json

In order to be consistent with tag, operationId naming convention, use tag as Accounts and operationId as Accounts_CheckNameAvailability.

For this one I would like to leave as is for this PR because we currently have existing APIs for "Account_Get", "Account_Create", etc. We will make the fix to "Accounts" in an upcoming API version, 2017-10-01, which has other breaking changes -- as we would like to bundle the breaking changes together.

anuchandy · 2017-10-06T17:26:34Z

...tion/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json

tags -> Locations, operationId -> Locations_GetCapability

Fixed -- thank you!

anuchandy · 2017-10-06T17:26:53Z

...tion/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json

tags -> Locations, operationId -> Locations_List

Fixed -- thank you!

anuchandy · 2017-10-09T17:20:07Z

specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json

Account ->Accounts, Account_CheckNameAvailability -> Accounts_CheckNameAvailability

For this one I would like to leave as is for this PR because we currently have existing APIs for "Account_Get", "Account_Create", etc. We will make the fix to "Accounts" in an upcoming API version, 2017-10-01, which has other breaking changes -- as we would like to bundle the breaking changes together.

anuchandy · 2017-10-09T17:20:54Z

specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json

use {plural}_{verb}

Fixed -- thank you!

anuchandy · 2017-10-09T17:21:06Z

specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json

use {plural}_{verb}

Fixed -- thank you!

* Added the following existing APIs * Account_CheckNameAvailability * Location_GetCapability * Operation_List * Successfully tested these APIs by generating the C# SDK and executing them * Added example files for these APIs

azuresdkciprbot · 2017-10-09T18:13:20Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/datalake-analytics/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 7
After the PR: Warning(s): 0 Error(s): 6

File: specification/datalake-store/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 7
After the PR: Warning(s): 0 Error(s): 6

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

ro-joowan · 2017-10-09T18:21:09Z

@anuchandy, These APIs that I am adding were requested by the ARM team for us to add and other services have these exact APIs already.

Thank you!

azuresdkciprbot · 2017-10-09T18:24:07Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/datalake-analytics/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 7
After the PR: Warning(s): 0 Error(s): 6

File: specification/datalake-store/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 7
After the PR: Warning(s): 0 Error(s): 6

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2017-10-09T18:24:07Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/datalake-analytics/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 7
After the PR: Warning(s): 0 Error(s): 6

File: specification/datalake-store/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 7
After the PR: Warning(s): 0 Error(s): 6

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

ro-joowan · 2017-10-09T18:37:12Z

@anuchandy, Also, could you please provide a link where it says that we should use {plural}_{verb}? This was a question we had internally, and the link would be a helpful reference for us in the future.

anuchandy · 2017-10-10T01:31:46Z

@ro-joowan sorry this is not documented. I checked with few reviewers, this is not a hard requirement but nice to have a consistency. Some of the reason for choosing plural are -

If the segment in the endpoint pointing to the collection is plural then it is good to use the similar name for the operation group. e.g. the root url for operation on availability set is /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/..." so it is recommended to have the operation group name as AvailabilitySets
It is not allowed to have the same name for both operation group and model name. In such cases it is recommended to use plural for the operation group name https://github.com/Azure/azure-rest-api-specs/blob/current/documentation/openapi-authoring-automated-guidelines.md#r2063-operationidnounconflictingmodelnames.

ro-joowan · 2017-10-10T18:58:54Z

@anuchandy Thank you for that. Can we proceed with the merge?

anuchandy · 2017-10-11T01:52:50Z

@ro-joowan sure, merging..

AutorestCI · 2017-10-11T01:55:44Z

No modification for AutorestCI/azure-sdk-for-node

AutorestCI · 2017-10-11T01:56:15Z

Azure/azure-sdk-for-ruby#1040

Changing the hot readonly memory props to bool...

azuresdkci assigned anuchandy Oct 5, 2017

anuchandy requested changes Oct 9, 2017

View reviewed changes

[CODE - FILE] - Adding missing account APIs

6c0a28b

* Added the following existing APIs * Account_CheckNameAvailability * Location_GetCapability * Operation_List * Successfully tested these APIs by generating the C# SDK and executing them * Added example files for these APIs

ro-joowan force-pushed the missing-account-apis branch from 98fca31 to 6c0a28b Compare October 9, 2017 18:07

[CODE - FILE] - Correcting tags and operationIds

a310a93

[CODE] - Fixing descriptions

a7558ea

anuchandy approved these changes Oct 11, 2017

View reviewed changes

anuchandy merged commit de178f7 into Azure:current Oct 11, 2017

AutorestCI mentioned this pull request Oct 11, 2017

Automatic PR from RestAPI-PR1807 Azure/azure-sdk-for-ruby#1040

Closed

ro-joowan deleted the missing-account-apis branch October 11, 2017 19:47

mccleanp pushed a commit that referenced this pull request Mar 23, 2022

Merge pull request #1807 from Azure/dev/subbart/booleanfix

33d23d4

Changing the hot readonly memory props to bool...

Conversation

ro-joowan commented Oct 5, 2017 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

anuchandy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ro-joowan Oct 9, 2017 • 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!

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!

azuresdkciprbot commented Oct 9, 2017

Uh oh!

ro-joowan commented Oct 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azuresdkciprbot commented Oct 9, 2017

Uh oh!

azuresdkciprbot commented Oct 9, 2017

Uh oh!

ro-joowan commented Oct 9, 2017

Uh oh!

anuchandy commented Oct 10, 2017

Uh oh!

ro-joowan commented Oct 10, 2017

Uh oh!

anuchandy commented Oct 11, 2017

Uh oh!

AutorestCI commented Oct 11, 2017

Uh oh!

AutorestCI commented Oct 11, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ro-joowan commented Oct 5, 2017 •

edited by azuresdkci

Loading

ro-joowan Oct 9, 2017 •

edited

Loading

ro-joowan commented Oct 9, 2017 •

edited

Loading