From d0a193357d9a1466aef69d07c0d0e63eb843573b Mon Sep 17 00:00:00 2001 From: Dan Lepow Date: Mon, 7 Nov 2016 09:16:57 -0800 Subject: [PATCH 1/2] description updates in progress --- arm-compute/2016-09-30/swagger/containerService.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/arm-compute/2016-09-30/swagger/containerService.json b/arm-compute/2016-09-30/swagger/containerService.json index aafeb7540a7fd..ad992a7fce505 100644 --- a/arm-compute/2016-09-30/swagger/containerService.json +++ b/arm-compute/2016-09-30/swagger/containerService.json @@ -112,7 +112,7 @@ ], "operationId": "ContainerServices_Get", "summary":"Gets the specified container service.", - "description": "Gets the specified container service in the specified subscription and resource group. The operation returns the properties for the specified container service including state, number of masters and agents, and FQDNs of masters and agents. ", + "description": "Gets the properties specified container service in the specified subscription and resource group. The operation returns the properties including state, number of masters and agents, and FQDNs of masters and agents. ", "parameters": [ { "name": "resourceGroupName", @@ -297,7 +297,7 @@ "name": "ContainerServiceOchestratorTypes", "modelAsString": false }, - "description": "Specifies the orchestrator to use to manage container service cluster resources." + "description": "The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom." } }, "description": "Profile for orchestrator.", @@ -313,7 +313,7 @@ 3, 5 ], - "description": "Number of masters (VMs) in the container service cluster.", + "description": "Number of masters (VMs) in the container service cluster. Valid values are 1, 3, and 5. The default is 1.", "default": 1 }, "dnsPrefix": { @@ -335,7 +335,7 @@ "properties": { "name": { "type": "string", - "description": "Unique name of the agent pool profile within the context of the subscription and resource group" + "description": "Unique name of the agent pool profile in the context of the subscription and resource group." }, "count": { "type": "integer", @@ -542,7 +542,7 @@ "provisioningState": { "readOnly": true, "type": "string", - "description": "The provisioning state, which only appears in the response." + "description": "The current deployment or provisioning state, which only appears in the response." }, "orchestratorProfile": { "$ref": "#/definitions/ContainerServiceOrchestratorProfile", From 43c1770a4070d19106a80df916139462ef82bcc4 Mon Sep 17 00:00:00 2001 From: Dan Lepow Date: Mon, 7 Nov 2016 11:19:05 -0800 Subject: [PATCH 2/2] more description suggestions --- .../2016-09-30/swagger/containerService.json | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/arm-compute/2016-09-30/swagger/containerService.json b/arm-compute/2016-09-30/swagger/containerService.json index ad992a7fce505..4e1f2cc215bc1 100644 --- a/arm-compute/2016-09-30/swagger/containerService.json +++ b/arm-compute/2016-09-30/swagger/containerService.json @@ -23,7 +23,7 @@ ], "operationId": "ContainerServices_List", "summary": "Gets a list of container services in the specified subscription.", - "description":"Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, number of masters and agents, and FQDNs of masters and agents.", + "description":"Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -111,8 +111,8 @@ "ContainerService" ], "operationId": "ContainerServices_Get", - "summary":"Gets the specified container service.", - "description": "Gets the properties specified container service in the specified subscription and resource group. The operation returns the properties including state, number of masters and agents, and FQDNs of masters and agents. ", + "summary":"Gets the properties of the specified container service.", + "description": "Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. ", "parameters": [ { "name": "resourceGroupName", @@ -191,7 +191,7 @@ ], "operationId": "ContainerServices_ListByResourceGroup", "summary": "Gets a list of container services in the specified resource group.", - "description": "Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, number of masters and agents, and FQDNs of masters and agents.", + "description": "Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", "parameters": [ { "name": "resourceGroupName", @@ -264,7 +264,7 @@ "description": "The name of the custom orchestrator to use." } }, - "description": "Properties to configure custom clusters.", + "description": "Properties to configure a custom container service cluster.", "required": ["orchestrator"] }, "ContainerServiceServicePrincipalProfile": { @@ -300,7 +300,7 @@ "description": "The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom." } }, - "description": "Profile for orchestrator.", + "description": "Profile for the container service orchestrator.", "required": [ "orchestratorType" ] }, "ContainerServiceMasterProfile": { @@ -313,12 +313,12 @@ 3, 5 ], - "description": "Number of masters (VMs) in the container service cluster. Valid values are 1, 3, and 5. The default is 1.", + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", "default": 1 }, "dnsPrefix": { "type": "string", - "description": "DNS prefix to be used to create FQDN for master." + "description": "DNS prefix to be used to create the FQDN for master." }, "fqdn": { "readOnly": true, @@ -329,7 +329,7 @@ "required": [ "dnsPrefix" ], - "description": "Profile for container service master." + "description": "Profile for the container service master." }, "ContainerServiceAgentPoolProfile": { "properties": { @@ -342,7 +342,7 @@ "format": "int32", "maximum": 100, "minimum": 1, - "description": "Number of agents (VMs) to host docker containers" + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. " }, "vmSize": { "type": "string", @@ -417,7 +417,7 @@ "count", "vmSize" ], - "description": "Profile for container service agent pool." + "description": "Profile for the container service agent pool." }, "ContainerServiceWindowsProfile": { "properties": { @@ -436,7 +436,7 @@ "adminUsername", "adminPassword" ], - "description": "Profile for Windows VMs." + "description": "Profile for Windows VMs in the container service cluster." }, "ContainerServiceLinuxProfile": { "properties": { @@ -454,7 +454,7 @@ "adminUsername", "ssh" ], - "description": "Profile for Linux VMs." + "description": "Profile for Linux VMs in the container service cluster." }, "ContainerServiceSshConfiguration": { "properties": { @@ -494,7 +494,7 @@ "properties": { "enabled": { "type": "boolean", - "description": "Whether the VM diagnostic agent should be provisioned on the VM." + "description": "Whether the VM diagnostic agent is provisioned on the VM." }, "storageUri": { "readOnly": true, @@ -502,7 +502,7 @@ "description": "The URI of the storage account where diagnostics are stored." } }, - "description": "Describes VM diagnostics.", + "description": "Profile for diagnostics on the container service VMs.", "required": [ "enabled" ] @@ -535,7 +535,7 @@ "description": "The URL to get the next set of container service results." } }, - "description": "The List Container Service operation response." + "description": "The response from the List Container Services operation." }, "ContainerServiceProperties": { "properties": { @@ -565,7 +565,7 @@ "items": { "$ref": "#/definitions/ContainerServiceAgentPoolProfile" }, - "description": "Properties of agent pools." + "description": "Properties of the agent pool." }, "windowsProfile": { "$ref": "#/definitions/ContainerServiceWindowsProfile",