More detail added to the descriptions. #3956

axayjo · 2018-09-19T18:33:10Z

Changes made to description strings.

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.

Changes made to description strings.

AutorestCI · 2018-09-19T18:33:45Z

Automation for azure-sdk-for-js

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

Command: ['/usr/local/bin/autorest', '/tmp/tmplpsobdgl/rest/specification/compute/resource-manager/readme.md', '--license-header=MICROSOFT_MIT_NO_VERSION', '--node-sdks-folder=/tmp/tmplpsobdgl/azure-sdk-for-js', '--typescript', '--use=@microsoft.azure/autorest.typescript@2.0.514']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.12.0]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4286/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4286)
   Loading AutoRest extension '@microsoft.azure/autorest.typescript' (2.0.514->2.0.514)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.51->2.3.51)
FATAL: System.InvalidOperationException: Swagger document contains two or more x-ms-enum extensions with the same name 'StorageAccountTypes' and different values: Standard_LRS,Premium_LRS,StandardSSD_LRS,UltraSSD_LRS vs. Standard_LRS,Premium_LRS,StandardSSD_LRS
   at AutoRest.Modeler.ObjectBuilder.BuildServiceType(String serviceTypeName, Boolean required) in c:\publish\autorest.modeler\src\ObjectBuilder.cs:line 150
   at AutoRest.Modeler.SchemaBuilder.ParentBuildServiceType(String serviceTypeName, Boolean required) in c:\publish\autorest.modeler\src\SchemaBuilder.cs:line 217
   at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in c:\publish\autorest.modeler\src\SchemaBuilder.cs:line 48
   at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in c:\publish\autorest.modeler\src\SchemaBuilder.cs:line 133
   at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in c:\publish\autorest.modeler\src\SchemaBuilder.cs:line 133
   at AutoRest.Modeler.SwaggerModeler.BuildCompositeTypes() in c:\publish\autorest.modeler\src\SwaggerModeler.cs:line 348
   at AutoRest.Modeler.SwaggerModeler.Build(ServiceDefinition serviceDefinition) in c:\publish\autorest.modeler\src\SwaggerModeler.cs:line 66
   at AutoRest.Modeler.Program.<ProcessInternal>d__2.MoveNext() in c:\publish\autorest.modeler\src\Program.cs:line 60
--- 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: typescript/imodeler1 - FAILED
FATAL: Error: Plugin imodeler1 reported failure.
Process() cancelled due to exception : Plugin imodeler1 reported failure.
  Error: Plugin imodeler1 reported failure.

AutorestCI · 2018-09-19T18:34:10Z

Automation for azure-sdk-for-node

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

Command: ['/usr/local/bin/autorest', '/tmp/tmp_92clxed/rest/specification/compute/resource-manager/readme.md', '--license-header=MICROSOFT_MIT_NO_VERSION', '--node-sdks-folder=/tmp/tmp_92clxed/sdk', '--nodejs', '--use=@microsoft.azure/autorest.nodejs@2.1.99']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.11.3]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4283/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4283)
   Loading AutoRest extension '@microsoft.azure/autorest.nodejs' (2.1.99->2.1.99)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.44->2.3.44)
FATAL: System.InvalidOperationException: Swagger document contains two or more x-ms-enum extensions with the same name 'StorageAccountTypes' and different values: Standard_LRS,Premium_LRS,StandardSSD_LRS,UltraSSD_LRS vs. Standard_LRS,Premium_LRS,StandardSSD_LRS
   at AutoRest.Modeler.ObjectBuilder.BuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\ObjectBuilder.cs:line 147
   at AutoRest.Modeler.SchemaBuilder.ParentBuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\SchemaBuilder.cs:line 217
   at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\SchemaBuilder.cs:line 48
   at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\SchemaBuilder.cs:line 133
   at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\SchemaBuilder.cs:line 133
   at AutoRest.Modeler.SwaggerModeler.BuildCompositeTypes() in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\SwaggerModeler.cs:line 310
   at AutoRest.Modeler.SwaggerModeler.Build(ServiceDefinition serviceDefinition) in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\SwaggerModeler.cs:line 66
   at AutoRest.Modeler.Program.<ProcessInternal>d__2.MoveNext() in C:\Users\ci\AppData\Local\Temp\PUBLISHu1dw1\44_20171214T003644\autorest.modeler\src\Program.cs:line 60
--- 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: nodejs/imodeler1 - FAILED
FATAL: Error: Plugin imodeler1 reported failure.
Process() cancelled due to exception : Plugin imodeler1 reported failure.
  Error: Plugin imodeler1 reported failure.

AutorestCI · 2018-09-19T18:35:25Z

Automation for azure-sdk-for-python

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

AutorestCI · 2018-09-19T18:36:31Z

Automation for azure-sdk-for-ruby

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

azuresdkci · 2018-09-19T18:41:57Z

Can one of the admins verify this patch?

AutorestCI · 2018-09-19T18:42:25Z

Automation for azure-sdk-for-go

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

AutorestCI · 2018-09-19T18:43:22Z

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

singhkays

We should also add to the descriptions which of the fields is updatable

singhkays · 2018-09-19T18:47:33Z

specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json

@@ -53,7 +53,7 @@
            "in": "path",
            "required": true,
            "type": "string",
-            "description": "The name of the gallery."
+            "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters as limited by Constants.MaxResourceNameLength for any type of resource created in Azure."


Don't need this "as limited by Constants.MaxResourceNameLength for any type of resource created in Azure." as people don't know what Constants.MaxResourceNameLength is

singhkays · 2018-09-19T18:48:09Z

specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json

          },
          {
            "name": "galleryImageName",
            "in": "path",
            "required": true,
            "type": "string",
-            "description": "The name of the gallery image."
+            "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters as limited by Constants.MaxResourceNameLength for any type of resource created in Azure."


Same here as above re: Constats

Addressed review comments on the updateable fields.

Added another updateable property description

singhkays · 2018-09-19T21:41:53Z

lgtm

More detail added to the descriptions.

3e469dd

Changes made to description strings.

AutorestCI mentioned this pull request Sep 19, 2018

[AutoPR compute/resource-manager] More detail added to the descriptions. Azure/azure-sdk-for-python#3379

Merged

AutorestCI mentioned this pull request Sep 19, 2018

[AutoPR compute/resource-manager] More detail added to the descriptions. Azure/azure-sdk-for-ruby#1667

Merged

AutorestCI mentioned this pull request Sep 19, 2018

[AutoPR compute/resource-manager] More detail added to the descriptions. Azure/azure-sdk-for-go#2756

Merged

azuresdkci assigned jhendrixMSFT Sep 19, 2018

azuresdkci requested a review from jhendrixMSFT September 19, 2018 18:45

singhkays reviewed Sep 19, 2018

View reviewed changes

axayjo added 2 commits September 19, 2018 12:07

Addressed review comments

67ce182

Addressed review comments on the updateable fields.

Added another updateable property description

a92afae

Added another updateable property description

jhendrixMSFT approved these changes Sep 19, 2018

View reviewed changes

jhendrixMSFT merged commit 7c8e7d1 into Azure:master Sep 19, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More detail added to the descriptions. #3956

More detail added to the descriptions. #3956

axayjo commented Sep 19, 2018

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading

azuresdkci commented Sep 19, 2018

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading

singhkays left a comment

singhkays Sep 19, 2018

singhkays Sep 19, 2018

singhkays commented Sep 19, 2018

More detail added to the descriptions. #3956

More detail added to the descriptions. #3956

Conversation

axayjo commented Sep 19, 2018

PR information

Quality of Swagger

AutorestCI commented Sep 19, 2018 • edited Loading

Automation for azure-sdk-for-js

AutorestCI commented Sep 19, 2018 • edited Loading

Automation for azure-sdk-for-node

AutorestCI commented Sep 19, 2018 • edited Loading

Automation for azure-sdk-for-python

AutorestCI commented Sep 19, 2018 • edited Loading

Automation for azure-sdk-for-ruby

azuresdkci commented Sep 19, 2018

AutorestCI commented Sep 19, 2018 • edited Loading

Automation for azure-sdk-for-go

AutorestCI commented Sep 19, 2018 • edited Loading

Automation for azure-sdk-for-java

singhkays left a comment

Choose a reason for hiding this comment

singhkays Sep 19, 2018

Choose a reason for hiding this comment

singhkays Sep 19, 2018

Choose a reason for hiding this comment

singhkays commented Sep 19, 2018

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading