Skip to content

Commit

Permalink
Fix typo in common private links definition for actionsRequired (#9727)
Browse files Browse the repository at this point in the history
* Add FAQ document

* Fix typo & change MV descriptions

* fix ci-fix url

* Change SDK generation

* Fix typo in common private links definition

* fix actionsRequired typo for Storage example

* restore storage.json to use local defintion

* Changeback example files

* Fix types.json ref

* fix types.json ref
  • Loading branch information
akning-ms authored Jun 18, 2020
1 parent fd95d20 commit 42be68e
Show file tree
Hide file tree
Showing 3 changed files with 181 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"type": "string",
"description": "The reason for approval/rejection of the connection."
},
"actionRequired": {
"actionsRequired": {
"type": "string",
"description": "A message indicating if changes on the service provider require any updates on the consumer."
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Common types"
},
"paths": {},
"definitions": {
"PrivateEndpoint": {
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "The ARM identifier for Private Endpoint"
}
},
"description": "The Private Endpoint resource."
},
"PrivateEndpointConnection": {
"properties": {
"properties": {
"$ref": "#/definitions/PrivateEndpointConnectionProperties",
"x-ms-client-flatten": true,
"description": "Resource properties."
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
}
],
"description": "The Private Endpoint Connection resource."
},
"PrivateEndpointConnectionProperties": {
"properties": {
"privateEndpoint": {
"$ref": "#/definitions/PrivateEndpoint",
"description": "The resource of private end point."
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkServiceConnectionState",
"description": "A collection of information about the state of the connection between service consumer and provider."
},
"provisioningState": {
"$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
"description": "The provisioning state of the private endpoint connection resource."
}
},
"required": [
"privateLinkServiceConnectionState"
],
"description": "Properties of the PrivateEndpointConnectProperties."
},
"PrivateLinkServiceConnectionState": {
"properties": {
"status": {
"$ref": "#/definitions/PrivateEndpointServiceConnectionStatus",
"description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
},
"description": {
"type": "string",
"description": "The reason for approval/rejection of the connection."
},
"actionRequired": {
"type": "string",
"description": "A message indicating if changes on the service provider require any updates on the consumer."
}
},
"description": "A collection of information about the state of the connection between service consumer and provider."
},
"PrivateEndpointServiceConnectionStatus": {
"type": "string",
"description": "The private endpoint connection status.",
"enum": [
"Pending",
"Approved",
"Rejected"
],
"x-ms-enum": {
"name": "PrivateEndpointServiceConnectionStatus",
"modelAsString": true
}
},
"PrivateEndpointConnectionProvisioningState": {
"type": "string",
"readOnly": true,
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Failed"
],
"x-ms-enum": {
"name": "PrivateEndpointConnectionProvisioningState",
"modelAsString": true
}
},
"PrivateLinkResource": {
"properties": {
"properties": {
"$ref": "#/definitions/PrivateLinkResourceProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource"
}
],
"description": "A private link resource"
},
"PrivateLinkResourceProperties": {
"properties": {
"groupId": {
"description": "The private link resource group id.",
"type": "string",
"readOnly": true
},
"requiredMembers": {
"description": "The private link resource required member names.",
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"requiredZoneNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The private link resource Private link DNS zone name."
}
},
"description": "Properties of a private link resource."
},
"PrivateEndpointConnectionListResult": {
"properties": {
"value": {
"type": "array",
"description": "Array of private endpoint connections",
"items": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
}
},
"description": "List of private endpoint connection associated with the specified storage account"
},
"PrivateLinkResourceListResult": {
"properties": {
"value": {
"type": "array",
"description": "Array of private link resources",
"items": {
"$ref": "#/definitions/PrivateLinkResource"
}
}
},
"description": "A list of private link resources"
}
},
"parameters": {
"PrivateEndpointConnectionName": {
"name": "privateEndpointConnectionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the private endpoint connection associated with the Azure resource",
"x-ms-parameter-location": "method"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -845,7 +845,7 @@
"200": {
"description": "OK -- Successfully retrieved private endpoint connections.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
"$ref": "./privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
}
}
},
Expand Down Expand Up @@ -887,7 +887,7 @@
"200": {
"description": "OK -- Get the private endpoint connection properties successfully.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
"$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
}
},
"default": {
Expand Down Expand Up @@ -930,7 +930,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
"$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
},
"description": "The private endpoint connection properties."
}
Expand All @@ -939,7 +939,7 @@
"200": {
"description": "OK -- Update the private endpoint connection properties successfully.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
"$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
}
},
"default": {
Expand Down Expand Up @@ -1024,7 +1024,7 @@
"200": {
"description": "Successfully retrieved private link resources.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult"
"$ref": "./privatelinks.json#/definitions/PrivateLinkResourceListResult"
}
}
}
Expand Down Expand Up @@ -2552,7 +2552,7 @@
"readOnly": true,
"type": "array",
"items": {
"$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection"
"$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
},
"description": "List of private endpoint connection associated with the specified storage account"
},
Expand Down

0 comments on commit 42be68e

Please sign in to comment.