From a3787ca7bda12ccd748d22fa21da9fed1dda29f1 Mon Sep 17 00:00:00 2001 From: kalyanr Date: Fri, 24 Sep 2021 17:35:19 -0700 Subject: [PATCH] Rest API changes for SymsSync service (#15695) * Rest API changes for SymsSync service * fixing ci failures * correcting api version * addressing PR comments * addressing PR comments * fixing test failures * correcting the example file * changing description from resource to database * addressing PR comment for response type * Leave SymsSync only * Minor change * Add an empty line Co-authored-by: Kalyan Raman Co-authored-by: Dongwei Wang --- custom-words.txt | 1 + .../examples/Metastore_Delete.json | 18 ++ .../examples/Metastore_GetResourceStatus.json | 22 ++ .../examples/Metastore_Register.json | 25 ++ .../examples/Metastore_Update.json | 25 ++ .../preview/2021-07-01-preview/symsSync.json | 294 ++++++++++++++++++ specification/synapse/data-plane/readme.md | 11 + 7 files changed, 396 insertions(+) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Delete.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_GetResourceStatus.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Register.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Update.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/symsSync.json diff --git a/custom-words.txt b/custom-words.txt index a04e481ad062..9c862ae29be5 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2163,6 +2163,7 @@ updatehostname updatepolicy updateprivateendpointconnection updateproperties +updation upgradeos uploadbatchservicelogs uploadcertificate diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Delete.json new file mode 100644 index 000000000000..989cbe7eb3b8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-07-01-preview", + "id": "testdatabase" + }, + "responses": { + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_GetResourceStatus.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_GetResourceStatus.json new file mode 100644 index 000000000000..b2550f0c09dc --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_GetResourceStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-07-01-preview", + "id": "testdatabase" + }, + "responses": { + "200": { + "body": { + "status": "Completed" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Register.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Register.json new file mode 100644 index 000000000000..cb8214058b4f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Register.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-07-01-preview", + "id": "testdatabase", + "registerBody": { + "inputFolder": "https://testsymsstorage.dfs.core.windows.net/testsymscontainer/CDM/" + } + }, + "responses": { + "201": { + "body": { + "status": "Running" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Update.json new file mode 100644 index 000000000000..5a7855ae21f5 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/examples/Metastore_Update.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-07-01-preview", + "id": "testdatabase", + "updateBody": { + "inputFolder": "https://testsymsstorage.dfs.core.windows.net/testsymscontainer/CDM/" + } + }, + "responses": { + "201": { + "body": { + "status": "Running" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/symsSync.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/symsSync.json new file mode 100644 index 000000000000..209aa93367c1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-07-01-preview/symsSync.json @@ -0,0 +1,294 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-07-01-preview", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/metastore/create-database-operations/{id}": { + "put": { + "tags": [ + "metastore" + ], + "operationId": "Metastore_Register", + "description": "Register files in Syms", + "x-ms-examples": { + "Register files in Syms": { + "$ref": "./examples/Metastore_Register.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to be created. The name can contain only alphanumeric characters and should not exceed 24 characters" + }, + { + "in": "body", + "name": "registerBody", + "required": true, + "description": "The body for the register request", + "schema": { + "$ref": "#/definitions/metastoreRegisterObject" + } + } + ], + "responses": { + "201": { + "description": "The Job created for the resource creation/updation request", + "schema": { + "$ref": "#/definitions/metastoreRegistrationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + }, + "get": { + "tags": [ + "metastore" + ], + "operationId": "Metastore_GetDatabaseOperations", + "description": "Gets status of the database", + "x-ms-examples": { + "Register files in Syms": { + "$ref": "./examples/Metastore_GetResourceStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "path", + "name": "id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Request Success Response.", + "schema": { + "$ref": "#/definitions/metastoreRequestSuccessResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + }, + "/metastore/update-database-operations/{id}": { + "put": { + "tags": [ + "metastore" + ], + "operationId": "Metastore_Update", + "description": "Update files in Syms", + "x-ms-examples": { + "Register files in Syms": { + "$ref": "./examples/Metastore_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to be updated" + }, + { + "in": "body", + "name": "updateBody", + "required": true, + "description": "The body for the update request", + "schema": { + "$ref": "#/definitions/metastoreUpdateObject" + } + } + ], + "responses": { + "201": { + "description": "The Job created for the resource creation/updation request", + "schema": { + "$ref": "#/definitions/metastoreUpdationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + }, + "/metastore/databases/{id}": { + "delete": { + "tags": [ + "metastore" + ], + "operationId": "Metastore_Delete", + "description": "Remove files in Syms", + "x-ms-examples": { + "Register files in Syms": { + "$ref": "./examples/Metastore_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "path", + "name": "id", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The Job created for the resource Deletion request" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": { + "metastoreRegistrationResponse": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/RequestStatus" + } + } + }, + "metastoreUpdationResponse": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/RequestStatus" + } + } + }, + "metastoreRequestSuccessResponse": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/ResourceStatus" + } + } + }, + "ResourceStatus": { + "description": "Enumerates possible Status of the resource.", + "type": "string", + "enum": [ + "Creating", + "Created", + "Failed" + ], + "x-ms-enum": { + "name": "ResourceStatus", + "modelAsString": true + } + }, + "RequestStatus": { + "description": "Enumerates possible request statuses.", + "type": "string", + "enum": [ + "Running", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "RequestStatus", + "modelAsString": true + } + }, + "metastoreRegisterObject": { + "type": "object", + "required": [ + "inputFolder" + ], + "properties": { + "inputFolder": { + "type": "string", + "example": "https://testsymsstorage.blob.core.windows.net/testsymsstoragefilesystem/CDM/", + "description": "The input folder containing CDM files." + } + } + }, + "metastoreUpdateObject": { + "type": "object", + "required": [ + "inputFolder" + ], + "properties": { + "inputFolder": { + "type": "string", + "example": "https://testsymsstorage.blob.core.windows.net/testsymsstoragefilesystem/CDM/", + "description": "The input folder containing CDM files." + } + } + } + }, + "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" + } + } +} diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index 9458fe4a558f..f97bb8ed44ba 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -49,6 +49,17 @@ tag: package-vnet-2020-12-01 tag: package-monitoring-2020-12-01 ``` +### Tag: package-metadata-2021-07-01-preview + +These settings apply only when `--tag=package-metadata-2021-07-01-preview` is specified on the command line. + +**ATTENTION**: Please DO NOT generate SDK based on this tag. Synapse metadata API set is not ready to be included in SDK. + +``` yaml $(tag) == 'package-metadata-2021-07-01-preview' +input-file: + - Microsoft.Synapse/preview/2021-07-01-preview/symsSync.json +``` + ### Tag: package-artifacts-composite-v1 These settings apply only when `--tag=package-artifacts-composite-v1` is specified on the command line.