Skip to content

Improve descriptions in Network's specs #6123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sergey-shandar merged 1 commit into from
May 28, 2019
Merged

Improve descriptions in Network's specs #6123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...tion/network/resource-manager/Microsoft.Network/stable/2019-04-01/applicationGateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@
}
},
"default": {
"description": "unexpected error.",
"description": "Unexpected error.",
"schema": {
"$ref": "./network.json#/definitions/Error"
}
Expand Down Expand Up @@ -598,7 +598,7 @@
}
},
"default": {
"description": "unexpected error.",
"description": "Unexpected error.",
"schema": {
"$ref": "./network.json#/definitions/Error"
}
Expand Down Expand Up @@ -634,7 +634,7 @@
}
},
"default": {
"description": "unexpected error.",
"description": "Unexpected error.",
"schema": {
"$ref": "./network.json#/definitions/Error"
}
Expand Down
4 changes: 2 additions & 2 deletions ...k/resource-manager/Microsoft.Network/stable/2019-04-01/availablePrivateEndpointTypes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"in": "path",
"required": true,
"type": "string",
"description": "the location of the domain name."
"description": "The location of the domain name."
},
{
"$ref": "./network.json#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -146,7 +146,7 @@
},
"serviceName": {
"type": "string",
"description": "The name of the service and resource "
"description": "The name of the service and resource."
}
},
"description": "The information of an AvailablePrivateEndpointType."
Expand Down
4 changes: 2 additions & 2 deletions ...ork/resource-manager/Microsoft.Network/stable/2019-04-01/expressRouteCrossConnection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,12 +730,12 @@
"primaryAzurePort": {
"readOnly": true,
"type": "string",
"description": "The name of the primary port."
"description": "The name of the primary port."
},
"secondaryAzurePort": {
"readOnly": true,
"type": "string",
"description": "The name of the secondary port."
"description": "The name of the secondary port."
},
"sTag": {
"readOnly": true,
Expand Down
4 changes: 2 additions & 2 deletions specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/loadBalancer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1295,12 +1295,12 @@
"frontendPort": {
"type": "integer",
"format": "int32",
"description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables \"Any Port\""
"description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables \"Any Port\"."
},
"backendPort": {
"type": "integer",
"format": "int32",
"description": "The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables \"Any Port\""
"description": "The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables \"Any Port\"."
},
"idleTimeoutInMinutes": {
"type": "integer",
Expand Down
2 changes: 1 addition & 1 deletion ...fication/network/resource-manager/Microsoft.Network/stable/2019-04-01/networkWatcher.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1117,7 +1117,7 @@
"TrafficAnalytics"
],
"operationId": "NetworkWatchers_SetFlowLogConfiguration",
"description": "Configures flow log and traffic analytics (optional) on a specified resource.",
"description": "Configures flow log and traffic analytics (optional) on a specified resource.",
"parameters": [
{
"name": "resourceGroupName",
Expand Down
4 changes: 2 additions & 2 deletions ...ication/network/resource-manager/Microsoft.Network/stable/2019-04-01/privateEndpoint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/PrivateLinkServiceConnectionProperties",
"description": "Properties of the private link service connection"
"description": "Properties of the private link service connection."
},
"name": {
"type": "string",
Expand Down Expand Up @@ -402,7 +402,7 @@
"description": "A collection of read-only information about the state of the connection to the remote resource."
}
},
"description": "Properties of the PrivateLinkServiceConnection"
"description": "Properties of the PrivateLinkServiceConnection."
},
"PrivateEndpointListResult": {
"properties": {
Expand Down
4 changes: 2 additions & 2 deletions ...tion/network/resource-manager/Microsoft.Network/stable/2019-04-01/privateLinkService.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/PrivateLinkServiceIpConfigurationProperties",
"description": "Properties of the private link service ip configuration"
"description": "Properties of the private link service ip configuration."
},
"name": {
"type": "string",
Expand Down Expand Up @@ -571,7 +571,7 @@
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/PrivateEndpointConnectionProperties",
"description": "Properties of the private end point connection"
"description": "Properties of the private end point connection."
},
"name": {
"type": "string",
Expand Down
8 changes: 4 additions & 4 deletions ...fication/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualNetwork.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1095,7 +1095,7 @@
},
"type": {
"type": "string",
"description": "Resource type"
"description": "Resource type."
}
},
"allOf": [
Expand Down Expand Up @@ -1147,7 +1147,7 @@
"type": {
"readOnly": true,
"type": "string",
"description": "Resource type"
"description": "Resource type."
}
},
"allOf": [
Expand Down Expand Up @@ -1212,7 +1212,7 @@
"items": {
"type": "string"
},
"description": "List of address prefixes for the subnet."
"description": "List of address prefixes for the subnet."
},
"networkSecurityGroup": {
"$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup",
Expand Down Expand Up @@ -1246,7 +1246,7 @@
"items": {
"$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint"
},
"description": "An array of references to private endpoints "
"description": "An array of references to private endpoints."
},
"ipConfigurations": {
"readOnly": true,
Expand Down
4 changes: 2 additions & 2 deletions ...n/network/resource-manager/Microsoft.Network/stable/2019-04-01/virtualNetworkGateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1220,7 +1220,7 @@
],
"responses": {
"201": {
"description": "",
"description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.",
"schema": {
"$ref": "#/definitions/ConnectionSharedKey"
}
Expand Down Expand Up @@ -1371,7 +1371,7 @@
}
},
"202": {
"description": ""
"description": "Request successful. The operation sets the virtual network gateway connection shared key."
}
},
"x-ms-examples": {
Expand Down
4 changes: 2 additions & 2 deletions .../network/resource-manager/Microsoft.Network/stable/2019-04-01/webapplicationfirewall.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@
"description": "Defines web application firewall policy properties.",
"properties": {
"policySettings": {
"description": "Describes policySettings for policy.",
"description": "Describes policySettings for policy.",
"$ref": "#/definitions/PolicySettings"
},
"customRules": {
Expand Down Expand Up @@ -362,7 +362,7 @@
}
},
"mode": {
"description": "Describes if it is in detection mode or prevention mode at policy level.",
"description": "Describes if it is in detection mode or prevention mode at policy level.",
"type": "string",
"enum": [
"Prevention",
Expand Down