Admin Swagger Specs for Commerce, Fabric, and Infrastructure Insights by deathly809 · Pull Request #1592 · Azure/azure-rest-api-specs

deathly809 · 2017-08-25T22:50:20Z

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.

Known validation issues

Commerce

Not implemented yet. When I try to access this I get an exception.

ERROR (OperationsAPIImplementation/R3023/RPCViolation): Operations API must be implemented for '/providers/Microsoft.Commerce/operations'.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/commerce/resource-manager/Microsoft.Commerce.Admin/2015-06-01-preview/swagger/commerceAdmin.json:16:1 ($.paths)

Fabric

Not implemented yet. When I try to access this I get an exception.

ERROR (OperationsAPIImplementation/R3023/RPCViolation): Operations API must be implemented for '/providers/Microsoft.Fabric.Admin/operations'.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/SlbMuxInstance.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/ScaleUnitNode.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/ScaleUnit.json:17:2 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/Operations.json:11:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/MacAddressPool.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/LogicalSubnet.json:17:2 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/Volume.json:17:2 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/StorageSystem.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/StoragePool.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/LogicalNetwork.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/IpPool.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/InfraRoleInstance.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/InfraRole.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/FileShare.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/FabricLocation.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/EdgeGatewayPool.json:17:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/EdgeGateway.json:17:2 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/Fabric.json:17:1 ($.paths)

WARNING (EnumInsteadOfBoolean/R3018/RPCViolation): Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: networkVirtualizationEnabled
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/LogicalNetwork.json:123:16 ($.definitions.LogicalNetworkModel.properties.networkVirtualizationEnabled)
WARNING (EnumInsteadOfBoolean/R3018/RPCViolation): Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPublic
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/LogicalSubnet.json:129:8 ($.definitions.LogicalSubnetModel.properties.isPublic)

This is to fix a naming issue. Without this Autorest appends Property (I think) to the end of the name and cannot deserialize the results from the RP.

ERROR (XmsClientNameProperty/R2013/SDKViolation): Value of 'x-ms-client-name' cannot be the same as 'provisioningState' Property/Model.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/Operations.json:112:12 ($.definitions.ProvisioningState.properties)

It is either true or false.

WARNING (EnumInsteadOfBoolean/R3018/RPCViolation): Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: canPowerOff
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/ScaleUnitNode.json:299:16 ($.definitions.ScaleUnitNodeModel.properties.canPowerOff)

This only works on a multi-node environment and I don't have one.

ERROR (XmsExamplesRequired/R2022/SDKViolation): Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'InfraRoles_ScaleUp'
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/InfraRole.json:19:12 ($.paths["/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/infraRoles/{infraRole}/ScaleUp"].post)

This only works on a multi-node environment and I don't have one.

ERROR (XmsExamplesRequired/R2022/SDKViolation): Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ScaleUnits_ScaleOut'
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/fabric/resource-manager/Microsoft.Fabric.Admin/2016-05-01/swagger/ScaleUnit.json:19:6 ($.paths["/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/ScaleOut"].post)

InfrastructureInsights

Not implemented yet. When I try to access this I get an exception.

ERROR (OperationsAPIImplementation/R3023/RPCViolation): Operations API must be implemented for '/providers/Microsoft.InfrastructureInsights.Admin/operations'.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/serviceHealth.json:11:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/resourceHealth.json:11:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/regionHealth.json:11:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/alert.json:11:4 ($.paths)
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/infrastructureinsights.json:16:1 ($.paths)

If I do this I cannot perform an operation. Newtonsoft has an issue where it cannot serialize readonly variables.

ERROR (RequiredPropertiesMissingInResourceModel/R2020/RPCViolation): Model definition 'Alert' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/alert.json:142:8 ($.definitions.Alert)

If I do this I cannot perform an operation. Newtonsoft has an issue where it cannot serialize readonly variables.

ERROR (RequiredPropertiesMissingInResourceModel/R2020/RPCViolation): Model definition 'RegionHealth' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/regionHealth.json:98:8 ($.definitions.RegionHealth)

If I do this I cannot perform an operation. Newtonsoft has an issue where it cannot serialize readonly variables.

ERROR (RequiredPropertiesMissingInResourceModel/R2020/RPCViolation): Model definition 'ResourceHealth' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/resourceHealth.json:107:8 ($.definitions.ResourceHealth)

If I do this I cannot perform an operation. Newtonsoft has an issue where it cannot serialize readonly variables.

ERROR (RequiredPropertiesMissingInResourceModel/R2020/RPCViolation): Model definition 'ServiceHealth' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/serviceHealth.json:97:8 ($.definitions.ServiceHealth)

I don't know why the RP did this but you can only change a single variable from "Open" to "Closed" and then pass it using a PUT.

WARNING (PutInOperationName/R1006/SDKViolation): 'PUT' operation 'Alerts_Close' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    - file:///C:/temp/azure-rest-api-specs/specification/azsadmin/infrastructureinsights/resource-manager/Microsoft.InfrastructureInsights.Admin/2016-05-01/swagger/alert.json:103:16 ($.paths["/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/alerts/{alertName}"].put.operationId)

msftclas · 2017-08-25T22:50:24Z

@deathly809,
Thanks for your contribution as a Microsoft full-time employee or intern. You do not need to sign a CLA.
Thanks,
Microsoft Pull Request Bot

sarangan12 · 2017-08-25T23:37:16Z

@deathly809 Please take a look at the build jobs here: https://travis-ci.org/Azure/azure-rest-api-specs/builds/268547010?utm_source=github_status&utm_medium=notification

There are 2 sets of jobs: Regular & Allowed Failure Jobs. Here Regular Jobs must be completed successfully for approval. In this case, one of the regular jobs failed. Take a look at: https://travis-ci.org/Azure/azure-rest-api-specs/jobs/268547011

There are 25 errors which are listed at https://travis-ci.org/Azure/azure-rest-api-specs/jobs/268547011#L3678. I have looked at these errors and the messages seem to be self explanatory. Please fix them and update the PR

deathly809 · 2017-08-26T00:14:44Z

@sarangan12

I have gone through and fixed all the issues except one specific error. It says I cannot use x-ms-headers but the RP team returns the location to an operation status in the headers.

What should I do about the header issue? Is there a way to get a waiver?

sarangan12 · 2017-08-30T20:32:29Z

specification/azsadmin/resource-manager/fabric/readme.md

+    - "Microsoft.Fabric.Admin/2016-05-01/Volume.json"
+    - "Microsoft.Fabric.Admin/2016-05-01/LogicalSubnet.json"
+    - "Microsoft.Fabric.Admin/2016-05-01/MacAddressPool.json"
+    - "Microsoft.Fabric.Admin/2016-05-01/Operations.json"


The name of the file is oncorrect. operations.json vs Operations.json. Please fix

azuresdkciprbot · 2017-08-30T23:15:53Z

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/azsadmin/resource-manager/InfrastructureInsights/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

File: specification/azsadmin/resource-manager/commerce/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

File: specification/azsadmin/resource-manager/fabric/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 3 Error(s): 5

AutoRest Linter Guidelines | AutoRest Linter Issues

Send feedback and make AutoRest Linter Azure Bot smarter day by day!

Thanks for your co-operation.

azuresdkciprbot · 2017-08-30T23:31:04Z

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/azsadmin/resource-manager/InfrastructureInsights/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 1 Error(s): 6

File: specification/azsadmin/resource-manager/commerce/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

File: specification/azsadmin/resource-manager/fabric/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 3 Error(s): 5

AutoRest Linter Guidelines | AutoRest Linter Issues

Send feedback and make AutoRest Linter Azure Bot smarter day by day!

Thanks for your co-operation.

AutorestCI · 2017-08-30T23:47:14Z

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

AutorestCI · 2017-08-30T23:47:41Z

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

AutorestCI · 2017-08-30T23:49:45Z

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

Jeffrey A. Robinson added 2 commits August 25, 2017 15:37

Admin Swagger Specs for Commerce, Fabric, and Infrastructure Insights

baf4896

Added Security region to each json

b1c24b4

msftclas added the cla-not-required label Aug 25, 2017

salameer assigned sarangan12 Aug 25, 2017

Jeffrey A. Robinson added 3 commits August 28, 2017 08:42

Fixed Validation Errors

b2f740e

Fixed validation issues, reorganized folders

2145372

Fixed issues with long running operations and refences.

ffe7abe

sarangan12 suggested changes Aug 30, 2017

View reviewed changes

Jeffrey A. Robinson added 2 commits August 30, 2017 15:05

Fixed Operation.json references.

89da245

Renamed files and changed capitalization

c5c6954

Missed renaming of health rp

fd5267e

sarangan12 approved these changes Aug 30, 2017

View reviewed changes

sarangan12 merged commit 999521d into Azure:current Aug 30, 2017

deathly809 mentioned this pull request Sep 1, 2017

Azure Stack Admin for Commerce, Fabric, and InfrastructureInsights Azure/azure-sdk-for-net#3649

Closed

8 tasks

deathly809 mentioned this pull request Sep 12, 2017

Azure Stack Admin for Commerce, Fabric, and InfrastructureInsights Azure/azure-sdk-for-net#3689

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Admin Swagger Specs for Commerce, Fabric, and Infrastructure Insights#1592

Admin Swagger Specs for Commerce, Fabric, and Infrastructure Insights#1592
sarangan12 merged 8 commits intoAzure:currentfrom
deathly809:current

deathly809 commented Aug 25, 2017

Uh oh!

msftclas commented Aug 25, 2017

Uh oh!

sarangan12 commented Aug 25, 2017

Uh oh!

deathly809 commented Aug 26, 2017 •

edited

Loading

Uh oh!

sarangan12 Aug 30, 2017

Uh oh!

azuresdkciprbot commented Aug 30, 2017

Uh oh!

azuresdkciprbot commented Aug 30, 2017

Uh oh!

AutorestCI commented Aug 30, 2017

Uh oh!

AutorestCI commented Aug 30, 2017

Uh oh!

AutorestCI commented Aug 30, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

deathly809 commented Aug 25, 2017

PR information

Quality of Swagger

Known validation issues

Commerce

Fabric

InfrastructureInsights

Uh oh!

msftclas commented Aug 25, 2017

Uh oh!

sarangan12 commented Aug 25, 2017

Uh oh!

deathly809 commented Aug 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sarangan12 Aug 30, 2017

Choose a reason for hiding this comment

Uh oh!

azuresdkciprbot commented Aug 30, 2017

Uh oh!

azuresdkciprbot commented Aug 30, 2017

Uh oh!

AutorestCI commented Aug 30, 2017

Uh oh!

AutorestCI commented Aug 30, 2017

Uh oh!

AutorestCI commented Aug 30, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

deathly809 commented Aug 26, 2017 •

edited

Loading