Dsc paging changes #2931

RayStone1998 · 2018-04-23T23:36:50Z

New functionality to address server side (sql) paging for dsc resources

add server side paging to dsc nodes get + examples
add server side paging to dsc configurations get + examples
add server side paging to dsc node configurations get + examples
add server side paging for dsc node counts (status and node configurations) + examples

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

[ x] 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.
[ x] Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
[ x] If applicable, the PR references the bug/issue that it fixes.
[ x] Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

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

AutorestCI · 2018-04-23T23:37:23Z

Automation for azure-libraries-for-java

Nothing to generate for azure-libraries-for-java

AutorestCI · 2018-04-23T23:39:30Z

Automation for azure-sdk-for-python

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

AutorestCI · 2018-04-23T23:42:45Z

Automation for azure-sdk-for-node

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-node#2653

azuresdkciprbot · 2018-04-23T23:44:13Z

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/automation/resource-manager/readme.md

⚠️

0 new Warnings.(131 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-23T23:44:14Z

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/automation/resource-manager/readme.md

⚠️

0 new Warnings.(88 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

AutorestCI · 2018-04-23T23:45:24Z

Automation for azure-sdk-for-go

Encountered a Subprocess error: (azure-sdk-for-go)

Command: ['/usr/local/bin/autorest', '/tmp/tmp756ke8o6/rest/specification/automation/resource-manager/readme.md', '--go', '--go-sdk-folder=/tmp/tmp756ke8o6/src/github.com/Azure/azure-sdk-for-go', '--multiapi', '--use=@microsoft.azure/autorest.go@~2.1.98', '--use-onever', '--verbose']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4262; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4272/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4272)
   Loading AutoRest extension '@microsoft.azure/autorest.go' (~2.1.98->2.1.98)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.38->2.3.38)
Processing batch task - {"tag":"package-2015-10"} .
Processing batch task - {"tag":"package-2017-05-preview"} .
Processing batch task - {"tag":"package-2018-01-preview"} .
FATAL: System.ArgumentOutOfRangeException: Index was out of range. Must be non-negative and less than the size of the collection.
Parameter name: startIndex
   at System.String.LastIndexOf(Char value, Int32 startIndex, Int32 count)
   at AutoRest.Go.Model.CodeModelGo.PackageVerDir() in /opt/vsts/work/1/s/src/Model/CodeModelGo.cs:line 64
   at AutoRest.Go.Model.CodeModelGo.get_DefaultUserAgent() in /opt/vsts/work/1/s/src/Model/CodeModelGo.cs:line 83
   at AutoRest.Go.Model.CodeModelGo.get_UserAgent() in /opt/vsts/work/1/s/src/Model/CodeModelGo.cs:line 31
   at AutoRest.Go.Templates.VersionTemplate.<ExecuteAsync>d__1.MoveNext() in /opt/vsts/work/1/s/src/obj/Razor/Templates/VersionTemplate.cshtml:line 28
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at AutoRest.Core.CodeGenerator.<Write>d__12.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at AutoRest.Go.CodeGeneratorGo.<Generate>d__6.MoveNext() in /opt/vsts/work/1/s/src/CodeGeneratorGo.cs:line 91
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at AutoRest.Go.Program.<ProcessInternal>d__3.MoveNext() in /opt/vsts/work/1/s/src/Program.cs:line 107
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at NewPlugin.<Process>d__15.MoveNext()
FATAL: go/generate - FAILED
FATAL: Error: Plugin go reported failure.
Process() cancelled due to exception : Plugin go reported failure.
Failure during batch task - {"tag":"package-2018-01-preview"} -- Error: Plugin go reported failure..
  Error: Plugin go reported failure.

mcardosos · 2018-04-24T01:20:43Z

...cation/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json

+        },
+        "totalCount": {
+          "type": "integer",
+          "description": "Gets the total number of records matching filter criteria."


filter [](start = 68, length = 6)

Which filter?

If get call includes a $filter then gets the total number of records matching that filter. If no $filter specification, then gets the total number of records.

The $filter parameter specifies "The filter to apply on the operation." The paging examples show various values for $filter and what happens when no $filter is specified

@mcardosos -- amended description to read "Gets the total number of records matching countType criteria." where countType is a defined query parameter

The $filter parameter is missing in the operation definition

mcardosos · 2018-04-24T01:27:46Z

Also, there are some model validation errors

mcardosos

Added some comments

azuresdkciprbot · 2018-04-24T19:08:29Z

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/automation/resource-manager/readme.md

⚠️

0 new Warnings.(131 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-24T19:08:29Z

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/automation/resource-manager/readme.md

⚠️

0 new Warnings.(88 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

RayStone1998 · 2018-04-24T22:04:41Z

@mcardosos -- changed description on NodeCounts from "Gets the total number of records matching filter criteria." to "Gets the total number of records matching countType criteria."

azuresdkciprbot · 2018-04-24T22:06:13Z

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/automation/resource-manager/readme.md

⚠️

0 new Warnings.(131 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-24T22:06:13Z

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/automation/resource-manager/readme.md

⚠️

0 new Warnings.(88 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

RayStone1998 · 2018-04-24T22:23:55Z

@mcardosos -- fixed description (your review comment) to read "Gets the total number of records matching countType criteria." where countType is defined as a query parameter with description: "The type of counts to retrieve"

mcardosos · 2018-04-24T23:40:46Z

...ion/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json

@@ -366,6 +372,34 @@
          },
          {
            "$ref": "./definitions.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "name": "$filter",


$filter [](start = 21, length = 7)

What about adding the x-ms-odata extension? #Resolved

@RayStone1998 For your reference - https://github.com/Azure/azure-rest-api-specs/blob/master/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json#L254 #Resolved

RayStone1998 · 2018-04-25T19:11:58Z

@mcardosos -- added x-ms-odata extension per request

azuresdkciprbot · 2018-04-25T19:16:14Z

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/automation/resource-manager/readme.md

⚠️

0 new Warnings.(88 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

azuresdkciprbot · 2018-04-25T19:16:14Z

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/automation/resource-manager/readme.md

⚠️

0 new Warnings.(131 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

ravbhatnagar · 2018-04-25T22:52:47Z

...cation/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json

+    }
+  },
+  "paths": {
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodecounts/{countType}": {


why is nodeCounts modeled as a separate resource type? Could it be just a property on the automation Account or on nodes?

@ravbhatnagar - Not sure what you mean by "a property on the AutomationAccount or on nodes" but the following was my reasoning for a separate resource...

/subscriptions/{SubId}/.../nodes specifies getting a list of all nodes and /subscriptions/{SubId}/.../nodes/{NodeId} specifies getting node information for NodeId. If I were to create a url like this: /subscriptions/{SubId}/.../nodes/StatusCount or /subscriptions/{SubId}/.../nodes/NodeConfigurationCount then any user who tried to create a node with StatusCount or NodeConfigurationCount as a name would break our system. Possibly a small corner case but I didn't want to go there...

The count data is a different view of nodes where getting the status count is essentially a count of all nodes by status (think SQL group by) and getting the nodeConfiguration count is getting a count of all nodes with a particular node configuration value making the count data not a property of a node but a property of the entire collection of nodes. I modeled counts as a separate resource due to the above because all other approaches seemed wrong.

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

Signing off!

RayStone1998 · 2018-04-26T22:38:10Z

@ravbhatnagar - thanks

@mcardosos - could you merge?

mcardosos

Looks good.
I know this errors were not introduced on this PR, but, pointing them out for awareness

salameer · 2018-05-02T02:43:00Z

Hi @vrdmr please ping this thread when your ready to merge

vrdmr

Looks good.

Dsc paging changes

91ed442

azuresdkci assigned mcardosos Apr 23, 2018

azuresdkci requested a review from mcardosos April 23, 2018 23:37

AutorestCI mentioned this pull request Apr 23, 2018

[AutoPR automation/resource-manager] Dsc paging changes Azure/azure-sdk-for-python#2454

Merged

AutorestCI mentioned this pull request Apr 23, 2018

[AutoPR automation/resource-manager] Dsc paging changes Azure/azure-sdk-for-node#2784

Closed

mcardosos reviewed Apr 24, 2018

View reviewed changes

mcardosos added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 24, 2018

mcardosos suggested changes Apr 24, 2018

View reviewed changes

Add missing fields to spec

5c04279

Ammend description

88346bc

mcardosos reviewed Apr 24, 2018

View reviewed changes

add x-ms-odata to dscConfiguration

376277f

ravbhatnagar reviewed Apr 25, 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 Apr 26, 2018

mcardosos approved these changes Apr 27, 2018

View reviewed changes

mcardosos added the DoNotMerge <valid label in PR review process> use to hold merge after approval label May 1, 2018

mcardosos changed the title ~~Dsc paging changes~~ [Do not merge] Dsc paging changes May 1, 2018

salameer unassigned mcardosos May 2, 2018

salameer added the Reassign label May 2, 2018

azuresdkci removed the Reassign label May 2, 2018

azuresdkci assigned marstr May 2, 2018

azuresdkci requested a review from marstr May 2, 2018 03:03

vrdmr approved these changes May 2, 2018

View reviewed changes

marstr merged commit 3761a71 into Azure:master May 2, 2018

marstr changed the title ~~[Do not merge] Dsc paging changes~~ Dsc paging changes May 2, 2018

marstr removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label May 2, 2018

vrdmr mentioned this pull request Jun 26, 2018

Updated Readme.md file #3304

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dsc paging changes #2931

Dsc paging changes #2931

RayStone1998 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

azuresdkciprbot commented Apr 23, 2018

azuresdkciprbot commented Apr 23, 2018

AutorestCI commented Apr 23, 2018 •

edited

Loading

mcardosos Apr 24, 2018

RayStone1998 Apr 24, 2018

RayStone1998 Apr 24, 2018

mcardosos Apr 24, 2018

mcardosos commented Apr 24, 2018

mcardosos left a comment

azuresdkciprbot commented Apr 24, 2018

azuresdkciprbot commented Apr 24, 2018

RayStone1998 commented Apr 24, 2018

azuresdkciprbot commented Apr 24, 2018

azuresdkciprbot commented Apr 24, 2018

RayStone1998 commented Apr 24, 2018

mcardosos Apr 24, 2018 •

edited

Loading

vrdmr Apr 25, 2018 •

edited by mcardosos

Loading

RayStone1998 commented Apr 25, 2018

azuresdkciprbot commented Apr 25, 2018

azuresdkciprbot commented Apr 25, 2018

ravbhatnagar Apr 25, 2018

RayStone1998 Apr 26, 2018 •

edited

Loading

ravbhatnagar commented Apr 26, 2018

RayStone1998 commented Apr 26, 2018

mcardosos left a comment

salameer commented May 2, 2018

vrdmr left a comment

Dsc paging changes #2931

Dsc paging changes #2931

Conversation

RayStone1998 commented Apr 23, 2018 • edited by azuresdkci Loading

PR information

Quality of Swagger

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

AutorestCI commented Apr 23, 2018 • edited Loading

Automation for azure-sdk-for-node

azuresdkciprbot commented Apr 23, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

azuresdkciprbot commented Apr 23, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

AutorestCI commented Apr 23, 2018 • edited Loading

Automation for azure-sdk-for-go

mcardosos Apr 24, 2018

Choose a reason for hiding this comment

RayStone1998 Apr 24, 2018

Choose a reason for hiding this comment

RayStone1998 Apr 24, 2018

Choose a reason for hiding this comment

mcardosos Apr 24, 2018

Choose a reason for hiding this comment

mcardosos commented Apr 24, 2018

mcardosos left a comment

Choose a reason for hiding this comment

azuresdkciprbot commented Apr 24, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

azuresdkciprbot commented Apr 24, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

RayStone1998 commented Apr 24, 2018

azuresdkciprbot commented Apr 24, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

azuresdkciprbot commented Apr 24, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

RayStone1998 commented Apr 24, 2018

mcardosos Apr 24, 2018 • edited Loading

Choose a reason for hiding this comment

vrdmr Apr 25, 2018 • edited by mcardosos Loading

Choose a reason for hiding this comment

RayStone1998 commented Apr 25, 2018

azuresdkciprbot commented Apr 25, 2018

AutoRest linter results for ARM Related Validation Errors/Warnings

azuresdkciprbot commented Apr 25, 2018

AutoRest linter results for SDK Related Validation Errors/Warnings

ravbhatnagar Apr 25, 2018

Choose a reason for hiding this comment

RayStone1998 Apr 26, 2018 • edited Loading

Choose a reason for hiding this comment

ravbhatnagar commented Apr 26, 2018

RayStone1998 commented Apr 26, 2018

mcardosos left a comment

Choose a reason for hiding this comment

salameer commented May 2, 2018

vrdmr left a comment

Choose a reason for hiding this comment

RayStone1998 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

mcardosos Apr 24, 2018 •

edited

Loading

vrdmr Apr 25, 2018 •

edited by mcardosos

Loading

RayStone1998 Apr 26, 2018 •

edited

Loading