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

Added stable version of synapse dataplane APIs #14033

Merged
merged 21 commits into from
Jun 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
{
"swagger": "2.0",
"info": {
"version": "2020-12-01",
"title": "ArtifactsClient"
},
"x-ms-parameterized-host": {
"hostTemplate": "{endpoint}",
"useSchemePrefix": false,
"parameters": [
{
"$ref": "#/parameters/Endpoint"
}
]
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/bigDataPools": {
"get": {
"tags": [
"BigDataPools"
],
"operationId": "BigDataPools_List",
"description": "List Big Data Pools",
"x-ms-examples": {
"List Big Data Pools": {
"$ref": "./examples/BigDataPools_List.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json#/definitions/BigDataPoolResourceInfoListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../common/v1/types.json#/definitions/ErrorContract"
}
}
}
}
},
"/bigDataPools/{bigDataPoolName}": {
"get": {
"tags": [
"BigDataPools"
],
"operationId": "BigDataPools_Get",
"description": "Get Big Data Pool",
"x-ms-examples": {
"Get Big Data Pool": {
"$ref": "./examples/BigDataPools_Get.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/BigDataPoolNameParameter"
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json#/definitions/BigDataPoolResourceInfo"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../common/v1/types.json#/definitions/ErrorContract"
}
}
}
}
}
},
"definitions": {},
"parameters": {
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "The Synapse client API Version."
},
"Endpoint": {
"name": "endpoint",
"description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.",
"required": true,
"type": "string",
"in": "path",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
},
"BigDataPoolNameParameter": {
"name": "bigDataPoolName",
"in": "path",
"required": true,
"type": "string",
"description": "The Big Data Pool name",
"x-ms-parameter-location": "method"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
{
"swagger": "2.0",
"info": {
"version": "2020-12-01",
"title": "AccessControlClient"
},
"x-ms-parameterized-host": {
"hostTemplate": "{endpoint}",
"useSchemePrefix": false,
"parameters": [
{
"$ref": "#/parameters/Endpoint"
}
]
},
"schemes": [
"https"
],
"paths": {
"/checkAccessSynapseRbac": {
"post": {
"tags": [
"CheckPrincipalAccess"
],
"operationId": "RoleAssignments_CheckPrincipalAccess",
"description": "Check if the given principalId has access to perform list of actions at a given scope.",
"x-ms-examples": {
"Check access": {
"$ref": "./examples/CheckAccessSynapseRbac.json"
}
},
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"x-ms-client-flatten": true,
"description": "Details of scope, list of actions and principal.",
"schema": {
"$ref": "#/definitions/CheckPrincipalAccessRequest"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/CheckPrincipalAccessResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../common/v1/types.json#/definitions/ErrorContract"
}
}
}
}
}
},
"definitions": {
"CheckPrincipalAccessRequest": {
"description": "Check access request details",
"type": "object",
"required": [
"scope",
"actions",
"subject"
],
"properties": {
"subject": {
"description": "Subject details",
"type": "object",
"$ref": "#/definitions/SubjectInfo"
},
"actions": {
"description": "List of actions.",
"type": "array",
"items": {
"$ref": "#/definitions/RequiredAction"
}
},
"scope": {
"description": "Scope at which the check access is done.",
"type": "string"
}
}
},
"RequiredAction": {
"description": "Action Info",
"type": "object",
"required": [
"id",
"isDataAction"
],
"properties": {
"id": {
"description": "Action Id.",
"type": "string"
},
"isDataAction": {
"description": "Is a data action or not.",
"type": "boolean"
}
}
},
"CheckPrincipalAccessResponse": {
"description": "Check access response details",
"type": "object",
"properties": {
"accessDecisions": {
"description": "To check if the current user, group, or service principal has permission to read artifacts in the specified workspace.",
"type": "array",
"items": {
"$ref": "#/definitions/CheckAccessDecision"
}
}
}
},
"SubjectInfo": {
"description": "Subject details",
"type": "object",
"required": [
"principalId"
],
"properties": {
"principalId": {
"description": "Principal Id",
"format": "uuid",
"type": "string"
},
"groupIds": {
"description": "List of group Ids that the principalId is part of.",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
}
}
},
"CheckAccessDecision": {
"description": "Check access response details",
"type": "object",
"properties": {
"accessDecision": {
"description": "Access Decision.",
"type": "string"
},
"actionId": {
"description": "Action Id.",
"type": "string"
},
"roleAssignment": {
"$ref": "#/definitions/RoleAssignmentDetails"
}
}
},
"RoleAssignmentDetails": {
"description": "Role Assignment response details",
"type": "object",
"properties": {
"id": {
"description": "Role Assignment ID",
"type": "string"
},
"roleDefinitionId": {
"description": "Role ID of the Synapse Built-In Role",
"format": "uuid",
"type": "string"
},
"principalId": {
"description": "Object ID of the AAD principal or security-group",
"format": "uuid",
"type": "string"
},
"scope": {
"description": "Scope at the role assignment is created",
"type": "string"
},
"principalType": {
"description": "Type of the principal Id: User, Group or ServicePrincipal",
"type": "string"
}
}
}
},
"parameters": {
"Endpoint": {
"name": "endpoint",
"description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.",
"required": true,
"type": "string",
"in": "path",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "The Synapse client API Version."
}
}
}
Loading