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

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,330 @@
{
"swagger": "2.0",
"info": {
"version": "2021-06-01-preview",
"title": "ArtifactsClient",
"x-ms-code-generation-settings": {
"useDateTimeOffset": true
}
},
"x-ms-parameterized-host": {
"hostTemplate": "{endpoint}",
"useSchemePrefix": false,
"parameters": [
{
"$ref": "#/parameters/Endpoint"
}
]
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/datasets": {
"get": {
"tags": [
"datasets"
],
"operationId": "Dataset_GetDatasetsByWorkspace",
"x-ms-examples": {
"Datasets_ListByWorkspace": {
"$ref": "./examples/Datasets_ListByWorkspace.json"
}
},
"description": "Lists datasets.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/DatasetListResponse"
}
},
"default": {
"description": "An error response received from the Azure Synapse service.",
"schema": {
"$ref": "artifacts.json#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/datasets/{datasetName}": {
"put": {
"tags": [
"datasets"
],
"operationId": "Dataset_CreateOrUpdateDataset",
"x-ms-examples": {
"Datasets_Create": {
"$ref": "./examples/Datasets_Create.json"
},
"Datasets_Update": {
"$ref": "./examples/Datasets_Update.json"
}
},
"description": "Creates or updates a dataset.",
"x-ms-long-running-operation": true,
"parameters": [
{
"$ref": "#/parameters/datasetName"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "If-Match",
"in": "header",
"required": false,
"type": "string",
"description": "ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update."
},
{
"name": "dataset",
"description": "Dataset resource definition.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DatasetResource"
}
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/DatasetResource"
}
},
"202": {
"description": "Accepted."
},
"default": {
"description": "An error response received from the Azure Synapse service.",
"schema": {
"$ref": "artifacts.json#/definitions/CloudError"
}
}
}
},
"get": {
"tags": [
"datasets"
],
"operationId": "Dataset_GetDataset",
"x-ms-examples": {
"Datasets_Get": {
"$ref": "./examples/Datasets_Get.json"
}
},
"description": "Gets a dataset.",
"parameters": [
{
"$ref": "#/parameters/datasetName"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "If-None-Match",
"in": "header",
"required": false,
"type": "string",
"description": "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/DatasetResource"
}
},
"304": {
"description": "Not modified."
},
"default": {
"description": "An error response received from the Azure Synapse service.",
"schema": {
"$ref": "artifacts.json#/definitions/CloudError"
}
}
}
},
"delete": {
"tags": [
"datasets"
],
"operationId": "Dataset_DeleteDataset",
"x-ms-examples": {
"Datasets_Delete": {
"$ref": "./examples/Datasets_Delete.json"
}
},
"description": "Deletes a dataset.",
"x-ms-long-running-operation": true,
"parameters": [
{
"$ref": "#/parameters/datasetName"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"202": {
"description": "Accepted."
},
"204": {
"description": "No Content."
},
"default": {
"description": "An error response received from the Azure Synapse service.",
"schema": {
"$ref": "artifacts.json#/definitions/CloudError"
}
}
}
}
},
"/datasets/{datasetName}/rename": {
"post": {
"tags": [
"datasets"
],
"operationId": "Dataset_RenameDataset",
"x-ms-examples": {
"Datasets_Rename": {
"$ref": "./examples/Datasets_Rename.json"
}
},
"description": "Renames a dataset.",
"x-ms-long-running-operation": true,
"parameters": [
{
"$ref": "#/parameters/datasetName"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "request",
"description": "proposed new name.",
"in": "body",
"required": true,
"schema": {
"$ref": "artifacts.json#/definitions/ArtifactRenameRequest"
}
}
],
"responses": {
"200": {
"description": "OK."
},
"202": {
"description": "Accepted."
},
"default": {
"description": "An error response received from the Azure Synapse service.",
"schema": {
"$ref": "artifacts.json#/definitions/CloudError"
}
}
}
}
}
},
"definitions": {
"DatasetListResponse": {
"description": "A list of dataset resources.",
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "array",
"description": "List of datasets.",
"items": {
"$ref": "#/definitions/DatasetResource"
}
},
"nextLink": {
"description": "The link to the next page of results, if any remaining results exist.",
"type": "string"
}
}
},
"DatasetResource": {
"description": "Dataset resource type.",
"type": "object",
"allOf": [
{
"$ref": "artifacts.json#/definitions/SubResource"
}
],
"properties": {
"properties": {
"$ref": "./entityTypes/Dataset.json#/definitions/Dataset",
"description": "Dataset properties."
}
},
"required": [
"properties"
]
}
},
"parameters": {
"workspaceName": {
"name": "workspaceName",
"description": "The workspace name.",
"in": "path",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"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"
},
"datasetName": {
"name": "datasetName",
"description": "The dataset name.",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$",
"minLength": 1,
"maxLength": 260,
"x-ms-parameter-location": "method"
}
}
}
Loading