Specs for Microsoft.PolicyInsights GA version (2018-04-04) #2929

bulentelmaci · 2018-04-23T22:09:46Z

Adding swagger specs for Microsoft.PolicyInsights GA version "2018-04-04". The specs are identical to the latest preview version "2017-12-12-preview", except addition of a property to response schema of */summarize paths (PolicyDefinitionSummary schema has the new property "policyDefinitionReferenceId").

Also added to readme.md and made it the default version.

Please diff 2017-12-12-preview specs with 2018-04-04 specs to see the limited set of changes.

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.

…approval request pending) suppressions; add new suppression for equivalent paths error (approval request pending)

…body to a single string

…onalProperties; add @odata.count to operations; remove "type" from "rows" in first 2017-08-09-preview and add descriptions

…files for each version (one per namespace is sufficient as long as both files are fed into autorest as a bundle)

…ition

…ition (old API versions)

Reorganize files (remove resource type based subfolders; rename conflicting example files to have resource type name; change swagger spec files and MD file based on new file locations and names); change modelAsString for x-ms-enum to true based on API review board recommendation

AutorestCI · 2018-04-23T22:10:29Z

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

AutorestCI · 2018-04-23T22:11:04Z

Automation for azure-sdk-for-python

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

AutorestCI · 2018-04-23T22:11:15Z

Automation for azure-libraries-for-java

The initial PR has been merged into your service PR:
AutorestCI/azure-libraries-for-java#124

AutorestCI · 2018-04-23T22:14:18Z

Automation for azure-sdk-for-go

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

azuresdkciprbot · 2018-04-23T22:14:33Z

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/policyinsights/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-23T22:14:33Z

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/policyinsights/resource-manager/readme.md

⚠️

0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

ravbhatnagar · 2018-04-25T07:10:12Z

...policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json

@@ -30,7 +30,7 @@
    }
  },
  "paths": {
-    "/{managementGroupId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": {
+    "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": {


Why is this modeled as an enum instead of putting the value of the namespace in the URL itself?

autorest/oav validation does not like it. Errors out saying that a spec can only be defined for one namespace. This is the workaround I had found in our previous release. It results in identical API; since it is a single valued enum, it turns into a const string part of path.

As a note, there is no change here from previous version. The change you pointed out the comment on was done on the previous version to fix a different validation issue where multiple paths with matching template but different path parameter names (e.g. managementGroupId, vs. policyDefinitionId, etc.) was not acceptable.

ravbhatnagar · 2018-04-25T07:12:47Z

...policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json

        }
      }
    },
-    "/{policySetDefinitionId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": {
+    "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": {


authorizationnamespace - why an enum? instead of putting Microsoft.Authorization

Please see above.

ravbhatnagar · 2018-04-25T07:16:16Z

...policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json

@@ -1079,9 +1247,15 @@
        }
      }
    },
-    "Operations": {
+    "OperationsListResults": {
      "description": "List of available operations.",
      "properties": {


The schema of this should comply with RPC - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/proxy-api-reference.md#exposing-available-operations

There is no change to this from the previous version. I am not able to see what is incompliant. Could you please point out specific parts?

ravbhatnagar · 2018-04-26T22:08:36Z

Looks good. Signing off!

mcardosos · 2018-04-27T17:44:43Z

...policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json

+  "paths": {
+    "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": {
+      "post": {
+        "operationId": "PolicyEvents_ListQueryResultsForManagementGroup",


PolicyEvents_ListQueryResultsForManagementGroup [](start = 24, length = 47)

Could this be a pageable operation?

We don't support paging right now. There is no change in this version from the previous one with respect to that

Well, the returing schema does not need to have a next link. In the extension, the next link can be set to null, but still generate cool code to iterate on the array.
WDYT?

See example 3
https://github.com/Azure/autorest/tree/master/docs/extensions#x-ms-pageable

In reply to: 184759379 [](ancestors = 184759379)

mcardosos · 2018-04-27T17:48:10Z

...policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json

+          },
+          {
+            "$ref": "#/parameters/applyParameter"
+          }


What do you think about grouping parameters? https://github.com/Azure/autorest/tree/master/docs/extensions#x-ms-parameter-grouping

I used it. See QueryOptions

Awesome :)

In reply to: 184759834 [](ancestors = 184759834)

mcardosos · 2018-04-27T17:55:59Z

...policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json

+    "QueryFailure": {
+      "description": "Error response.",
+      "properties": {
+        "error": {


error [](start = 9, length = 5)

I am not a big fan of defining stuff inline

I've found this easier to read since there are just two parameters and is extremely unlikely to change in the future (all of ARM is using the same). If you are feeling strong about it I can change; I just want to avoid changes from the previous specs if I can to minimize risk here.

mcardosos · 2018-04-27T19:09:28Z

...policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json

+    },
+    "/providers/Microsoft.PolicyInsights/operations": {
+      "get": {
+        "operationId": "Operations_List",


Operations_List [](start = 24, length = 15)

Pageable?

Pageability is planned for future (we have backend issues to be resolved for this for us to expose it in the API)

bulentelmaci added 20 commits February 21, 2018 12:11

Swagger specs for all existing versions of Microsoft.PolicyInsights

1a6e1a0

Add support for --validate; make where clauses explicit in existing (…

0de1d2e

…approval request pending) suppressions; add new suppression for equivalent paths error (approval request pending)

Fix $top in examples; fix casing in examples

2e33f8f

Fix two more instances of $top type in examples

2b6f21f

Fix metadata examples by adding content type header and changing the …

460ce32

…body to a single string

Remove EQUIVALENT_PATH suppressions; add extendedProperties as additi…

d904912

…onalProperties; add @odata.count to operations; remove "type" from "rows" in first 2017-08-09-preview and add descriptions

Fix remaining examples with bad casings

0d39333

Fix additionalParameters definition; fix duplicate paths

55e64b9

Remove redundant operations path/definitions from one of the swagger …

a01973b

…files for each version (one per namespace is sufficient as long as both files are fed into autorest as a bundle)

Merge remote-tracking branch 'upstream/master'

47ea6dc

Change group name for operations path, and rename response type defin…

0ace4e9

…ition

Change group name for operations path, and rename response type defin…

4bd6443

…ition (old API versions)

Merge remote-tracking branch 'upstream/master'

11b74f4

Dummy change to kick the CI again

14bce7a

Fix operations path example contents

e3fa0f4

Merge remote-tracking branch 'upstream/master'

99fb7bd

Merge remote-tracking branch 'upstream/master'

da7c87c

Specs for 2018-04-04

7a6e1b7

Merge remote-tracking branch 'upstream/master'

a293e8f

AutorestCI mentioned this pull request Apr 23, 2018

[AutoPR policyinsights/resource-manager] Specs for Microsoft.PolicyInsights GA version (2018-04-04) Azure/azure-sdk-for-python#2452

Merged

azuresdkci assigned sarangan12 Apr 23, 2018

azuresdkci requested a review from sarangan12 April 23, 2018 22:11

AutorestCI mentioned this pull request Apr 23, 2018

[AutoPR policyinsights/resource-manager] Specs for Microsoft.PolicyInsights GA version (2018-04-04) AutorestCI/azure-libraries-for-java#108

Merged

AutorestCI mentioned this pull request Apr 23, 2018

[AutoPR policyinsights/resource-manager] Specs for Microsoft.PolicyInsights GA version (2018-04-04) Azure/azure-sdk-for-go#1683

Merged

sarangan12 removed their assignment Apr 24, 2018

sarangan12 removed their request for review April 24, 2018 21:46

sarangan12 added the Reassign label Apr 24, 2018

azuresdkci removed the Reassign label Apr 24, 2018

azuresdkci assigned sarangan12 Apr 24, 2018

azuresdkci requested a review from sarangan12 April 24, 2018 22:04

ravbhatnagar reviewed Apr 25, 2018

View reviewed changes

bulentelmaci mentioned this pull request Apr 25, 2018

[AutoPR] policyinsights/resource-manager Azure/azure-sdk-for-python#2122

Merged

sarangan12 assigned mcardosos and unassigned sarangan12 Apr 26, 2018

sarangan12 requested review from mcardosos and removed request for sarangan12 April 26, 2018 22:54

mcardosos reviewed Apr 27, 2018

View reviewed changes

mcardosos approved these changes Apr 27, 2018

View reviewed changes

mcardosos merged commit 5437c37 into Azure:master Apr 27, 2018

bulentelmaci mentioned this pull request May 23, 2018

Regenerate PolicyInsights based on latest spec for 2018-04-04 (GA version) Azure/azure-sdk-for-net#4361

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Specs for Microsoft.PolicyInsights GA version (2018-04-04) #2929

Specs for Microsoft.PolicyInsights GA version (2018-04-04) #2929

bulentelmaci commented Apr 23, 2018 •

edited by azuresdkci

Loading

AutorestCI commented Apr 23, 2018 •

edited

Loading

AutorestCI commented Apr 23, 2018 •

edited

Loading

AutorestCI commented Apr 23, 2018 •

edited

Loading

AutorestCI commented Apr 23, 2018 •

edited

Loading

azuresdkciprbot commented Apr 23, 2018

azuresdkciprbot commented Apr 23, 2018

ravbhatnagar Apr 25, 2018

bulentelmaci Apr 25, 2018

bulentelmaci Apr 25, 2018

ravbhatnagar Apr 25, 2018

bulentelmaci Apr 25, 2018

ravbhatnagar Apr 25, 2018

bulentelmaci Apr 25, 2018

ravbhatnagar commented Apr 26, 2018

mcardosos Apr 27, 2018

bulentelmaci Apr 27, 2018

mcardosos Apr 27, 2018

mcardosos Apr 27, 2018

bulentelmaci Apr 27, 2018

mcardosos Apr 27, 2018

mcardosos Apr 27, 2018

bulentelmaci Apr 27, 2018

mcardosos Apr 27, 2018

bulentelmaci Apr 27, 2018

Specs for Microsoft.PolicyInsights GA version (2018-04-04) #2929

Specs for Microsoft.PolicyInsights GA version (2018-04-04) #2929

Conversation

bulentelmaci commented Apr 23, 2018 • edited by azuresdkci Loading

PR information

Quality of Swagger

AutorestCI commented Apr 23, 2018 • edited Loading

Automation for azure-sdk-for-node

AutorestCI commented Apr 23, 2018 • edited Loading

Automation for azure-sdk-for-python

AutorestCI commented Apr 23, 2018 • edited Loading

Automation for azure-libraries-for-java

AutorestCI commented Apr 23, 2018 • edited Loading

Automation for azure-sdk-for-go

azuresdkciprbot commented Apr 23, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

azuresdkciprbot commented Apr 23, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ravbhatnagar commented Apr 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bulentelmaci commented Apr 23, 2018 •

edited by azuresdkci

Loading

AutorestCI commented Apr 23, 2018 •

edited

Loading

AutorestCI commented Apr 23, 2018 •

edited

Loading

AutorestCI commented Apr 23, 2018 •

edited

Loading

AutorestCI commented Apr 23, 2018 •

edited

Loading