Add Microsoft.Web ResourceHealthMetadata swagger #2588

pavelzel · 2018-03-03T01:29:15Z

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.

Adding a new set of Resource Health Metadata API swagger files for Microsoft.Web

…wagger file Update the Microsoft.Web autorest config to test validity of the ResourceHealthMetadata swagger file

AutorestCI · 2018-03-03T01:31:40Z

Automation for azure-sdk-for-python

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-python#2065

AutorestCI · 2018-03-03T01:34:40Z

Automation for azure-sdk-for-go

A PR has been created for you:
Azure/azure-sdk-for-go#1336

fearthecowboy · 2018-03-05T16:36:46Z

Greetings @pavelzel !

These look like new APIs, so I'm going to ask @ravbhatnagar to do a quick review as well.

Straight off they look pretty good; were you going to add x-ms-examples for these APIs?

Adding examples for the Microsoft.Web ResourceHealthMetdata APIs

AutorestCI · 2018-03-07T02:23:32Z

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

pavelzel · 2018-03-07T02:40:03Z

@fearthecowboy Added x-ms-examples as requested

pavelzel · 2018-03-08T18:32:41Z

@fearthecowboy @ravbhatnagar , is there anything else you need from me for this PR?

fearthecowboy · 2018-03-08T19:18:50Z

Your examples are failing validation: https://travis-ci.org/Azure/azure-rest-api-specs/jobs/350123757

ravbhatnagar · 2018-03-09T08:42:47Z

specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json

+            "$ref": "#/parameters/apiVersionParameter"
+          }
+        ],
+        "responses": {


Add "default" response to all APIs to capture error cases. Schema complies with the ARM RPC error contract. example from Batch RP swagger.

@ravbhatnagar This looks to be a newer requirement for swagger files. Since we (Microsoft.Web) auto-generate our swagger files from code, is it okay to not have the "default" response for this file while we work on adding support for this in the auto-generation?

Fixed up the responses to have a default error response

ravbhatnagar · 2018-03-09T08:43:50Z

specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json

+        "properties": {
+          "description": "ResourceHealthMetadata resource specific properties",
+          "properties": {
+            "category": {


Is this a candidate for an enum?

This is a string as per spec provided by the RHC team, relevant part of spec:
Category (string) - this is the category of the sku that you have communicated to RHC. RHC Rp will select the policy based on this value. If the sku's category does not match existing categories, we will fall back to the default category

ravbhatnagar · 2018-03-09T08:44:37Z

specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json

+              "description": "The category that the resource matches in the RHC Policy File",
+              "type": "string"
+            },
+            "signalAvailability": {


ideally this should be an enum with multiple states. Currently you might just require true or false for this but in future as scenario evolves you might want to indicate more states.

Same as category, this is a boolean as per the spec I was given by RHC team:
SignalAvailability (boolean) - This field is to notify us if the signal for a resource is reaching us or not. This can come into picture when you are aware that a particular set of resources (possibly belonging a test region or a legacy region) are not sending RHC signals. When this is false, we will put the corresponding resource into unknown events bucket.

ravbhatnagar · 2018-03-09T08:45:31Z

@fearthecowboy - no blocking feedback from my side. Feel free to merge based on response to above comments.

The location should not have been populated for the Microsoft.Web ResourceHealthMetadata API examples. The single ResourceHealthMetadata GET call should return ResourceHealthMetadata and not a collection of them

AutorestCI · 2018-03-13T17:55:42Z

Automation for azure-libraries-for-java

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-libraries-for-java#327

Adding the default errror responses to the Microsoft.Web ResourceHealthMetadata API swagger

For Microsoft.Web ResourceHealthMetadata APIs renaming the default error response from ErrorResponse to DefaultErrorResponse to fix the python SDK generation. The DefaultErrorResponse will be the default error response for our other APIs in the future as well

jhendrixMSFT · 2018-03-16T18:03:13Z

@AutorestCI rebuild azure-sdk-for-go

pavelzel · 2018-03-16T23:58:44Z

@fearthecowboy is there anything else you need from me for this PR?

fearthecowboy · 2018-03-19T15:59:04Z

Looks good to me @pavelzel -- you want me to merge this now?

pavelzel · 2018-03-19T16:38:07Z

@fearthecowboy Yes, please go ahead and merge. Thank you!

azuresdkciprbot · 2018-03-19T17:11:54Z

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:

💡 Please review potentially introduced Error(s)/Warning(s): Analysis Report 💡

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

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

jhendrixMSFT · 2018-03-19T19:21:40Z

@AutorestCI rebuild azure-sdk-for-go

…nfix Replace cred with placeholder

pavelzel added 2 commits March 2, 2018 17:08

Adding Microsoft.Web ResourceHealthMetadata APIs

63fb383

Adding a new set of Resource Health Metadata API swagger files for Microsoft.Web

Update autorest config to test Microsoft.Web ResourceHealthMetadata s…

db6bc0a

…wagger file Update the Microsoft.Web autorest config to test validity of the ResourceHealthMetadata swagger file

azuresdkci assigned fearthecowboy Mar 3, 2018

AutorestCI mentioned this pull request Mar 3, 2018

[AutoPR web/resource-manager] Add Microsoft.Web ResourceHealthMetadata swagger Azure/azure-sdk-for-python#2097

Closed

AutorestCI mentioned this pull request Mar 3, 2018

[AutoPR web/resource-manager] Add Microsoft.Web ResourceHealthMetadata swagger Azure/azure-sdk-for-go#1192

Closed

fearthecowboy assigned ravbhatnagar Mar 5, 2018

fearthecowboy added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 5, 2018

Adding ResourceHealthMetadata examples

9379cb4

Adding examples for the Microsoft.Web ResourceHealthMetdata APIs

ravbhatnagar reviewed Mar 9, 2018

View reviewed changes

ravbhatnagar added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 9, 2018

Correcting examples for Microsoft.Web ResourceHealthMetadata APIs

ee8f87a

The location should not have been populated for the Microsoft.Web ResourceHealthMetadata API examples. The single ResourceHealthMetadata GET call should return ResourceHealthMetadata and not a collection of them

AutorestCI mentioned this pull request Mar 13, 2018

[AutoPR web/resource-manager] Add Microsoft.Web ResourceHealthMetadata swagger Azure/azure-libraries-for-java#265

Merged

pavelzel added 2 commits March 14, 2018 15:34

Microsoft.Web ResourceHealthMetadata API adding default error response

e65d1b7

Adding the default errror responses to the Microsoft.Web ResourceHealthMetadata API swagger

AutorestCI mentioned this pull request Mar 16, 2018

[AutoPR web/resource-manager] Add Microsoft.Web ResourceHealthMetadata swagger Azure/azure-sdk-for-go#1294

Closed

fearthecowboy approved these changes Mar 19, 2018

View reviewed changes

fearthecowboy added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Mar 19, 2018

fearthecowboy merged commit 3220723 into Azure:master Mar 19, 2018

AutorestCI mentioned this pull request Mar 19, 2018

[AutoPR web/resource-manager] Add Microsoft.Web ResourceHealthMetadata swagger Azure/azure-sdk-for-go#1327

Closed

AutorestCI mentioned this pull request Mar 19, 2018

[AutoPR web/resource-manager] Add Microsoft.Web ResourceHealthMetadata swagger Azure/azure-sdk-for-go#1336

Merged

pavelzel mentioned this pull request Mar 22, 2018

WebSites ResourceHealthMetadata APIs and Tests Azure/azure-sdk-for-net#4156

Merged

9 tasks

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

Merge pull request #2588 from PhoenixHe-msft/tih/RPSaaSMaster-credsca…

1f97bf3

…nfix Replace cred with placeholder

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Microsoft.Web ResourceHealthMetadata swagger #2588

Add Microsoft.Web ResourceHealthMetadata swagger #2588

pavelzel commented Mar 3, 2018 •

edited by azuresdkci

Loading

AutorestCI commented Mar 3, 2018 •

edited

Loading

AutorestCI commented Mar 3, 2018 •

edited

Loading

fearthecowboy commented Mar 5, 2018

AutorestCI commented Mar 7, 2018 •

edited

Loading

pavelzel commented Mar 7, 2018

pavelzel commented Mar 8, 2018

fearthecowboy commented Mar 8, 2018

ravbhatnagar Mar 9, 2018

pavelzel Mar 13, 2018

pavelzel Mar 15, 2018

ravbhatnagar Mar 9, 2018

pavelzel Mar 10, 2018

ravbhatnagar Mar 9, 2018

pavelzel Mar 10, 2018

ravbhatnagar commented Mar 9, 2018

AutorestCI commented Mar 13, 2018 •

edited

Loading

jhendrixMSFT commented Mar 16, 2018

pavelzel commented Mar 16, 2018

fearthecowboy commented Mar 19, 2018

pavelzel commented Mar 19, 2018

azuresdkciprbot commented Mar 19, 2018

jhendrixMSFT commented Mar 19, 2018

Add Microsoft.Web ResourceHealthMetadata swagger #2588

Add Microsoft.Web ResourceHealthMetadata swagger #2588

Conversation

pavelzel commented Mar 3, 2018 • edited by azuresdkci Loading

PR information

Quality of Swagger

AutorestCI commented Mar 3, 2018 • edited Loading

Automation for azure-sdk-for-python

AutorestCI commented Mar 3, 2018 • edited Loading

Automation for azure-sdk-for-go

fearthecowboy commented Mar 5, 2018

AutorestCI commented Mar 7, 2018 • edited Loading

Automation for azure-sdk-for-node

pavelzel commented Mar 7, 2018

pavelzel commented Mar 8, 2018

fearthecowboy commented Mar 8, 2018

ravbhatnagar Mar 9, 2018

Choose a reason for hiding this comment

pavelzel Mar 13, 2018

Choose a reason for hiding this comment

pavelzel Mar 15, 2018

Choose a reason for hiding this comment

ravbhatnagar Mar 9, 2018

Choose a reason for hiding this comment

pavelzel Mar 10, 2018

Choose a reason for hiding this comment

ravbhatnagar Mar 9, 2018

Choose a reason for hiding this comment

pavelzel Mar 10, 2018

Choose a reason for hiding this comment

ravbhatnagar commented Mar 9, 2018

AutorestCI commented Mar 13, 2018 • edited Loading

Automation for azure-libraries-for-java

jhendrixMSFT commented Mar 16, 2018

pavelzel commented Mar 16, 2018

fearthecowboy commented Mar 19, 2018

pavelzel commented Mar 19, 2018

azuresdkciprbot commented Mar 19, 2018

jhendrixMSFT commented Mar 19, 2018

pavelzel commented Mar 3, 2018 •

edited by azuresdkci

Loading

AutorestCI commented Mar 3, 2018 •

edited

Loading

AutorestCI commented Mar 3, 2018 •

edited

Loading

AutorestCI commented Mar 7, 2018 •

edited

Loading

AutorestCI commented Mar 13, 2018 •

edited

Loading