From 2fd11ee073ecd99e0829be961b95022b56a39fc2 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Wed, 24 Mar 2021 17:05:56 -0700 Subject: [PATCH 01/15] update API based on SDK team feedback --- .../v1.0-preview.1/TranslatorBatch.json | 117 +++++++++++++++--- 1 file changed, 103 insertions(+), 14 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index 754fc38b80a1..bae7a035b5c6 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -108,7 +108,7 @@ "Document Translation" ], "summary": "Returns a list of batch requests submitted and the status for each request", - "description": "Returns a list of batch requests submitted and the status for each request.\r\nThis list only contains batch requests submitted by the user (based on the subscription). The status for each request is sorted by id.\r\n \r\nIf the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.\r\nThe absence of a continuation token means that no additional pages are available.\r\n \r\n$top and $skip query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\nThe server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", + "description": "Returns a list of batch requests submitted and the status for each request.\r\nThis list only contains batch requests submitted by the user (based on the resource).\r\n \r\nIf the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.\r\nThe absence of a continuation token means that no additional pages are available.\r\n \r\n$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\n$top indicates the total number of records the user wants to be returned across all pages.\r\n$skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.\r\n$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\n$sort query parameter can be used to sort the returned list (ex \"$sort=createdDateTimeUtc asc\" or \"$sort=createdDateTimeUtc desc\").\r\nThe default sorting is descending by createdDateTimeUtc.\r\nSome query parameters can be used to filter the returned list (ex: \"status=Succeeded,Cancelled\") will only return succeeded and cancelled operations.\r\ncreatedDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.\r\nThe supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).\r\n \r\nThe server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", "operationId": "DocumentTranslation_GetOperations", "produces": [ "application/json" @@ -117,22 +117,61 @@ { "in": "query", "name": "$top", - "description": "Take the $top entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first", + "description": "$top indicates the total number of records the user wants to be returned across all pages.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.", "type": "integer", "format": "int32", - "default": 50, - "maximum": 100, - "minimum": 1 + "maximum": 2147483647, + "minimum": 0 }, { "in": "query", "name": "$skip", - "description": "Skip the $skip entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first", + "description": "$skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.", "type": "integer", "format": "int32", "default": 0, "maximum": 2147483647, "minimum": 0 + }, + { + "in": "query", + "name": "$maxpagesize", + "description": "$maxpagesize is the maximum items returned in the items in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "ids", + "description": "Ids to use in filtering", + "type": "string" + }, + { + "in": "query", + "name": "status", + "description": "Status to use in filtering", + "type": "string" + }, + { + "in": "query", + "name": "createdDateTimeUtcStart", + "description": "the start datetime to get items after", + "type": "string" + }, + { + "in": "query", + "name": "createdDateTimeUtcEnd", + "description": "the end datetime to get items before", + "type": "string" + }, + { + "in": "query", + "name": "$orderBy", + "description": "the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')", + "type": "string" } ], "responses": { @@ -509,7 +548,7 @@ "Document Translation" ], "summary": "Returns the status for all documents in a batch document translation request", - "description": "Returns the status for all documents in a batch document translation request.\r\n \r\nThe documents included in the response are sorted by document Id in descending order. If the number of documents in the response exceeds our paging limit, server-side paging is used.\r\nPaginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\n$top and $skip query parameters can be used to specify a number of results to return and an offset for the collection.\r\nThe server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", + "description": "Returns the status for all documents in a batch document translation request.\r\n \r\nIf the number of documents in the response exceeds our paging limit, server-side paging is used.\r\nPaginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\n$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\n$top indicates the total number of records the user wants to be returned across all pages.\r\n$skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\n$sort query parameter can be used to sort the returned list (ex \"$sort=createdDateTimeUtc asc\" or \"$sort=createdDateTimeUtc desc\").\r\nThe default sorting is descending by createdDateTimeUtc.\r\nSome query parameters can be used to filter the returned list (ex: \"status=Succeeded,Cancelled\") will only return succeeded and cancelled documents.\r\ncreatedDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.\r\nThe supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", "operationId": "DocumentTranslation_GetOperationDocumentsStatus", "produces": [ "application/json" @@ -526,22 +565,61 @@ { "in": "query", "name": "$top", - "description": "Take the $top entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first", + "description": "$top indicates the total number of records the user wants to be returned across all pages.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.", "type": "integer", "format": "int32", - "default": 50, - "maximum": 100, - "minimum": 1 + "maximum": 2147483647, + "minimum": 0 }, { "in": "query", "name": "$skip", - "description": "Skip the $skip entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first", + "description": "$skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.", "type": "integer", "format": "int32", "default": 0, "maximum": 2147483647, "minimum": 0 + }, + { + "in": "query", + "name": "$maxpagesize", + "description": "$maxpagesize is the maximum items returned in the items in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "ids", + "description": "Ids to use in filtering", + "type": "string" + }, + { + "in": "query", + "name": "status", + "description": "Status to use in filtering", + "type": "string" + }, + { + "in": "query", + "name": "createdDateTimeUtcStart", + "description": "the start datetime to get items after", + "type": "string" + }, + { + "in": "query", + "name": "createdDateTimeUtcEnd", + "description": "the end datetime to get items before", + "type": "string" + }, + { + "in": "query", + "name": "$orderBy", + "description": "the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')", + "type": "string" } ], "responses": { @@ -863,6 +941,7 @@ "Glossary": { "description": "Glossary / translation memory for the request", "required": [ + "format", "glossaryUrl" ], "type": "object", @@ -878,7 +957,7 @@ "example": "XLIFF" }, "version": { - "description": "Version", + "description": "Optional Version. If not specified, default is used.", "type": "string", "example": "2.0" }, @@ -1090,6 +1169,7 @@ "ErrorV2": { "description": "This contains an outer error with error code, message, details, target and an inner error with more descriptive details.", "required": [ + "code", "message" ], "type": "object", @@ -1232,8 +1312,8 @@ "createdDateTimeUtc", "id", "lastActionDateTimeUtc", - "path", "progress", + "sourcePath", "status", "to" ], @@ -1244,6 +1324,11 @@ "type": "string", "example": "https://myblob.blob.core.windows.net/mycontainer/fr/mydoc.txt" }, + "sourcePath": { + "description": "Location of the source document", + "type": "string", + "example": "https://myblob.blob.core.windows.net/mycontainer/fr/mydoc.txt" + }, "createdDateTimeUtc": { "format": "date-time", "description": "Operation created date time", @@ -1330,6 +1415,10 @@ "type": "string" } }, + "defaultVersion": { + "description": "Default version if none is specified", + "type": "string" + }, "versions": { "description": "Supported Version", "type": "array", From 09d59fa731fa0e71cfe1e51bd6a9466b8c2f6572 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Wed, 24 Mar 2021 20:33:09 -0700 Subject: [PATCH 02/15] update based on feedback --- .../v1.0-preview.1/TranslatorBatch.json | 34 +++++++++----- .../v1.0-preview.1/examples/document.json | 1 + .../v1.0-preview.1/examples/documents.json | 1 + .../v1.0-preview.1/examples/format.json | 45 +++++++------------ .../v1.0-preview.1/examples/operations.json | 2 +- 5 files changed, 40 insertions(+), 43 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index bae7a035b5c6..3228140061c5 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -108,7 +108,7 @@ "Document Translation" ], "summary": "Returns a list of batch requests submitted and the status for each request", - "description": "Returns a list of batch requests submitted and the status for each request.\r\nThis list only contains batch requests submitted by the user (based on the resource).\r\n \r\nIf the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.\r\nThe absence of a continuation token means that no additional pages are available.\r\n \r\n$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\n$top indicates the total number of records the user wants to be returned across all pages.\r\n$skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.\r\n$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\n$sort query parameter can be used to sort the returned list (ex \"$sort=createdDateTimeUtc asc\" or \"$sort=createdDateTimeUtc desc\").\r\nThe default sorting is descending by createdDateTimeUtc.\r\nSome query parameters can be used to filter the returned list (ex: \"status=Succeeded,Cancelled\") will only return succeeded and cancelled operations.\r\ncreatedDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.\r\nThe supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).\r\n \r\nThe server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", + "description": "Returns a list of batch requests submitted and the status for each request.\r\nThis list only contains batch requests submitted by the user (based on the resource).\r\n \r\nIf the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.\r\nThe absence of a continuation token means that no additional pages are available.\r\n \r\n$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\n$top indicates the total number of records the user wants to be returned across all pages.\r\n$skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.\r\n$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\n$orderBy query parameter can be used to sort the returned list (ex \"$orderBy=createdDateTimeUtc asc\" or \"$orderBy=createdDateTimeUtc desc\").\r\nThe default sorting is descending by createdDateTimeUtc.\r\nSome query parameters can be used to filter the returned list (ex: \"status=Succeeded,Cancelled\") will only return succeeded and cancelled operations.\r\ncreatedDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.\r\nThe supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).\r\n \r\nThe server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", "operationId": "DocumentTranslation_GetOperations", "produces": [ "application/json" @@ -147,25 +147,30 @@ "in": "query", "name": "ids", "description": "Ids to use in filtering", - "type": "string" + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } }, { "in": "query", "name": "status", - "description": "Status to use in filtering", - "type": "string" + "description": "Status to use in filtering" }, { "in": "query", "name": "createdDateTimeUtcStart", "description": "the start datetime to get items after", - "type": "string" + "type": "string", + "format": "date-time" }, { "in": "query", "name": "createdDateTimeUtcEnd", "description": "the end datetime to get items before", - "type": "string" + "type": "string", + "format": "date-time" }, { "in": "query", @@ -548,7 +553,7 @@ "Document Translation" ], "summary": "Returns the status for all documents in a batch document translation request", - "description": "Returns the status for all documents in a batch document translation request.\r\n \r\nIf the number of documents in the response exceeds our paging limit, server-side paging is used.\r\nPaginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\n$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\n$top indicates the total number of records the user wants to be returned across all pages.\r\n$skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\n$sort query parameter can be used to sort the returned list (ex \"$sort=createdDateTimeUtc asc\" or \"$sort=createdDateTimeUtc desc\").\r\nThe default sorting is descending by createdDateTimeUtc.\r\nSome query parameters can be used to filter the returned list (ex: \"status=Succeeded,Cancelled\") will only return succeeded and cancelled documents.\r\ncreatedDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.\r\nThe supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", + "description": "Returns the status for all documents in a batch document translation request.\r\n \r\nIf the number of documents in the response exceeds our paging limit, server-side paging is used.\r\nPaginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\n$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\n$top indicates the total number of records the user wants to be returned across all pages.\r\n$skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\n$orderBy query parameter can be used to sort the returned list (ex \"$orderBy=createdDateTimeUtc asc\" or \"$orderBy=createdDateTimeUtc desc\").\r\nThe default sorting is descending by createdDateTimeUtc.\r\nSome query parameters can be used to filter the returned list (ex: \"status=Succeeded,Cancelled\") will only return succeeded and cancelled documents.\r\ncreatedDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.\r\nThe supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", "operationId": "DocumentTranslation_GetOperationDocumentsStatus", "produces": [ "application/json" @@ -595,25 +600,30 @@ "in": "query", "name": "ids", "description": "Ids to use in filtering", - "type": "string" + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } }, { "in": "query", "name": "status", - "description": "Status to use in filtering", - "type": "string" + "description": "Status to use in filtering" }, { "in": "query", "name": "createdDateTimeUtcStart", "description": "the start datetime to get items after", - "type": "string" + "type": "string", + "format": "date-time" }, { "in": "query", "name": "createdDateTimeUtcEnd", "description": "the end datetime to get items before", - "type": "string" + "type": "string", + "format": "date-time" }, { "in": "query", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json index f5f45731270f..76c2ce7ddd20 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json @@ -86,6 +86,7 @@ }, "body": { "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt", + "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt", "createdDateTimeUtc": "2020-03-26T00:00:00Z", "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", "status": "Running", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json index c92c6b7ecd02..8b9743d2f711 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json @@ -89,6 +89,7 @@ "value": [ { "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt", + "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt", "createdDateTimeUtc": "2020-03-26T00:00:00Z", "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", "status": "Running", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json index fe48785fe1ae..01233805287f 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json @@ -59,8 +59,7 @@ ], "contentTypes": [ "text/plain" - ], - "versions": [] + ] }, { "format": "PortableDocumentFormat", @@ -69,8 +68,16 @@ ], "contentTypes": [ "application/pdf" + ] + }, + { + "format": "OpenXmlWord", + "fileExtensions": [ + ".docx" ], - "versions": [] + "contentTypes": [ + "application/vnd.openxmlformats-officedocument.wordprocessingml.document" + ] }, { "format": "OpenXmlPresentation", @@ -79,8 +86,7 @@ ], "contentTypes": [ "application/vnd.openxmlformats-officedocument.presentationml.presentation" - ], - "versions": [] + ] }, { "format": "OpenXmlSpreadsheet", @@ -89,38 +95,17 @@ ], "contentTypes": [ "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - ], - "versions": [] - }, - { - "format": "OutlookMailMessage", - "fileExtensions": [ - ".msg" - ], - "contentTypes": [ - "application/vnd.ms-outlook" - ], - "versions": [] + ] }, { "format": "HtmlFile", "fileExtensions": [ - ".html" + ".html", + ".htm" ], "contentTypes": [ "text/html" - ], - "versions": [] - }, - { - "format": "OpenXmlWord", - "fileExtensions": [ - ".docx" - ], - "contentTypes": [ - "application/vnd.openxmlformats-officedocument.wordprocessingml.document" - ], - "versions": [] + ] } ] } diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json index be97db209ed7..91a21eccc5c0 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json @@ -82,7 +82,7 @@ "inProgress": 0, "notYetStarted": 0, "cancelled": 0, - "totalCharacterCharged": 0 + "totalCharacterCharged": 1000 } } ] From 970fa2e2a65ff3007dc7054a1f06688160e8e0ac Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Wed, 24 Mar 2021 20:53:40 -0700 Subject: [PATCH 03/15] manually add ref --- .../preview/v1.0-preview.1/TranslatorBatch.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index 3228140061c5..5a48ad205a3b 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -156,7 +156,8 @@ { "in": "query", "name": "status", - "description": "Status to use in filtering" + "description": "Status to use in filtering", + "$ref": "#/definitions/Status" }, { "in": "query", @@ -609,7 +610,8 @@ { "in": "query", "name": "status", - "description": "Status to use in filtering" + "description": "Status to use in filtering", + "$ref": "#/definitions/Status" }, { "in": "query", From 2da0d476ef0448cb099e1976ee460656065d0119 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Wed, 24 Mar 2021 21:20:48 -0700 Subject: [PATCH 04/15] try to fix swagger --- .../preview/v1.0-preview.1/TranslatorBatch.json | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index 5a48ad205a3b..37d347df78d5 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -151,13 +151,16 @@ "items": { "format": "uuid", "type": "string" - } + }, + "collectionFormat": "csv" }, { "in": "query", "name": "status", "description": "Status to use in filtering", - "$ref": "#/definitions/Status" + "schema": { + "$ref": "#/definitions/Status" + } }, { "in": "query", @@ -605,13 +608,16 @@ "items": { "format": "uuid", "type": "string" - } + }, + "collectionFormat": "csv" }, { "in": "query", "name": "status", "description": "Status to use in filtering", - "$ref": "#/definitions/Status" + "schema": { + "$ref": "#/definitions/Status" + } }, { "in": "query", From 67741b98c161e9b3b2cdf35ef04c2c95b26149af Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Thu, 25 Mar 2021 14:15:26 -0700 Subject: [PATCH 05/15] update swagger based on feedback --- .../v1.0-preview.1/TranslatorBatch.json | 24 +++++++++---------- .../v1.0-preview.1/examples/documents.json | 12 ++++++++-- .../v1.0-preview.1/examples/operations.json | 12 +++++++++- 3 files changed, 33 insertions(+), 15 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index 37d347df78d5..a7583764b261 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -151,16 +151,13 @@ "items": { "format": "uuid", "type": "string" - }, - "collectionFormat": "csv" + } }, { "in": "query", "name": "status", "description": "Status to use in filtering", - "schema": { - "$ref": "#/definitions/Status" - } + "type": "string" }, { "in": "query", @@ -180,7 +177,10 @@ "in": "query", "name": "$orderBy", "description": "the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')", - "type": "string" + "type": "array", + "items": { + "type": "string" + } } ], "responses": { @@ -608,16 +608,13 @@ "items": { "format": "uuid", "type": "string" - }, - "collectionFormat": "csv" + } }, { "in": "query", "name": "status", "description": "Status to use in filtering", - "schema": { - "$ref": "#/definitions/Status" - } + "type": "string" }, { "in": "query", @@ -637,7 +634,10 @@ "in": "query", "name": "$orderBy", "description": "the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')", - "type": "string" + "type": "array", + "items": { + "type": "string" + } } ], "responses": { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json index 8b9743d2f711..0caaee57dbc8 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json @@ -6,8 +6,16 @@ "endpoint": "{endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", "id": "727BF148-F327-47A0-9481-ABAE6362F11E", - "$top": 5, - "$skip": 10 + "$top": 20, + "$skip": 10, + "$maxpagesize": 10, + "$orderBy": "CreatedDateTime asc", + "createdDateTimeUtcStart": "2021-03-23T00:03:38.0136316", + "createdDateTimeUtcEnd": "2021-03-25T00:03:38.0136316", + "Status": "Succeeded", + "ids": [ + "273622bd-835c-4946-9798-fd8f19f6bbf2" + ] }, "responses": { "401": { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json index 91a21eccc5c0..52e96c5d5ed3 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json @@ -4,7 +4,17 @@ "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}" + "Ocp-Apim-Subscription-Key": "{API key}", + "$top": 20, + "$skip": 10, + "$maxpagesize": 10, + "$orderBy": "CreatedDateTime asc", + "createdDateTimeUtcStart": "2021-03-23T00:03:38.0136316", + "createdDateTimeUtcEnd": "2021-03-25T00:03:38.0136316", + "Status": "Succeeded", + "ids": [ + "273622bd-835c-4946-9798-fd8f19f6bbf2" + ] }, "responses": { "401": { From ca709ba3bc158cca28eed5c01f93a3f74e496a14 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Thu, 25 Mar 2021 14:52:12 -0700 Subject: [PATCH 06/15] update swagger based on feedback. add retry-after --- .../v1.0-preview.1/TranslatorBatch.json | 34 ++++++++++++------- .../v1.0-preview.1/examples/documents.json | 4 ++- .../v1.0-preview.1/examples/format.json | 1 + .../v1.0-preview.1/examples/glossary.json | 1 + .../v1.0-preview.1/examples/operations.json | 4 ++- .../v1.0-preview.1/examples/storage.json | 1 + 6 files changed, 31 insertions(+), 14 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index a7583764b261..9746559f1a8c 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -136,7 +136,7 @@ { "in": "query", "name": "$maxpagesize", - "description": "$maxpagesize is the maximum items returned in the items in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.", + "description": "$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.", "type": "integer", "format": "int32", "default": 50, @@ -151,13 +151,17 @@ "items": { "format": "uuid", "type": "string" - } + }, + "maxLength": 25 }, { "in": "query", - "name": "status", - "description": "Status to use in filtering", - "type": "string" + "name": "statuses", + "description": "Statuses to use in filtering", + "type": "array", + "items": { + "$ref": "#/definitions/Status" + } }, { "in": "query", @@ -180,7 +184,8 @@ "type": "array", "items": { "type": "string" - } + }, + "maxLength": 1 } ], "responses": { @@ -593,7 +598,7 @@ { "in": "query", "name": "$maxpagesize", - "description": "$maxpagesize is the maximum items returned in the items in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.", + "description": "$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.", "type": "integer", "format": "int32", "default": 50, @@ -608,13 +613,17 @@ "items": { "format": "uuid", "type": "string" - } + }, + "maxLength": 25 }, { "in": "query", - "name": "status", - "description": "Status to use in filtering", - "type": "string" + "name": "statuses", + "description": "Statuses to use in filtering", + "type": "array", + "items": { + "$ref": "#/definitions/Status" + } }, { "in": "query", @@ -637,7 +646,8 @@ "type": "array", "items": { "type": "string" - } + }, + "maxLength": 1 } ], "responses": { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json index 0caaee57dbc8..156093bc15d4 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json @@ -12,7 +12,9 @@ "$orderBy": "CreatedDateTime asc", "createdDateTimeUtcStart": "2021-03-23T00:03:38.0136316", "createdDateTimeUtcEnd": "2021-03-25T00:03:38.0136316", - "Status": "Succeeded", + "statuses": [ + "Succeeded" + ], "ids": [ "273622bd-835c-4946-9798-fd8f19f6bbf2" ] diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json index 01233805287f..75b787a30523 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json @@ -48,6 +48,7 @@ }, "200": { "headers": { + "retry-after": "30", "ETag": "686897696a7c876b7e" }, "body": { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json index ec73e440dbb8..61347def0834 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json @@ -48,6 +48,7 @@ }, "200": { "headers": { + "retry-after": "30", "ETag": "686897696a7c876b7e" }, "body": { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json index 52e96c5d5ed3..cc1fb9ebd946 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json @@ -11,7 +11,9 @@ "$orderBy": "CreatedDateTime asc", "createdDateTimeUtcStart": "2021-03-23T00:03:38.0136316", "createdDateTimeUtcEnd": "2021-03-25T00:03:38.0136316", - "Status": "Succeeded", + "statuses": [ + "Succeeded" + ], "ids": [ "273622bd-835c-4946-9798-fd8f19f6bbf2" ] diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/storage.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/storage.json index 3a3064ae73c1..1180d718fd99 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/storage.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/storage.json @@ -48,6 +48,7 @@ }, "200": { "headers": { + "retry-after": "30", "ETag": "686897696a7c876b7e" }, "body": { From b132e086ae8e50124d89b9d3a6a6b22cc92ee8cc Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Thu, 25 Mar 2021 15:04:28 -0700 Subject: [PATCH 07/15] fix status type and datetime example --- .../v1.0-preview.1/TranslatorBatch.json | 57 ++++--------------- .../v1.0-preview.1/examples/documents.json | 4 +- .../v1.0-preview.1/examples/operations.json | 4 +- 3 files changed, 15 insertions(+), 50 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index 9746559f1a8c..7e56f9a35344 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -160,8 +160,9 @@ "description": "Statuses to use in filtering", "type": "array", "items": { - "$ref": "#/definitions/Status" - } + "type": "string" + }, + "maxLength": 5 }, { "in": "query", @@ -622,8 +623,9 @@ "description": "Statuses to use in filtering", "type": "array", "items": { - "$ref": "#/definitions/Status" - } + "type": "string" + }, + "maxLength": 5 }, { "in": "query", @@ -1088,46 +1090,6 @@ } } }, - "Status": { - "description": "List of possible statuses for job or document", - "enum": [ - "NotStarted", - "Running", - "Succeeded", - "Failed", - "Cancelled", - "Cancelling", - "ValidationFailed" - ], - "type": "string", - "x-ms-enum": { - "name": "Status", - "modelAsString": true, - "values": [ - { - "value": "NotStarted" - }, - { - "value": "Running" - }, - { - "value": "Succeeded" - }, - { - "value": "Failed" - }, - { - "value": "Cancelled" - }, - { - "value": "Cancelling" - }, - { - "value": "ValidationFailed" - } - ] - } - }, "ErrorCodeV2": { "description": "Enums containing high level error codes.", "enum": [ @@ -1304,7 +1266,9 @@ "example": "2020-01-20T11:41:07.7010000-08:00" }, "status": { - "$ref": "#/definitions/Status" + "description": "Overall Operation status", + "type": "string", + "example": "Succeeded" }, "error": { "$ref": "#/definitions/ErrorV2" @@ -1370,7 +1334,8 @@ "example": "2020-01-20T11:41:07.7010000-08:00" }, "status": { - "$ref": "#/definitions/Status" + "description": "Status / progress of the translation of the Document.", + "type": "string" }, "to": { "description": "To language", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json index 156093bc15d4..4560348c6333 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json @@ -10,8 +10,8 @@ "$skip": 10, "$maxpagesize": 10, "$orderBy": "CreatedDateTime asc", - "createdDateTimeUtcStart": "2021-03-23T00:03:38.0136316", - "createdDateTimeUtcEnd": "2021-03-25T00:03:38.0136316", + "createdDateTimeUtcStart": "2021-03-23T07:03:38.0136316Z", + "createdDateTimeUtcEnd": "2021-03-25T07:03:38.0136316Z", "statuses": [ "Succeeded" ], diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json index cc1fb9ebd946..b741f7a4cbd6 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json @@ -9,8 +9,8 @@ "$skip": 10, "$maxpagesize": 10, "$orderBy": "CreatedDateTime asc", - "createdDateTimeUtcStart": "2021-03-23T00:03:38.0136316", - "createdDateTimeUtcEnd": "2021-03-25T00:03:38.0136316", + "createdDateTimeUtcStart": "2021-03-23T07:03:38.0136316Z", + "createdDateTimeUtcEnd": "2021-03-25T07:03:38.0136316Z", "statuses": [ "Succeeded" ], From fd39065dbcf846bb4e6336620e0a789268418891 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Thu, 25 Mar 2021 15:43:31 -0700 Subject: [PATCH 08/15] update examples, added required parameters --- .../preview/v1.0-preview.1/TranslatorBatch.json | 5 +++++ .../v1.0-preview.1/examples/documents.json | 17 +++++++++-------- .../v1.0-preview.1/examples/glossary.json | 1 + .../v1.0-preview.1/examples/operations.json | 10 +++++----- 4 files changed, 20 insertions(+), 13 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index 7e56f9a35344..ddcc9e25140f 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -1387,6 +1387,11 @@ } }, "FileFormat": { + "required": [ + "contentTypes", + "fileExtensions", + "format" + ], "type": "object", "properties": { "format": { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json index 4560348c6333..a78c2a36b98e 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json @@ -6,17 +6,18 @@ "endpoint": "{endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", "id": "727BF148-F327-47A0-9481-ABAE6362F11E", - "$top": 20, - "$skip": 10, - "$maxpagesize": 10, - "$orderBy": "CreatedDateTime asc", + "$top": 2, + "$skip": 0, + "$maxpagesize": 1, + "$orderBy": "CreatedDateTimeUtc asc", "createdDateTimeUtcStart": "2021-03-23T07:03:38.0136316Z", "createdDateTimeUtcEnd": "2021-03-25T07:03:38.0136316Z", "statuses": [ "Succeeded" ], "ids": [ - "273622bd-835c-4946-9798-fd8f19f6bbf2" + "273622bd-835c-4946-9798-fd8f19f6bbf2", + "511b6a66-a6f8-4640-83e1-48c325e9fa29" ] }, "responses": { @@ -100,8 +101,8 @@ { "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt", "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt", - "createdDateTimeUtc": "2020-03-26T00:00:00Z", - "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "createdDateTimeUtc": "2021-03-23T07:03:39.013631Z", + "lastActionDateTimeUtc": "2021-03-23T07:03:41.012452Z", "status": "Running", "to": "fr", "progress": 0.1, @@ -109,7 +110,7 @@ "characterCharged": 0 } ], - "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15" + "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=1&$skip=1&$maxpagesize=1&$orderBy=CreatedDateTimeUtc asc&createdDateTimeUtcStart=2021-03-23T00:03:38.0136316Z&createdDateTimeUtcEnd=2021-03-25T00:03:38.0136316&statuses=Succeeded&ids=273622BD-835C-4946-9798-FD8F19F6BBF2,511B6A66-A6F8-4640-83E1-48C325E9FA29" } }, "400": { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json index 61347def0834..0b638db5c8ac 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json @@ -61,6 +61,7 @@ "contentTypes": [ "application/xliff+xml" ], + "defaultVersion": "1.2", "versions": [ "1.0", "1.1", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json index b741f7a4cbd6..0a03ff0e78f4 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json @@ -5,8 +5,8 @@ "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", - "$top": 20, - "$skip": 10, + "$top": 1, + "$skip": 0, "$maxpagesize": 10, "$orderBy": "CreatedDateTime asc", "createdDateTimeUtcStart": "2021-03-23T07:03:38.0136316Z", @@ -83,9 +83,9 @@ "body": { "value": [ { - "id": "727bf148-f327-47a0-9481-abae6362f11e", - "createdDateTimeUtc": "2020-03-26T00:00:00Z", - "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "id": "273622bd-835c-4946-9798-fd8f19f6bbf2", + "createdDateTimeUtc": "2021-03-23T07:03:30.013631Z", + "lastActionDateTimeUtc": "2021-03-26T01:00:00Z", "status": "Succeeded", "summary": { "total": 10, From 000d716149bfeef076e0aa968abe33d9156795e6 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Thu, 25 Mar 2021 16:53:29 -0700 Subject: [PATCH 09/15] make nextlink an urlencoded string --- .../preview/v1.0-preview.1/examples/documents.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json index a78c2a36b98e..c46aac3ed75a 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json @@ -110,7 +110,7 @@ "characterCharged": 0 } ], - "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=1&$skip=1&$maxpagesize=1&$orderBy=CreatedDateTimeUtc asc&createdDateTimeUtcStart=2021-03-23T00:03:38.0136316Z&createdDateTimeUtcEnd=2021-03-25T00:03:38.0136316&statuses=Succeeded&ids=273622BD-835C-4946-9798-FD8F19F6BBF2,511B6A66-A6F8-4640-83E1-48C325E9FA29" + "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=1&$skip=1&$maxpagesize=1&$orderBy=CreatedDateTimeUtc%20asc&createdDateTimeUtcStart=2021-03-23T00:03:38.0136316Z&createdDateTimeUtcEnd=2021-03-25T00:03:38.0136316&statuses=Succeeded&ids=273622BD-835C-4946-9798-FD8F19F6BBF2,511B6A66-A6F8-4640-83E1-48C325E9FA29" } }, "400": { From c1d2b21b1f6c0a9861b2dfd95d0d5661efdc8216 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Thu, 25 Mar 2021 17:44:30 -0700 Subject: [PATCH 10/15] add etag in swagger for these responses --- .../v1.0-preview.1/TranslatorBatch.json | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index ddcc9e25140f..d11bccb65668 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -758,6 +758,13 @@ "description": "Returns the list of supported document file formats", "schema": { "$ref": "#/definitions/FileFormatListResult" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + } } }, "429": { @@ -814,6 +821,13 @@ "description": "Returns the list of supported glossary file formats", "schema": { "$ref": "#/definitions/FileFormatListResult" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + } } }, "429": { @@ -870,6 +884,13 @@ "description": "Successful request and returns the list of storage sources", "schema": { "$ref": "#/definitions/StorageSourceListResult" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + } } }, "429": { From 9f593b82ea5140acf7927242604ba8cea0f0f6fb Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Thu, 25 Mar 2021 19:02:54 -0700 Subject: [PATCH 11/15] re-add x-ms-enums and schema for status --- .../v1.0-preview.1/TranslatorBatch.json | 47 +++++++++++++++++-- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json index d11bccb65668..2f49d9301271 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -1111,6 +1111,46 @@ } } }, + "Status": { + "description": "List of possible statuses for job or document", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling", + "ValidationFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "value": "NotStarted" + }, + { + "value": "Running" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Cancelled" + }, + { + "value": "Cancelling" + }, + { + "value": "ValidationFailed" + } + ] + } + }, "ErrorCodeV2": { "description": "Enums containing high level error codes.", "enum": [ @@ -1287,9 +1327,7 @@ "example": "2020-01-20T11:41:07.7010000-08:00" }, "status": { - "description": "Overall Operation status", - "type": "string", - "example": "Succeeded" + "$ref": "#/definitions/Status" }, "error": { "$ref": "#/definitions/ErrorV2" @@ -1355,8 +1393,7 @@ "example": "2020-01-20T11:41:07.7010000-08:00" }, "status": { - "description": "Status / progress of the translation of the Document.", - "type": "string" + "$ref": "#/definitions/Status" }, "to": { "description": "To language", From 1f810e96eafa775973172b5f84fd0e5c23cb9b02 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Mon, 29 Mar 2021 11:20:15 -0700 Subject: [PATCH 12/15] add new stable/v1.0 for batch translator --- .../data-plane/TranslatorText/readme.md | 19 + .../stable/v1.0/TranslatorBatch.json | 1557 +++++++++++++++++ .../stable/v1.0/examples/batch.json | 117 ++ .../stable/v1.0/examples/cancel.json | 100 ++ .../stable/v1.0/examples/document.json | 100 ++ .../stable/v1.0/examples/documents.json | 131 ++ .../stable/v1.0/examples/format.json | 115 ++ .../stable/v1.0/examples/glossary.json | 89 + .../stable/v1.0/examples/operation.json | 103 ++ .../stable/v1.0/examples/operations.json | 118 ++ .../stable/v1.0/examples/storage.json | 61 + 11 files changed, 2510 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/cancel.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/document.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/format.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/glossary.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operation.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operations.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/storage.json diff --git a/specification/cognitiveservices/data-plane/TranslatorText/readme.md b/specification/cognitiveservices/data-plane/TranslatorText/readme.md index 707bf7b6e9af..ee92b47d0e7f 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/readme.md +++ b/specification/cognitiveservices/data-plane/TranslatorText/readme.md @@ -21,7 +21,12 @@ tag: release_1_0_preview.1 add-credentials: true openapi-type: data-plane ``` +``` yaml +tag: release_1_0 +add-credentials: true +openapi-type: data-plane +``` # Releases ### Preview 1.0 @@ -30,6 +35,12 @@ This setting is for batch document translator and only applied when `--tag=relea input-file: preview/v1.0-preview.1/TranslatorBatch.json ``` +### 1.0 Batch API +This setting is for batch document translator and only applied when `--tag=release_1_0` is specified on the command line. +``` yaml $(tag) == 'release_1_0_preview.1' +input-file: stable/v1.0/TranslatorBatch.json +``` + ### Release 3.0 These settings apply only when `--tag=release_3_0` is specified on the command line. @@ -106,6 +117,14 @@ These settings apply only when `--tag=release_1_0_preview.1 --nodejs` is specifi package-version: 1.0.1 ``` +### Tag: release_1_0 and nodejs + +These settings apply only when `--tag=release_1_0 --nodejs` is specified on the command line. + +``` yaml $(tag) == 'release_1_0_preview.1' && $(nodejs) + package-version: 1.0 +``` + ### Tag: release_3_0 and go These settings apply only when `--tag=release_3_0 --nodejs` is specified on the command line. diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json new file mode 100644 index 000000000000..2f49d9301271 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json @@ -0,0 +1,1557 @@ +{ + "swagger": "2.0", + "info": { + "title": "Batch Document Translation Client", + "version": "v1.0-preview.1" + }, + "paths": { + "/batches": { + "post": { + "tags": [ + "Document Translation" + ], + "summary": "Submit a document translation request to the Document Translation service", + "description": "Use this API to submit a bulk (batch) translation request to the Document Translation service.\r\nEach request can contain multiple documents and must contain a source and destination container for each document.\r\n \r\nThe prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.\r\n \r\nGlossaries / Translation memory can be included in the request and are applied by the service when the document is translated.\r\n \r\nIf the glossary is invalid or unreachable during translation, an error is indicated in the document status.\r\nIf a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.", + "operationId": "DocumentTranslation_SubmitBatchRequest", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "request details", + "schema": { + "$ref": "#/definitions/BatchSubmissionRequest" + } + } + ], + "responses": { + "202": { + "description": "Successful request and the batch request is created by the service. The header Operation-Location will indicate a status url with the operation id.", + "headers": { + "Operation-Location": { + "description": "Location of batch the operation", + "type": "string", + "format": "" + } + } + }, + "400": { + "description": "Invalid request. Check input parameters", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Batch Submit": { + "$ref": "./examples/batch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Document Translation" + ], + "summary": "Returns a list of batch requests submitted and the status for each request", + "description": "Returns a list of batch requests submitted and the status for each request.\r\nThis list only contains batch requests submitted by the user (based on the resource).\r\n \r\nIf the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.\r\nThe absence of a continuation token means that no additional pages are available.\r\n \r\n$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\n$top indicates the total number of records the user wants to be returned across all pages.\r\n$skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.\r\n$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\n$orderBy query parameter can be used to sort the returned list (ex \"$orderBy=createdDateTimeUtc asc\" or \"$orderBy=createdDateTimeUtc desc\").\r\nThe default sorting is descending by createdDateTimeUtc.\r\nSome query parameters can be used to filter the returned list (ex: \"status=Succeeded,Cancelled\") will only return succeeded and cancelled operations.\r\ncreatedDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.\r\nThe supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).\r\n \r\nThe server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", + "operationId": "DocumentTranslation_GetOperations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "$top", + "description": "$top indicates the total number of records the user wants to be returned across all pages.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.", + "type": "integer", + "format": "int32", + "maximum": 2147483647, + "minimum": 0 + }, + { + "in": "query", + "name": "$skip", + "description": "$skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + { + "in": "query", + "name": "$maxpagesize", + "description": "$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "ids", + "description": "Ids to use in filtering", + "type": "array", + "items": { + "format": "uuid", + "type": "string" + }, + "maxLength": 25 + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses to use in filtering", + "type": "array", + "items": { + "type": "string" + }, + "maxLength": 5 + }, + { + "in": "query", + "name": "createdDateTimeUtcStart", + "description": "the start datetime to get items after", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "createdDateTimeUtcEnd", + "description": "the end datetime to get items before", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$orderBy", + "description": "the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')", + "type": "array", + "items": { + "type": "string" + }, + "maxLength": 1 + } + ], + "responses": { + "200": { + "description": "Successful request and returns the status of the all the operations", + "schema": { + "$ref": "#/definitions/BatchStatusResponse" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + }, + "ETag": { + "description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.", + "type": "string", + "format": "" + } + } + }, + "400": { + "description": "Invalid request. Check input parameters", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get status for batch operations": { + "$ref": "./examples/operations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/batches/{id}/documents/{documentId}": { + "get": { + "tags": [ + "Document Translation" + ], + "summary": "Returns the status for a specific document", + "description": "Returns the translation status for a specific document based on the request Id and document Id.", + "operationId": "DocumentTranslation_GetDocumentStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Format - uuid. The batch id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "documentId", + "description": "Format - uuid. The document id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successful request and it is accepted by the service. The operation details are returned", + "schema": { + "$ref": "#/definitions/DocumentStatusDetail" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + }, + "ETag": { + "description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.", + "type": "string", + "format": "" + } + } + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "404": { + "description": "Resource is not found", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Document Status": { + "$ref": "./examples/document.json" + } + } + } + }, + "/batches/{id}": { + "get": { + "tags": [ + "Document Translation" + ], + "summary": "Returns the status for a document translation request", + "description": "Returns the status for a document translation request.\r\nThe status includes the overall request status, as well as the status for documents that are being translated as part of that request.", + "operationId": "DocumentTranslation_GetOperationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Format - uuid. The operation id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successful request and returns the status of the batch translation operation", + "schema": { + "$ref": "#/definitions/BatchStatusDetail" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + }, + "ETag": { + "description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.", + "type": "string", + "format": "" + } + } + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "404": { + "description": "Resource is not found", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Batch Operation Status": { + "$ref": "./examples/operation.json" + } + } + }, + "delete": { + "tags": [ + "Document Translation" + ], + "summary": "Cancel a currently processing or queued operation", + "description": "Cancel a currently processing or queued operation.\r\nCancel a currently processing or queued operation.\r\nAn operation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.\r\nAll documents that have completed translation will not be cancelled and will be charged.\r\nAll pending documents will be cancelled if possible.", + "operationId": "DocumentTranslation_CancelOperation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Format - uuid. The operation-id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Cancel request has been submitted", + "schema": { + "$ref": "#/definitions/BatchStatusDetail" + } + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "404": { + "description": "Resource is not found", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Cancel a batch operation example": { + "$ref": "./examples/cancel.json" + } + } + } + }, + "/batches/{id}/documents": { + "get": { + "tags": [ + "Document Translation" + ], + "summary": "Returns the status for all documents in a batch document translation request", + "description": "Returns the status for all documents in a batch document translation request.\r\n \r\nIf the number of documents in the response exceeds our paging limit, server-side paging is used.\r\nPaginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\n$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.\r\n \r\n$top indicates the total number of records the user wants to be returned across all pages.\r\n$skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\n$orderBy query parameter can be used to sort the returned list (ex \"$orderBy=createdDateTimeUtc asc\" or \"$orderBy=createdDateTimeUtc desc\").\r\nThe default sorting is descending by createdDateTimeUtc.\r\nSome query parameters can be used to filter the returned list (ex: \"status=Succeeded,Cancelled\") will only return succeeded and cancelled documents.\r\ncreatedDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.\r\nThe supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).\r\n \r\nWhen both $top and $skip are included, the server should first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.\r\nThis reduces the risk of the client making assumptions about the data returned.", + "operationId": "DocumentTranslation_GetOperationDocumentsStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Format - uuid. The operation id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$top", + "description": "$top indicates the total number of records the user wants to be returned across all pages.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.", + "type": "integer", + "format": "int32", + "maximum": 2147483647, + "minimum": 0 + }, + { + "in": "query", + "name": "$skip", + "description": "$skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + }, + { + "in": "query", + "name": "$maxpagesize", + "description": "$maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.\r\n \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "ids", + "description": "Ids to use in filtering", + "type": "array", + "items": { + "format": "uuid", + "type": "string" + }, + "maxLength": 25 + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses to use in filtering", + "type": "array", + "items": { + "type": "string" + }, + "maxLength": 5 + }, + { + "in": "query", + "name": "createdDateTimeUtcStart", + "description": "the start datetime to get items after", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "createdDateTimeUtcEnd", + "description": "the end datetime to get items before", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$orderBy", + "description": "the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')", + "type": "array", + "items": { + "type": "string" + }, + "maxLength": 1 + } + ], + "responses": { + "200": { + "description": "Successful request and returns the status of the documents", + "schema": { + "$ref": "#/definitions/DocumentStatusResponse" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + }, + "ETag": { + "description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.", + "type": "string", + "format": "" + } + } + }, + "400": { + "description": "Invalid request. Check input parameters", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "404": { + "description": "Resource is not found", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Documents Status for the operation batch id": { + "$ref": "./examples/documents.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "@nextLink" + } + } + }, + "/documents/formats": { + "get": { + "tags": [ + "Document Translation" + ], + "summary": "Returns a list of supported document formats", + "description": "The list of supported document formats supported by the Document Translation service.\r\nThe list includes the common file extension, as well as the content-type if using the upload API.", + "operationId": "DocumentTranslation_GetDocumentFormats", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns the list of supported document file formats", + "schema": { + "$ref": "#/definitions/FileFormatListResult" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Document Formats": { + "$ref": "./examples/format.json" + } + } + } + }, + "/glossaries/formats": { + "get": { + "tags": [ + "Document Translation" + ], + "summary": "Returns the list of supported glossary formats", + "description": "The list of supported glossary formats supported by the Document Translation service.\r\nThe list includes the common file extension used.", + "operationId": "DocumentTranslation_GetGlossaryFormats", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns the list of supported glossary file formats", + "schema": { + "$ref": "#/definitions/FileFormatListResult" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Glossary Formats": { + "$ref": "./examples/glossary.json" + } + } + } + }, + "/storagesources": { + "get": { + "tags": [ + "Document Translation" + ], + "summary": "Returns a list of supported storage sources", + "description": "Returns a list of storage sources/options supported by the Document Translation service.", + "operationId": "DocumentTranslation_GetDocumentStorageSource", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful request and returns the list of storage sources", + "schema": { + "$ref": "#/definitions/StorageSourceListResult" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User's request rate is too high\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Document Storage Sources": { + "$ref": "./examples/storage.json" + } + } + } + } + }, + "definitions": { + "DocumentFilter": { + "type": "object", + "properties": { + "prefix": { + "description": "A case-sensitive prefix string to filter documents in the source path for translation. \r\nFor example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for translation.", + "type": "string", + "example": "FolderA" + }, + "suffix": { + "description": "A case-sensitive suffix string to filter documents in the source path for translation. \r\nThis is most often use for file extensions", + "type": "string", + "example": ".txt" + } + } + }, + "StorageSource": { + "description": "Storage Source", + "enum": [ + "AzureBlob" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageSource", + "modelAsString": true, + "values": [ + { + "value": "AzureBlob" + } + ] + } + }, + "SourceInput": { + "description": "Source of the input documents", + "required": [ + "sourceUrl" + ], + "type": "object", + "properties": { + "sourceUrl": { + "description": "Location of the folder / container or single file with your documents", + "type": "string", + "example": "https://myblob.blob.core.windows.net/Container/" + }, + "filter": { + "$ref": "#/definitions/DocumentFilter" + }, + "language": { + "description": "Language code\r\nIf none is specified, we will perform auto detect on the document", + "type": "string", + "example": "en" + }, + "storageSource": { + "$ref": "#/definitions/StorageSource" + } + } + }, + "Glossary": { + "description": "Glossary / translation memory for the request", + "required": [ + "format", + "glossaryUrl" + ], + "type": "object", + "properties": { + "glossaryUrl": { + "description": "Location of the glossary. \r\nWe will use the file extension to extract the formatting if the format parameter is not supplied.\r\n\r\nIf the translation language pair is not present in the glossary, it will not be applied", + "type": "string", + "example": "https://myblob.blob.core.windows.net/Container/myglossary.tsv" + }, + "format": { + "description": "Format", + "type": "string", + "example": "XLIFF" + }, + "version": { + "description": "Optional Version. If not specified, default is used.", + "type": "string", + "example": "2.0" + }, + "storageSource": { + "$ref": "#/definitions/StorageSource" + } + } + }, + "TargetInput": { + "description": "Destination for the finished translated documents", + "required": [ + "language", + "targetUrl" + ], + "type": "object", + "properties": { + "targetUrl": { + "description": "Location of the folder / container with your documents", + "type": "string", + "example": "https://myblob.blob.core.windows.net/TargetUrl/" + }, + "category": { + "description": "Category / custom system for translation request", + "type": "string", + "example": "general" + }, + "language": { + "description": "Target Language", + "type": "string", + "example": "fr" + }, + "glossaries": { + "description": "List of Glossary", + "type": "array", + "items": { + "$ref": "#/definitions/Glossary" + } + }, + "storageSource": { + "$ref": "#/definitions/StorageSource" + } + } + }, + "StorageInputType": { + "description": "Storage type of the input documents source string", + "enum": [ + "Folder", + "File" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageInputType", + "modelAsString": true, + "values": [ + { + "value": "Folder" + }, + { + "value": "File" + } + ] + } + }, + "BatchRequest": { + "description": "Definition for the input batch translation request", + "required": [ + "source", + "targets" + ], + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/SourceInput" + }, + "targets": { + "description": "Location of the destination for the output", + "type": "array", + "items": { + "$ref": "#/definitions/TargetInput" + } + }, + "storageType": { + "$ref": "#/definitions/StorageInputType" + } + } + }, + "BatchSubmissionRequest": { + "description": "Job submission batch request", + "required": [ + "inputs" + ], + "type": "object", + "properties": { + "inputs": { + "description": "The input list of documents or folders containing documents", + "type": "array", + "items": { + "$ref": "#/definitions/BatchRequest" + } + } + } + }, + "Status": { + "description": "List of possible statuses for job or document", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling", + "ValidationFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "value": "NotStarted" + }, + { + "value": "Running" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Cancelled" + }, + { + "value": "Cancelling" + }, + { + "value": "ValidationFailed" + } + ] + } + }, + "ErrorCodeV2": { + "description": "Enums containing high level error codes.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "ResourceNotFound", + "Unauthorized", + "RequestRateTooHigh" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCodeV2", + "modelAsString": true, + "values": [ + { + "value": "InvalidRequest" + }, + { + "value": "InvalidArgument" + }, + { + "value": "InternalServerError" + }, + { + "value": "ServiceUnavailable" + }, + { + "value": "ResourceNotFound" + }, + { + "value": "Unauthorized" + }, + { + "value": "RequestRateTooHigh" + } + ] + } + }, + "InnerErrorV2": { + "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "Gets code error string.", + "type": "string" + }, + "message": { + "description": "Gets high level error message.", + "type": "string" + }, + "target": { + "description": "Gets the source of the error. \r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string", + "readOnly": true + }, + "innerError": { + "$ref": "#/definitions/InnerErrorV2" + } + } + }, + "ErrorV2": { + "description": "This contains an outer error with error code, message, details, target and an inner error with more descriptive details.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCodeV2" + }, + "message": { + "description": "Gets high level error message.", + "type": "string" + }, + "target": { + "description": "Gets the source of the error. \r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string", + "readOnly": true + }, + "innerError": { + "$ref": "#/definitions/InnerErrorV2" + } + } + }, + "StatusSummary": { + "required": [ + "cancelled", + "failed", + "inProgress", + "notYetStarted", + "success", + "total", + "totalCharacterCharged" + ], + "type": "object", + "properties": { + "total": { + "format": "int32", + "description": "Total count", + "type": "integer", + "example": 1 + }, + "failed": { + "format": "int32", + "description": "Failed count", + "type": "integer", + "example": 0 + }, + "success": { + "format": "int32", + "description": "Number of Success", + "type": "integer", + "example": 1 + }, + "inProgress": { + "format": "int32", + "description": "Number of in progress", + "type": "integer", + "example": 0 + }, + "notYetStarted": { + "format": "int32", + "description": "Count of not yet started", + "type": "integer", + "example": 0 + }, + "cancelled": { + "format": "int32", + "description": "Number of cancelled", + "type": "integer", + "example": 0 + }, + "totalCharacterCharged": { + "format": "int64", + "description": "Total characters charged by the API", + "type": "integer" + } + } + }, + "BatchStatusDetail": { + "description": "Job status response", + "required": [ + "createdDateTimeUtc", + "id", + "lastActionDateTimeUtc", + "status", + "summary" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Id of the operation.", + "type": "string", + "example": "36724748-f7a0-4db7-b7fd-f041ddc75033" + }, + "createdDateTimeUtc": { + "format": "date-time", + "description": "Operation created date time", + "type": "string", + "example": "2020-01-20T11:40:07.7010000-08:00" + }, + "lastActionDateTimeUtc": { + "format": "date-time", + "description": "Date time in which the operation's status has been updated", + "type": "string", + "example": "2020-01-20T11:41:07.7010000-08:00" + }, + "status": { + "$ref": "#/definitions/Status" + }, + "error": { + "$ref": "#/definitions/ErrorV2" + }, + "summary": { + "$ref": "#/definitions/StatusSummary" + } + } + }, + "BatchStatusResponse": { + "description": "Document Status Response", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "The summary status of individual operation", + "type": "array", + "items": { + "$ref": "#/definitions/BatchStatusDetail" + } + }, + "@nextLink": { + "description": "Url for the next page. Null if no more pages available", + "type": "string", + "example": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operations?$top=5&$skip=15" + } + } + }, + "DocumentStatusDetail": { + "required": [ + "createdDateTimeUtc", + "id", + "lastActionDateTimeUtc", + "progress", + "sourcePath", + "status", + "to" + ], + "type": "object", + "properties": { + "path": { + "description": "Location of the document or folder", + "type": "string", + "example": "https://myblob.blob.core.windows.net/mycontainer/fr/mydoc.txt" + }, + "sourcePath": { + "description": "Location of the source document", + "type": "string", + "example": "https://myblob.blob.core.windows.net/mycontainer/fr/mydoc.txt" + }, + "createdDateTimeUtc": { + "format": "date-time", + "description": "Operation created date time", + "type": "string", + "example": "2020-01-20T11:40:07.7010000-08:00" + }, + "lastActionDateTimeUtc": { + "format": "date-time", + "description": "Date time in which the operation's status has been updated", + "type": "string", + "example": "2020-01-20T11:41:07.7010000-08:00" + }, + "status": { + "$ref": "#/definitions/Status" + }, + "to": { + "description": "To language", + "type": "string" + }, + "error": { + "$ref": "#/definitions/ErrorV2" + }, + "progress": { + "format": "float", + "description": "Progress of the translation if available", + "maximum": 1, + "minimum": 0, + "type": "number", + "example": 0.5 + }, + "id": { + "format": "uuid", + "description": "Document Id", + "type": "string", + "example": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d" + }, + "characterCharged": { + "format": "int64", + "description": "Character charged by the API", + "type": "integer" + } + } + }, + "DocumentStatusResponse": { + "description": "Document Status Response", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "The detail status of individual documents", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentStatusDetail" + } + }, + "@nextLink": { + "description": "Url for the next page. Null if no more pages available", + "type": "string", + "example": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/documents?$top=5&$skip=15" + } + } + }, + "FileFormat": { + "required": [ + "contentTypes", + "fileExtensions", + "format" + ], + "type": "object", + "properties": { + "format": { + "description": "Name of the format", + "type": "string", + "example": "PlainText" + }, + "fileExtensions": { + "description": "Supported file extension for this format", + "type": "array", + "items": { + "type": "string" + } + }, + "contentTypes": { + "description": "Supported Content-Types for this format", + "type": "array", + "items": { + "type": "string" + } + }, + "defaultVersion": { + "description": "Default version if none is specified", + "type": "string" + }, + "versions": { + "description": "Supported Version", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FileFormatListResult": { + "description": "Base type for List return in our api", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "list of objects", + "type": "array", + "items": { + "$ref": "#/definitions/FileFormat" + } + } + } + }, + "StorageSourceListResult": { + "description": "Base type for List return in our api", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "list of objects", + "type": "array", + "items": { + "$ref": "#/definitions/StorageSource" + } + } + } + }, + "ErrorResponseV2": { + "description": "Contains unified error information used for HTTP responses across any Cognitive Service. Instances\r\ncan be created either through Microsoft.CloudAI.Containers.HttpStatusExceptionV2 or by returning it directly from\r\na controller.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorV2" + } + } + } + }, + "securityDefinitions": { + "subscription_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services subscription key here." + } + }, + "security": [ + { + "subscription_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/translator/text/batch/v1.0-preview.1", + "useSchemePrefix": false, + "parameters": [ + { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json new file mode 100644 index 000000000000..7108552c493f --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "batchRequest": { + "inputs": [ + { + "source": { + "sourceUrl": "https://myblob.blob.core.windows.net/sourceContainer", + "filter": { + "prefix": "pre", + "suffix": ".txt" + }, + "language": "en", + "storageSource": "AzureBlob" + }, + "targets": [ + { + "targetUrl": "https://myblob.blob.core.windows.net/destinationContainer1", + "category": "general", + "language": "fr", + "glossaries": [ + { + "glossaryUrl": "https://myblob.blob.core.windows.net/myglossary/en_fr_glossary.xlf", + "storageSource": "AzureBlob" + } + ], + "storageSource": "AzureBlob" + }, + { + "targetUrl": "https://myblob.blob.core.windows.net/destinationContainer2", + "category": "general", + "language": "es", + "storageSource": "AzureBlob" + } + ], + "storageType": "Folder" + } + ] + } + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "innerError": { + "code": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "202": { + "headers": { + "Operation-Location": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Some argument is incorrect", + "innerError": { + "code": "SASTokenInvalid", + "message": "SAS token for storage is invalid" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/cancel.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/cancel.json new file mode 100644 index 000000000000..0861cf840b0c --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/cancel.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "id": "727BF148-F327-47A0-9481-ABAE6362F11E" + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Operation", + "innerError": { + "code": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Operation", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Operation", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Operation", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "ResourceNotFound", + "message": "id not found", + "target": "Operation", + "innerError": { + "code": "ResourceNotFound", + "message": "Resource requested is not found" + } + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "727bf148-f327-47a0-9481-abae6362f11e", + "createdDateTimeUtc": "2020-03-26T00:00:00Z", + "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "status": "Succeeded", + "summary": { + "total": 10, + "failed": 1, + "success": 9, + "inProgress": 0, + "notYetStarted": 0, + "cancelled": 0, + "totalCharacterCharged": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/document.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/document.json new file mode 100644 index 000000000000..76c2ce7ddd20 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/document.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "id": "727BF148-F327-47A0-9481-ABAE6362F11E", + "documentId": 199800 + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Document", + "innerError": { + "code": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Document", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Document", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Document", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "ResourceNotFound", + "message": "id not found", + "target": "Document", + "innerError": { + "code": "ResourceNotFound", + "message": "Resource requested is not found" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt", + "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt", + "createdDateTimeUtc": "2020-03-26T00:00:00Z", + "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "status": "Running", + "to": "fr", + "progress": 0.1, + "id": "273622bd-835c-4946-9798-fd8f19f6bbf2", + "characterCharged": 0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json new file mode 100644 index 000000000000..c46aac3ed75a --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "id": "727BF148-F327-47A0-9481-ABAE6362F11E", + "$top": 2, + "$skip": 0, + "$maxpagesize": 1, + "$orderBy": "CreatedDateTimeUtc asc", + "createdDateTimeUtcStart": "2021-03-23T07:03:38.0136316Z", + "createdDateTimeUtcEnd": "2021-03-25T07:03:38.0136316Z", + "statuses": [ + "Succeeded" + ], + "ids": [ + "273622bd-835c-4946-9798-fd8f19f6bbf2", + "511b6a66-a6f8-4640-83e1-48c325e9fa29" + ] + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Document", + "innerError": { + "code": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Document", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Document", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Document", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "ResourceNotFound", + "message": "id not found", + "target": "Document", + "innerError": { + "code": "ResourceNotFound", + "message": "Resource requested is not found" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + { + "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt", + "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt", + "createdDateTimeUtc": "2021-03-23T07:03:39.013631Z", + "lastActionDateTimeUtc": "2021-03-23T07:03:41.012452Z", + "status": "Running", + "to": "fr", + "progress": 0.1, + "id": "273622bd-835c-4946-9798-fd8f19f6bbf2", + "characterCharged": 0 + } + ], + "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=1&$skip=1&$maxpagesize=1&$orderBy=CreatedDateTimeUtc%20asc&createdDateTimeUtcStart=2021-03-23T00:03:38.0136316Z&createdDateTimeUtcEnd=2021-03-25T00:03:38.0136316&statuses=Succeeded&ids=273622BD-835C-4946-9798-FD8F19F6BBF2,511B6A66-A6F8-4640-83E1-48C325E9FA29" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Some argument is incorrect", + "target": "Document", + "innerError": { + "code": "SASTokenInvalid", + "message": "SAS token for storage is invalid" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/format.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/format.json new file mode 100644 index 000000000000..75b787a30523 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/format.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + { + "format": "PlainText", + "fileExtensions": [ + ".txt" + ], + "contentTypes": [ + "text/plain" + ] + }, + { + "format": "PortableDocumentFormat", + "fileExtensions": [ + ".pdf" + ], + "contentTypes": [ + "application/pdf" + ] + }, + { + "format": "OpenXmlWord", + "fileExtensions": [ + ".docx" + ], + "contentTypes": [ + "application/vnd.openxmlformats-officedocument.wordprocessingml.document" + ] + }, + { + "format": "OpenXmlPresentation", + "fileExtensions": [ + ".pptx" + ], + "contentTypes": [ + "application/vnd.openxmlformats-officedocument.presentationml.presentation" + ] + }, + { + "format": "OpenXmlSpreadsheet", + "fileExtensions": [ + ".xlsx" + ], + "contentTypes": [ + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" + ] + }, + { + "format": "HtmlFile", + "fileExtensions": [ + ".html", + ".htm" + ], + "contentTypes": [ + "text/html" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/glossary.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/glossary.json new file mode 100644 index 000000000000..0b638db5c8ac --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/glossary.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + { + "format": "XLIFF", + "fileExtensions": [ + ".xlf" + ], + "contentTypes": [ + "application/xliff+xml" + ], + "defaultVersion": "1.2", + "versions": [ + "1.0", + "1.1", + "1.2" + ] + }, + { + "format": "TMX", + "fileExtensions": [ + ".tmx" + ], + "contentTypes": [], + "versions": [ + "1.0", + "1.1", + "1.2", + "1.3", + "1.4" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operation.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operation.json new file mode 100644 index 000000000000..8b00ce81f329 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operation.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "id": "727BF148-F327-47A0-9481-ABAE6362F11E" + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Operation", + "innerError": { + "code": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Operation", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Operation", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Operation", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "ResourceNotFound", + "message": "id not found", + "target": "Operation", + "innerError": { + "code": "ResourceNotFound", + "message": "Resource requested is not found" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "id": "727bf148-f327-47a0-9481-abae6362f11e", + "createdDateTimeUtc": "2020-03-26T00:00:00Z", + "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "status": "Succeeded", + "summary": { + "total": 10, + "failed": 1, + "success": 9, + "inProgress": 0, + "notYetStarted": 0, + "cancelled": 0, + "totalCharacterCharged": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operations.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operations.json new file mode 100644 index 000000000000..0a03ff0e78f4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operations.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "$top": 1, + "$skip": 0, + "$maxpagesize": 10, + "$orderBy": "CreatedDateTime asc", + "createdDateTimeUtcStart": "2021-03-23T07:03:38.0136316Z", + "createdDateTimeUtcEnd": "2021-03-25T07:03:38.0136316Z", + "statuses": [ + "Succeeded" + ], + "ids": [ + "273622bd-835c-4946-9798-fd8f19f6bbf2" + ] + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Operation", + "innerError": { + "code": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Operation", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Operation", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Operation", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + { + "id": "273622bd-835c-4946-9798-fd8f19f6bbf2", + "createdDateTimeUtc": "2021-03-23T07:03:30.013631Z", + "lastActionDateTimeUtc": "2021-03-26T01:00:00Z", + "status": "Succeeded", + "summary": { + "total": 10, + "failed": 1, + "success": 9, + "inProgress": 0, + "notYetStarted": 0, + "cancelled": 0, + "totalCharacterCharged": 1000 + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Some argument is incorrect", + "target": "Operation", + "innerError": { + "code": "SASTokenInvalid", + "message": "SAS token for storage is invalid" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/storage.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/storage.json new file mode 100644 index 000000000000..1180d718fd99 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/storage.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "innerError": { + "code": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "innerError": { + "code": "InternalServerError", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "innerError": { + "code": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + "AzureBlob" + ] + } + } + } +} From 391380127adeda70cdd74612313fcd48f3a2d79c Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Mon, 29 Mar 2021 11:55:02 -0700 Subject: [PATCH 13/15] Update version of swagger file and examples --- .../TranslatorText/stable/v1.0/TranslatorBatch.json | 8 ++++---- .../TranslatorText/stable/v1.0/examples/batch.json | 2 +- .../TranslatorText/stable/v1.0/examples/documents.json | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json index 2f49d9301271..3552e8d6d13b 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Batch Document Translation Client", - "version": "v1.0-preview.1" + "version": "v1.0" }, "paths": { "/batches": { @@ -1354,7 +1354,7 @@ "@nextLink": { "description": "Url for the next page. Null if no more pages available", "type": "string", - "example": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operations?$top=5&$skip=15" + "example": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0/operations?$top=5&$skip=15" } } }, @@ -1440,7 +1440,7 @@ "@nextLink": { "description": "Url for the next page. Null if no more pages available", "type": "string", - "example": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/documents?$top=5&$skip=15" + "example": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0/operations/727BF148-F327-47A0-9481-ABAE6362F11E/documents?$top=5&$skip=15" } } }, @@ -1540,7 +1540,7 @@ } ], "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/translator/text/batch/v1.0-preview.1", + "hostTemplate": "{endpoint}/translator/text/batch/v1.0", "useSchemePrefix": false, "parameters": [ { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json index 7108552c493f..b003d6173b99 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json @@ -97,7 +97,7 @@ }, "202": { "headers": { - "Operation-Location": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55" + "Operation-Location": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55" } }, "400": { diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json index c46aac3ed75a..03175cf58a51 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json @@ -110,7 +110,7 @@ "characterCharged": 0 } ], - "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=1&$skip=1&$maxpagesize=1&$orderBy=CreatedDateTimeUtc%20asc&createdDateTimeUtcStart=2021-03-23T00:03:38.0136316Z&createdDateTimeUtcEnd=2021-03-25T00:03:38.0136316&statuses=Succeeded&ids=273622BD-835C-4946-9798-FD8F19F6BBF2,511B6A66-A6F8-4640-83E1-48C325E9FA29" + "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=1&$skip=1&$maxpagesize=1&$orderBy=CreatedDateTimeUtc%20asc&createdDateTimeUtcStart=2021-03-23T00:03:38.0136316Z&createdDateTimeUtcEnd=2021-03-25T00:03:38.0136316&statuses=Succeeded&ids=273622BD-835C-4946-9798-FD8F19F6BBF2,511B6A66-A6F8-4640-83E1-48C325E9FA29" } }, "400": { From 6b5d221db766801fdd7cc846178c70b3aacb8d1c Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Mon, 29 Mar 2021 12:43:12 -0700 Subject: [PATCH 14/15] update example with correct api version --- .../data-plane/TranslatorText/stable/v1.0/examples/batch.json | 2 +- .../data-plane/TranslatorText/stable/v1.0/examples/cancel.json | 2 +- .../TranslatorText/stable/v1.0/examples/document.json | 2 +- .../TranslatorText/stable/v1.0/examples/documents.json | 2 +- .../data-plane/TranslatorText/stable/v1.0/examples/format.json | 2 +- .../TranslatorText/stable/v1.0/examples/glossary.json | 2 +- .../TranslatorText/stable/v1.0/examples/operation.json | 2 +- .../TranslatorText/stable/v1.0/examples/operations.json | 2 +- .../data-plane/TranslatorText/stable/v1.0/examples/storage.json | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json index b003d6173b99..12c6a974c6f1 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/batch.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/cancel.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/cancel.json index 0861cf840b0c..e3bd0a028009 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/cancel.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/cancel.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/document.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/document.json index 76c2ce7ddd20..f466f9a5aee8 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/document.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/document.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json index 03175cf58a51..772a471893a4 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/documents.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/format.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/format.json index 75b787a30523..98b62ce43ae4 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/format.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/format.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/glossary.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/glossary.json index 0b638db5c8ac..631be37c43d7 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/glossary.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/glossary.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operation.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operation.json index 8b00ce81f329..ec846c209d3c 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operation.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operation.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operations.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operations.json index 0a03ff0e78f4..acd4ee3ed53f 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operations.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/operations.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", diff --git a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/storage.json b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/storage.json index 1180d718fd99..d0739bb4a322 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/storage.json +++ b/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/examples/storage.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "v1.0-preview.1", + "api-version": "v1.0", "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", "resourceGroupName": "TestResourceGroup", "endpoint": "{endpoint}", From 64048a1614c52bd9a2e1165619ee412673cf0a9a Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Mon, 29 Mar 2021 12:55:06 -0700 Subject: [PATCH 15/15] fix version in README --- .../cognitiveservices/data-plane/TranslatorText/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TranslatorText/readme.md b/specification/cognitiveservices/data-plane/TranslatorText/readme.md index ee92b47d0e7f..7d14eb5dd61d 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/readme.md +++ b/specification/cognitiveservices/data-plane/TranslatorText/readme.md @@ -37,7 +37,7 @@ input-file: preview/v1.0-preview.1/TranslatorBatch.json ### 1.0 Batch API This setting is for batch document translator and only applied when `--tag=release_1_0` is specified on the command line. -``` yaml $(tag) == 'release_1_0_preview.1' +``` yaml $(tag) == 'release_1_0' input-file: stable/v1.0/TranslatorBatch.json ``` @@ -121,7 +121,7 @@ These settings apply only when `--tag=release_1_0_preview.1 --nodejs` is specifi These settings apply only when `--tag=release_1_0 --nodejs` is specified on the command line. -``` yaml $(tag) == 'release_1_0_preview.1' && $(nodejs) +``` yaml $(tag) == 'release_1_0' && $(nodejs) package-version: 1.0 ```