Skip to content

Commit

Permalink
Merge pull request #686 from dlepow/danlepacs
Browse files Browse the repository at this point in the history 
Updating Container Service Swagger spec descriptions
  • Loading branch information
@amarzavery
amarzavery committed Nov 9, 2016
2 parents 51ce2f8 + 43c1770 commit 10dee79
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions arm-compute/2016-09-30/swagger/containerService.json
View file
Expand Up @@ -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"
Expand Down Expand Up @@ -111,8 +111,8 @@
"ContainerService"
],
"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. ",
"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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -297,10 +297,10 @@
"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.",
"description": "Profile for the container service orchestrator.",
"required": [ "orchestratorType" ]
},
"ContainerServiceMasterProfile": {
Expand All @@ -313,12 +313,12 @@
3,
5
],
"description": "Number of masters (VMs) in the container service cluster.",
"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,
Expand All @@ -329,20 +329,20 @@
"required": [
"dnsPrefix"
],
"description": "Profile for container service master."
"description": "Profile for the container service master."
},
"ContainerServiceAgentPoolProfile": {
"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",
"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",
Expand Down Expand Up @@ -417,7 +417,7 @@
"count",
"vmSize"
],
"description": "Profile for container service agent pool."
"description": "Profile for the container service agent pool."
},
"ContainerServiceWindowsProfile": {
"properties": {
Expand All @@ -436,7 +436,7 @@
"adminUsername",
"adminPassword"
],
"description": "Profile for Windows VMs."
"description": "Profile for Windows VMs in the container service cluster."
},
"ContainerServiceLinuxProfile": {
"properties": {
Expand All @@ -454,7 +454,7 @@
"adminUsername",
"ssh"
],
"description": "Profile for Linux VMs."
"description": "Profile for Linux VMs in the container service cluster."
},
"ContainerServiceSshConfiguration": {
"properties": {
Expand Down Expand Up @@ -494,15 +494,15 @@
"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,
"type": "string",
"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"
]
Expand Down Expand Up @@ -535,14 +535,14 @@
"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": {
"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",
Expand All @@ -565,7 +565,7 @@
"items": {
"$ref": "#/definitions/ContainerServiceAgentPoolProfile"
},
"description": "Properties of agent pools."
"description": "Properties of the agent pool."
},
"windowsProfile": {
"$ref": "#/definitions/ContainerServiceWindowsProfile",
Expand Down

0 comments on commit 10dee79

Please sign in to comment.