Skip to content

added initial set of descriptions for VM and VMSS properties#1569

Merged
veronicagg merged 6 commits intoAzure:currentfrom
gatneil:negat_vm_vmss_descriptions
Aug 24, 2017
Merged

added initial set of descriptions for VM and VMSS properties#1569
veronicagg merged 6 commits intoAzure:currentfrom
gatneil:negat_vm_vmss_descriptions

Conversation

@gatneil
Copy link
Copy Markdown
Contributor

@gatneil gatneil commented Aug 22, 2017 •
edited by azuresdkci
Loading

No description provided.

veronicagg
veronicagg suggested changes Aug 22, 2017
View reviewed changes
Copy link
Copy Markdown
Contributor

@veronicagg veronicagg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few minor comments, you may also want to evaluate adding missing descriptions flagged by linter tool, example: https://travis-ci.org/Azure/azure-rest-api-specs/jobs/267008359#L723, https://travis-ci.org/Azure/azure-rest-api-specs/jobs/267008359#L1695

specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json
@@ -3413,11 +3413,11 @@
},
"type": {
"type": "string",
Copy link
Copy Markdown
Contributor

@veronicagg veronicagg Aug 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

based on the description you may want to evaluate turning this property into an enum in the future - https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-enum

Copy link
Copy Markdown
Contributor Author

@gatneil gatneil Aug 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately the list of extension types is not static or versioned (at least, not in any user-specifiable way); so I don't think an enum would work for it (I wish it were versioned :))

specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json Outdated
"type": {
"type": "string",
"description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.",
"description": "The type of indentity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.",
Copy link
Copy Markdown
Contributor

@veronicagg veronicagg Aug 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: indentity -> identity?

Copy link
Copy Markdown
Contributor Author

@gatneil gatneil Aug 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol; thanks

specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json Outdated
"type": "string",
"readOnly": true,
"description": "The type of restrictions.",
"description": "The type of restrictions",
Copy link
Copy Markdown
Contributor

@veronicagg veronicagg Aug 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"." at the end?

specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json Outdated
"createOption": {
"$ref": "#/definitions/CreateOption",
"description": "The create option."
"description": "The create option"
Copy link
Copy Markdown
Contributor

@veronicagg veronicagg Aug 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"." at the end?

specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json Outdated
"type": {
"type": "string",
"description": "The type of the extension handler."
"description": "Specifies the type of the extension; an example is \"CustomScriptExtension\""
Copy link
Copy Markdown
Contributor

@veronicagg veronicagg Aug 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"." at the end?

specification/compute/resource-manager/Microsoft.Compute/2017-03-30/compute.json Outdated
"diagnosticsProfile": {
"$ref": "#/definitions/DiagnosticsProfile",
"description": "The virtual machine scale set diagnostics profile."
"description": "Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15"
Copy link
Copy Markdown
Contributor

@veronicagg veronicagg Aug 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"." at the end?

@gatneil
Copy link
Copy Markdown
Contributor Author

gatneil commented Aug 22, 2017

@veronicagg thanks for the review! Addressed the comments above. This particular PR is meant to get a jump start on descriptions, but look forward to more incremental follow-up PRs over time to bring it up to 100% description coverage :)

@azuresdkciprbot
Copy link
Copy Markdown

azuresdkciprbot commented Aug 22, 2017

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/compute/resource-manager/readme.md
Before the PR: Warning(s): 116 Error(s): 33
After the PR: Warning(s): 116 Error(s): 33

AutoRest Linter Guidelines | AutoRest Linter Issues

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

Thanks for your co-operation.

@azuresdkciprbot
Copy link
Copy Markdown

azuresdkciprbot commented Aug 22, 2017

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/compute/resource-manager/readme.md
Before the PR: Warning(s): 116 Error(s): 33
After the PR: Warning(s): 116 Error(s): 33

AutoRest Linter Guidelines | AutoRest Linter Issues

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

Thanks for your co-operation.

@veronicagg veronicagg merged commit a0e5044 into Azure:current Aug 24, 2017
@AutorestCI AutorestCI mentioned this pull request Aug 24, 2017
Closed
@AutorestCI
Copy link
Copy Markdown

AutorestCI commented Aug 24, 2017

Build Status Azure/azure-sdk-for-ruby#922

@AutorestCI
Copy link
Copy Markdown

AutorestCI commented Aug 24, 2017

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

@AutorestCI AutorestCI mentioned this pull request Aug 24, 2017
Merged
@AutorestCI
Copy link
Copy Markdown

AutorestCI commented Aug 24, 2017

Build Status Azure/azure-sdk-for-python#1388

vivsriaus pushed a commit to vivsriaus/azure-rest-api-specs that referenced this pull request Aug 24, 2017
@gatneil @vivsriaus
added initial set of descriptions for VM and VMSS properties (Azure#1569
70acb4e 
)

* added initial set of descriptions for VM and VMSS properties

* fixed descriptions

* changed back location fields

* reverted resource descriptions

* fixed spelling and added missing periods

* added missing periods
mccleanp pushed a commit that referenced this pull request Mar 23, 2022
@subbartt
Exposing vm conditions as readonly property... (#1569)
483bdce 
* adding vm conditions

* vm conditions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@veronicagg veronicagg veronicagg approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@veronicagg veronicagg

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@gatneil @azuresdkciprbot @AutorestCI @veronicagg @msftclas