Added stable version of synapse dataplane APIs (Azure#14033)

* Added stable version of dataplane APIs * Added spec files to readme config. * Remove unused example files. * Fixes for checks. * Fixes for checks. * Fixes for checks. * Remove duplicate schema. * Fix formatting. * Use ErrorResponse from common types. * Remove redundant type ErrorContract. * Added back ErrorContract with correct defintion, refering to common type in synapse commons. * Fixed duplicate of libraryOperationResults, fix file placment of notebookOperationResults. * Remove unused file. * Use ErrorContract for error types. * Renamed RoleIdParameter to RoleIdQueryParameter to avoid conflict. * Use common hostname as other swagger files. * Add missing API path parameters defintiions. * Fix schema type for errors. * Use ErrorContract from synapse common types. * Use diff tags and titles for different packages. * Remove deprecated roles.json spec. Co-authored-by: Ravi Arora <raviarora@microsoft.com>
mkarmark · Jul 20, 2021 · c407127 · c407127
1 parent e68e70f
commit c407127
Show file tree

Hide file tree

Showing 136 changed files with 32,199 additions and 0 deletions.
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json
diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/bigDataPools.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/bigDataPools.json
@@ -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"
+    }
+  }
+}
diff --git a/...cation/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json b/...cation/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json
@@ -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."
+    }
+  }
+}