Skip to content
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.

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

Add Swagger specs for ARE[Azure Runtime Environment] #23988

Merged
merged 15 commits into from
Nov 2, 2023
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
{
"swagger": "2.0",
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"info": {
"version": "2018-06-10",
"title": "Common types"
},
"paths": {},
"definitions": {
"PrivateEndpointConnection": {
Copy link

Choose a reason for hiding this comment

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

Pls check to refer these from common types. I see privateEndpoint related object types are similar to the ones available in the common-types here - specification/common-types/resource-management/v5/privatelinks.json

"description": "A private endpoint connection",
"type": "object",
"properties": {
"properties": {
"$ref": "#/definitions/PrivateEndpointConnectionProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"PrivateEndpointConnectionProperties": {
Copy link

@pcsin pcsin Oct 18, 2023

Choose a reason for hiding this comment

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

Pls consider using these properties from common-types. There other properties below which are also part of common-types related to private endpoint.

"description": "Properties of a private endpoint connection.",
"type": "object",
"properties": {
"privateEndpoint": {
"$ref": "#/definitions/PrivateEndpointProperty",
"description": "Private endpoint which the connection belongs to."
},
"groupIds": {
"$ref": "#/definitions/GroupIdsProperty",
"description": "Gets the groupIds."
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty",
"description": "Connection State of the Private Endpoint Connection."
}
}
},
"PrivateEndpointProperty": {
"type": "object",
"description": "Private endpoint which the connection belongs to.",
"properties": {
"id": {
"type": "string",
"description": "Resource id of the private endpoint."
}
}
},
"GroupIdsProperty": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets the groupIds."
},
"PrivateLinkServiceConnectionStateProperty": {
"type": "object",
"description": "Connection State of the Private Endpoint Connection.",
"properties": {
"status": {
"type": "string",
"description": "The private link service connection status."
},
"description": {
"type": "string",
"description": "The private link service connection description."
},
"actionsRequired": {
"type": "string",
"description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)",
"readOnly": true
}
}
}
},
"parameters": {
"RuntimeEnvironmentNameParameter": {
"name": "runtimeEnvironmentName",
"description": "The name of the Runtime Environment.",
"type": "string",
"required": true,
"in": "path",
"x-ms-parameter-location": "method",
"pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$"
},
"AutomationAccountNameParameter": {
"name": "automationAccountName",
"description": "The name of the automation account.",
"type": "string",
"required": true,
"in": "path",
"x-ms-parameter-location": "method",
"pattern": "^[a-zA-Z][a-zA-Z-_0-9]*$"
}
}
}
Loading