[Hub Generated] Review request for Microsoft.DocumentDB to add version preview/2021-10-15-preview #16211
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,350 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Cosmos DB", | ||
| "description": "Azure Cosmos DB Database Data Transfer Service Resource Provider REST API", | ||
| "version": "2021-10-15-preview" | ||
| }, | ||
| "host": "management.azure.com", | ||
| "schemes": [ | ||
| "https" | ||
| ], | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "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" | ||
| } | ||
| } | ||
| }, | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}": { | ||
| "put": { | ||
| "operationId": "DataTransferJobs_Create", | ||
| "description": "Creates a Data Transfer Job.", | ||
| "x-ms-examples": { | ||
| "CosmosDBDataTransferJobCreate": { | ||
| "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobCreate.json" | ||
| } | ||
| }, | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "./cosmos-db.json#/parameters/accountNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/JobNameParameter" | ||
| }, | ||
| { | ||
| "name": "jobCreateParameters", | ||
| "in": "body", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/CreateJobRequest" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "201": { | ||
|
Contributor
There was a problem hiding this comment.
If this is not a long running operation, you can just return 200 instead of 201.
Member
Author
There was a problem hiding this comment. This will require a fix on management service. I have pushed the fix in the pipeline, but deployment might take some time. As an exception can we merge this in the preview version and later fix it in GA.
Member
There was a problem hiding this comment. Success response is 200. 201 is optional to indicate first time creation. |
||
| "description": "Successful CreateJob response", | ||
| "schema": { | ||
| "$ref": "#/definitions/DataTransferJobGetResults" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "cosmos-db.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "get": { | ||
| "operationId": "DataTransferJobs_Get", | ||
| "description": "Get a Data Transfer Job.", | ||
| "x-ms-examples": { | ||
| "CosmosDBDataTransferJobGet": { | ||
| "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobGet.json" | ||
| } | ||
| }, | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "./cosmos-db.json#/parameters/accountNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/JobNameParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "The Data Transfer Job Properties retrieved successfully", | ||
| "schema": { | ||
| "$ref": "#/definitions/DataTransferJobGetResults" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "cosmos-db.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs": { | ||
| "get": { | ||
| "operationId": "DataTransferJobs_ListByDatabaseAccount", | ||
| "description": "Get a list of Data Transfer jobs.", | ||
| "x-ms-examples": { | ||
| "CosmosDBDataTransferJobFeed": { | ||
| "$ref": "./examples/data-transfer-service/CosmosDBDataTransferJobFeed.json" | ||
| } | ||
| }, | ||
| "x-ms-pageable": { | ||
| "nextLinkName": "nextLink" | ||
| }, | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "./cosmos-db.json#/parameters/accountNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "All Data Transfer Jobs retrieved successfully", | ||
| "schema": { | ||
| "$ref": "#/definitions/DataTransferJobFeedResults" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "cosmos-db.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "DataTransferDataSourceSink": { | ||
| "type": "object", | ||
| "description": "Base class for all DataTransfer source/sink", | ||
| "properties": { | ||
| "component": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "CosmosDBCassandra", | ||
| "AzureStorage" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "DataTransferComponent", | ||
| "modelAsString": true | ||
| }, | ||
| "default": "CosmosDBCassandra" | ||
| } | ||
| }, | ||
| "discriminator": "component", | ||
| "required": [ | ||
| "component" | ||
| ] | ||
| }, | ||
| "CosmosCassandraDataTransferDataSourceSink": { | ||
| "type": "object", | ||
| "description": "A CosmosDB Cassandra API data source/sink", | ||
| "properties": { | ||
| "keyspaceName": { | ||
| "type": "string" | ||
| }, | ||
| "tableName": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/definitions/DataTransferDataSourceSink" | ||
| } | ||
| ], | ||
| "required": [ | ||
| "keyspaceName", | ||
| "tableName" | ||
| ], | ||
| "x-ms-discriminator-value": "CosmosDBCassandra" | ||
| }, | ||
| "AzureBlobDataTransferDataSourceSink": { | ||
| "type": "object", | ||
| "description": "An Azure Blob Storage data source/sink", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/definitions/DataTransferDataSourceSink" | ||
| } | ||
| ], | ||
| "properties": { | ||
| "containerName": { | ||
| "type": "string" | ||
| }, | ||
| "endpointUrl": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "containerName" | ||
| ], | ||
| "x-ms-discriminator-value": "AzureBlobStorage" | ||
| }, | ||
| "DataTransferJobProperties": { | ||
| "description": "The properties of a DataTransfer Job", | ||
| "type": "object", | ||
| "properties": { | ||
| "jobName": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "Job Name" | ||
| }, | ||
| "source": { | ||
| "$ref": "#/definitions/DataTransferDataSourceSink", | ||
| "description": "Source DataStore details" | ||
| }, | ||
| "destination": { | ||
| "$ref": "#/definitions/DataTransferDataSourceSink", | ||
| "description": "Destination DataStore details" | ||
| }, | ||
| "status": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "Job Status" | ||
| }, | ||
| "percentageComplete": { | ||
| "readOnly": true, | ||
| "type": "number", | ||
| "description": "Percentage of completion." | ||
| }, | ||
| "lastUpdatedUtcTime": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "description": "Last Updated Time (ISO-8601 format)." | ||
| }, | ||
| "workerCount": { | ||
| "description": "Worker count", | ||
| "type": "integer", | ||
| "minimum": 0, | ||
| "format": "int32" | ||
| }, | ||
| "error": { | ||
| "readOnly": true, | ||
| "$ref": "./cosmos-db.json#/definitions/ErrorResponse", | ||
| "description": "Error response for Faulted job" | ||
| } | ||
niteshvijay1995 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, | ||
| "required": [ | ||
| "source", | ||
| "destination" | ||
| ] | ||
| }, | ||
| "CreateJobRequest": { | ||
niteshvijay1995 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "description": "Parameters to create Data Transfer Job", | ||
| "type": "object", | ||
| "properties": { | ||
| "properties": { | ||
| "$ref": "#/definitions/DataTransferJobProperties", | ||
| "description": "Data Transfer Create Job Properties" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "properties" | ||
| ], | ||
| "allOf": [ | ||
| { | ||
| "$ref": "./cosmos-db.json#/definitions/ARMProxyResource" | ||
| } | ||
| ] | ||
| }, | ||
| "DataTransferJobGetResults": { | ||
| "description": "A Cosmos DB Data Transfer Job", | ||
| "type": "object", | ||
| "properties": { | ||
| "properties": { | ||
| "x-ms-client-flatten": true, | ||
| "type": "object", | ||
| "$ref": "#/definitions/DataTransferJobProperties" | ||
| } | ||
| }, | ||
| "allOf": [ | ||
| { | ||
| "$ref": "./cosmos-db.json#/definitions/ARMProxyResource" | ||
| } | ||
| ] | ||
| }, | ||
| "DataTransferJobFeedResults": { | ||
| "description": "The List operation response, that contains the Data Transfer jobs and their properties.", | ||
| "type": "object", | ||
| "properties": { | ||
| "value": { | ||
| "readOnly": true, | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/DataTransferJobGetResults" | ||
| }, | ||
| "description": "List of Data Transfer jobs and their properties." | ||
| }, | ||
| "nextLink": { | ||
niteshvijay1995 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "URL to get the next set of Data Transfer job list results if there are any." | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "JobNameParameter": { | ||
| "name": "jobName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method", | ||
| "description": "Name of the Data Transfer Job" | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| { | ||
| "parameters": { | ||
| "accountName": "ddb1", | ||
| "resourceGroupName": "rg1", | ||
| "api-version": "2021-10-15-preview", | ||
| "subscriptionId": "subid", | ||
| "keyspaceName": "keyspaceName", | ||
| "createUpdateCassandraKeyspaceParameters": { | ||
| "location": "West US", | ||
| "tags": {}, | ||
| "properties": { | ||
| "resource": { | ||
| "id": "keyspaceName" | ||
| }, | ||
| "options": {} | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", | ||
| "name": "keyspaceName", | ||
| "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", | ||
| "location": "West US", | ||
| "tags": {}, | ||
| "properties": { | ||
| "resource": { | ||
| "id": "keyspaceName" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "202": {} | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.