Named DiagnosticSettings by vcanaa · Pull Request #1641 · Azure/azure-rest-api-specs

vcanaa · 2017-09-06T22:00:57Z

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.

sergey-shandar · 2017-09-08T00:43:31Z

@ravbhatnagar please, have a look. It's a new API version.

ravbhatnagar

@vcanaa - please take a look

ravbhatnagar · 2017-09-12T00:30:21Z

...esource-manager/microsoft.insights/2017-05-01-preview/diagnosticsSettingsCategories_API.json

+          "DiagnosticSettingsCategories"
+        ],
+        "operationId": "DiagnosticSettingsCategory_Get",
+        "description": "Gets the diagnostic settings category for the specified resource.",


Please indicate some of the typical values resourceUri could take to help customers understand this.

This is explicit in the example with a logic app.

Is it too difficult to add it to the description? SDK users rely on description, API docs rely on description.

Any change in the description breaks the generation, so it requires more work that touches all our classes. I created a task on us to fix that.

ravbhatnagar · 2017-09-12T00:31:19Z

...esource-manager/microsoft.insights/2017-05-01-preview/diagnosticsSettingsCategories_API.json

+    },
+    "DiagnosticSettingsCategory": {
+      "properties": {
+        "categoryType": {


Make this an enum

I consider Enum bad practice when serialization is involved. If we introduce a new type, customers will be forced to update the sdk or the serialization will break.

Yes and that is the recommendation. Enum will make your API more usable. Else how will someone know when you support new types? When you support new types, you add the enum value and increment the APi version

I don't like enums in serialization, but I am taking this feedback since more people seem to like them.

ravbhatnagar · 2017-09-12T00:31:58Z

...esource-manager/microsoft.insights/2017-05-01-preview/diagnosticsSettingsCategories_API.json

+          "readOnly": true,
+          "description": "Azure resource type"
+        },
+        "location": {


I don't think there should be location or tags here. Isnt this a proxy resource.

It is a proxy resource, but these are populated anyway when the request comes back. Also the resource class is shared by everything. It has been that way for a long time.

I believe we could have another class for proxy resource, but I prefer addressing that in a different release.

Can we get an ACK in email with a workitem that this will be addressed in the next release? Apologies, but this is the only way to get the APIs cleaned up across Azure plat. I wont remember this comment in a few months and no one else on your team will :). So it will most likely be missed in the next rev also.

Created a task for this

ravbhatnagar · 2017-09-13T00:37:25Z

Discussed over email and there are workitems created to address the feedback. Approving for now.

sergey-shandar · 2017-09-13T20:57:17Z

...or/resource-manager/microsoft.insights/2017-05-01-preview/examples/getDiagnosticSetting.json

+        "tags" : null,
+        "properties" : {
+          "storageAccountId" : "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
+          "serviceBusRuleId" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey",


The response model DiagnosticSettings doesn't have ServiceBusRuleId property and no additional properties are accepted.

sergey-shandar · 2017-09-13T21:00:56Z

...-manager/microsoft.insights/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json

+    "parameters": {
+        "resourceUri": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6",
+        "api-version": "2017-05-01-preview",
+        "parameters": {


Error: parameter name is missing.

sergey-shandar · 2017-09-13T21:09:01Z

...esource-manager/microsoft.insights/2017-05-01-preview/diagnosticsSettingsCategories_API.json

@@ -0,0 +1,271 @@
+{


Operations API should be implemented.

sergey-shandar · 2017-09-13T21:09:30Z

.../monitor/resource-manager/microsoft.insights/2017-05-01-preview/diagnosticsSettings_API.json

@@ -0,0 +1,499 @@
+{


Operations API should be implemented.

sergey-shandar · 2017-09-13T23:49:31Z

@ravbhatnagar a new commit has a new file specification/monitor/resource-manager/microsoft.insights/2015-04-01/operations_API.json. It looks like we need your approval again.

sergey-shandar

Preliminary comments. I haven't looked the new operation api file yet, I'm waiting for ARM review.

ravbhatnagar · 2017-09-13T23:54:25Z

Looks good. @sergey-shandar @veronicagg - FYI that the operations API and the response could be converted to a linter rule since its standard.

sergey-shandar · 2017-09-13T23:54:27Z

@vcanaa let me know when it's ready for review. It's hard to review a moving target :-)

vcanaa · 2017-09-13T23:57:43Z

This is ready for review.

sergey-shandar · 2017-09-13T23:58:59Z

@vcanaa thank you :-) I'm reviewing the code. It will take a while since it's big and we have a lot of other PRs for Ignite.

vcanaa · 2017-09-15T01:40:52Z

I was not sure if you were waiting for the sdk PR or not until a saw a new tag ReadyForSdkReview. So I sent a new PR for the sdk now.

vcanaa · 2017-09-15T01:41:50Z

I renamed the spec to:
[Monitor] Adding Operations API and making DiagnosticSettings ProxyOnly resource

So it is more informative.

azuresdkciprbot · 2017-09-16T00:59:38Z

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

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-09-16T01:11:43Z

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/monitor/resource-manager/readme.md
Before the PR: Warning(s): 23 Error(s): 10
After the PR: Warning(s): 26 Error(s): 9

AutoRest Linter Guidelines | AutoRest Linter Issues

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

Thanks for your co-operation.

sergey-shandar · 2017-09-16T01:18:17Z

...ification/monitor/resource-manager/microsoft.insights/2015-04-01/examples/OperationList.json

+              "operation":"Operations read",
+              "description":"Reading operations"
+            },
+            "properties":{


The "properties" property is not allowed according to "Operation" definition.

sergey-shandar · 2017-09-16T01:27:29Z

...ce-manager/microsoft.insights/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json

@@ -0,0 +1,22 @@
+{
+  "parameters" : {
+    "resourceUri" : "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6",


The parameter resourceUri starts with a forward slash and the path template: /{resourceUri}/providers/microsoft.insights/diagnosticSettingsCategories/{name} contains a forward slash before the parameter starts. This will cause double forward slashes in the request url. Thus making it incorrect. Please rectify the example.'

sergey-shandar · 2017-09-16T01:39:22Z

...ce-manager/microsoft.insights/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json

+        "name":"WorkflowRuntime",
+        "location":"eastus",
+        "tags":null,
+        "properties": {


tag and location aren't allowed in #/definitions/DiagnosticSettingsCategoryResource

sergey-shandar · 2017-09-16T01:39:56Z

.../resource-manager/microsoft.insights/2017-05-01-preview/examples/listDiagnosticSettings.json

+        "value": [ 
+          {
+            "id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting",
+            "type":"microsoft.logic/workflows",


The parameter resourceUri starts with a forward slash and the path template: /{resourceUri}/providers/microsoft.insights/diagnosticSettingsCategories/{name} contains a forward slash before the parameter starts. This will cause double forward slashes in the request url. Thus making it incorrect. Please rectify the example.'

sergey-shandar · 2017-09-16T01:41:05Z

.../resource-manager/microsoft.insights/2017-05-01-preview/examples/listDiagnosticSettings.json

+            "type":"microsoft.logic/workflows",
+            "name":"mysetting",
+            "location":"eastus",
+            "tags":null,


tag and location aren't allowed in #/definitions/DiagnosticSettingsCategoryResource.

sergey-shandar · 2017-09-16T01:44:47Z

...esource-manager/microsoft.insights/2017-05-01-preview/diagnosticsSettingsCategories_API.json

+                    "type":"microsoft.insights/diagnosticSettingsCategories",
+                    "name":"WorkflowRuntime",
+                    "location":"eastus",
+                    "tags":null,


tag and location aren't allowed in #/definitions/DiagnosticSettingsCategoryResource.

sergey-shandar · 2017-09-16T01:46:50Z

...-manager/microsoft.insights/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json

+        "name":"mysetting",
+        "location":"",
+        "tags":null,
+        "properties": {


tag and location shouldn't be in response, according to model definition.

sergey-shandar · 2017-09-16T01:49:16Z

.../monitor/resource-manager/microsoft.insights/2017-05-01-preview/diagnosticsSettings_API.json

+                "name":"mysetting",
+                "location":"eastus",
+                "tags":null,
+                "properties": {


tag and location shouldn't be in the response according to DiagnosticSettingsResource

sergey-shandar · 2017-09-16T01:55:09Z

...esource-manager/microsoft.insights/2017-05-01-preview/diagnosticsSettingsCategories_API.json

+        }
+      ],
+      "properties": {
+        "properties": {


Add description.

sergey-shandar

Currently, the main problem is models which don't have tag and location as properties but examples do have them.

sergey-shandar

As an exception.

AutorestCI · 2017-09-16T02:08:33Z

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

AutorestCI · 2017-09-16T02:08:41Z

Azure/azure-sdk-for-ruby#979

AutorestCI · 2017-09-16T02:09:22Z

Azure/azure-sdk-for-python#1445

vcanaa added 2 commits August 30, 2017 14:00

Named DiagnosticSettings

a47419e

Merge remote-tracking branch 'upstream/current' into current2

b004a34

msftclas added the cla-not-required label Sep 6, 2017

azuresdkci assigned sergey-shandar Sep 6, 2017

vcanaa mentioned this pull request Sep 7, 2017

[Monitor] Diagnostic settings commands Azure/azure-sdk-for-net#3668

Merged

8 tasks

sergey-shandar added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 8, 2017

ravbhatnagar suggested changes Sep 12, 2017

View reviewed changes

ravbhatnagar added ReadyForSDKReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 12, 2017

[Monitor] Making CategoryType enum

1b32026

ravbhatnagar approved these changes Sep 13, 2017

View reviewed changes

ravbhatnagar added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 13, 2017

sergey-shandar reviewed Sep 13, 2017

View reviewed changes

[Monitor] Removing serviceBusRuleId from getDiagnosticSettings example.

b5b15f2

sergey-shandar reviewed Sep 13, 2017

View reviewed changes

[Monitor] Fix validation errors regarding operations api

40082bf

sergey-shandar added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Sep 13, 2017

sergey-shandar reviewed Sep 13, 2017

View reviewed changes

sergey-shandar 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 Sep 13, 2017

vcanaa mentioned this pull request Sep 15, 2017

[Monitor] Adding Operations API and making DiagnosticSettings ProxyOnly resource Azure/azure-sdk-for-net#3705

Merged

8 tasks

Fix JSON errors

ece23e4

Fix JSON

15c38b0

sergey-shandar reviewed Sep 16, 2017

View reviewed changes

sergey-shandar suggested changes Sep 16, 2017

View reviewed changes

sergey-shandar approved these changes Sep 16, 2017

View reviewed changes

sergey-shandar merged commit bc5e15f into Azure:current Sep 16, 2017

AutorestCI mentioned this pull request Sep 16, 2017

Automatic PR from RestAPI-PR1641 Azure/azure-sdk-for-ruby#979

Merged

AutorestCI mentioned this pull request Sep 16, 2017

[MgmtMonitor] Named DiagnosticSettings Azure/azure-sdk-for-python#1445

Closed

vcanaa deleted the current2 branch September 18, 2017 17:29

Conversation

vcanaa commented Sep 6, 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!

sergey-shandar commented Sep 8, 2017

Uh oh!

ravbhatnagar left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ravbhatnagar commented Sep 13, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sergey-shandar Sep 13, 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!

sergey-shandar commented Sep 13, 2017

Uh oh!

sergey-shandar left a comment

Choose a reason for hiding this comment

Uh oh!

ravbhatnagar commented Sep 13, 2017

Uh oh!

sergey-shandar commented Sep 13, 2017

Uh oh!

vcanaa commented Sep 13, 2017

Uh oh!

sergey-shandar commented Sep 13, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vcanaa commented Sep 15, 2017

Uh oh!

vcanaa commented Sep 15, 2017

Uh oh!

azuresdkciprbot commented Sep 16, 2017

Uh oh!

azuresdkciprbot commented Sep 16, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sergey-shandar Sep 16, 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

vcanaa commented Sep 6, 2017 •

edited by azuresdkci

Loading

sergey-shandar Sep 13, 2017 •

edited

Loading

sergey-shandar commented Sep 13, 2017 •

edited

Loading

sergey-shandar Sep 16, 2017 •

edited

Loading

sergey-shandar Sep 16, 2017 •

edited

Loading