From 6a7eb1de51b041aba66b6add6bd2bb6b9da152a4 Mon Sep 17 00:00:00 2001 From: Yang Yuan Date: Fri, 20 Jul 2018 16:41:54 -0700 Subject: [PATCH] Enable Computer Vision Client to customize endpoint. (#3440) * Enable Computer Vision Client to customize endpoint. * Update Corresponding examples. --- .../ComputerVision/readme.nodejs.md | 1 - .../stable/v2.0/ComputerVision.json | 33 +++++-------------- .../examples/SuccessfulAnalyzeWithStream.json | 2 +- .../examples/SuccessfulAnalyzeWithUrl.json | 2 +- .../SuccessfulDescribeWithStream.json | 2 +- .../examples/SuccessfulDescribeWithUrl.json | 2 +- .../SuccessfulDomainModelWithStream.json | 2 +- .../SuccessfulDomainModelWithUrl.json | 2 +- ...SuccessfulGenerateThumbnailWithStream.json | 2 +- .../SuccessfulGenerateThumbnailWithUrl.json | 2 +- .../SuccessfulGetTextOperationResult.json | 2 +- .../examples/SuccessfulListDomainModels.json | 2 +- .../examples/SuccessfulOcrWithStream.json | 2 +- .../v2.0/examples/SuccessfulOcrWithUrl.json | 2 +- .../SuccessfulRecognizeTextWithStream.json | 2 +- .../SuccessfulRecognizeTextWithUrl.json | 2 +- .../examples/SuccessfulTagWithStream.json | 2 +- .../v2.0/examples/SuccessfulTagWithUrl.json | 2 +- 18 files changed, 24 insertions(+), 42 deletions(-) diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.nodejs.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.nodejs.md index d7b461ede301..678e38461366 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/readme.nodejs.md +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.nodejs.md @@ -8,7 +8,6 @@ nodejs: package-name: azure-cognitiveservices-computervision package-version: 2.0.0-preview output-folder: $(node-sdks-folder)/lib/services/computerVision - override-client-name: ComputerVisionAPIClient azure-arm: false generate-license-txt: true generate-package-json: true diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json index bd7ce875b867..30c5f79aefbf 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "version": "2.0", - "title": "Computer Vision API", + "title": "Computer Vision Client", "description": "The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively." }, "securityDefinitions": { @@ -18,10 +18,11 @@ } ], "x-ms-parameterized-host": { - "hostTemplate": "{AzureRegion}.api.cognitive.microsoft.com", + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, "parameters": [ { - "$ref": "#/parameters/AzureRegion" + "$ref": "#/parameters/Endpoint" } ] }, @@ -1554,32 +1555,14 @@ "format": "file" } }, - "AzureRegion": { - "name": "AzureRegion", - "description": "Supported Azure regions for Cognitive Services endpoints", + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints", "x-ms-parameter-location": "client", "required": true, "type": "string", "in": "path", - "x-ms-skip-url-encoding": true, - "x-ms-enum": { - "name": "AzureRegions", - "modelAsString": false - }, - "enum": [ - "westus", - "westeurope", - "southeastasia", - "eastus2", - "westcentralus", - "westus2", - "eastus", - "southcentralus", - "northeurope", - "eastasia", - "australiaeast", - "brazilsouth" - ] + "x-ms-skip-url-encoding": true } } } diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithStream.json index e1ea36075e27..455b95e678bf 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithStream.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType"], "details": "Celebrities", diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithUrl.json index 71f9e8f4b8dd..e14225891813 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithUrl.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "visualFeatures": "Categories,Adult,Tags,Description,Faces,Color,ImageType", "details": "Celebrities,Landmarks", diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithStream.json index fce78185bcb8..0443a9ac3ba0 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithStream.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "maxCandidates": "1", "Image": "{binary}" diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithUrl.json index 07daa93f048f..1146716c47e6 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithUrl.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "maxCandidates": "1", "ImageUrl": "{url}" diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithStream.json index 153e36a977a0..dd2a206e963e 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithStream.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "model": "Celebrities", "Image": "{binary}" diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithUrl.json index d79f1db11a44..8bc698a513b8 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithUrl.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "model": "Celebrities", "ImageUrl": "{url}" diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithStream.json index b8622ed4a62a..c5a7e8be7f78 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithStream.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "width": "500", "height": "500", diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithUrl.json index 01bea96b8795..8cd5d769b238 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithUrl.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "width": "500", "height": "500", diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetTextOperationResult.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetTextOperationResult.json index bc061ddf0fb5..b2051caa755a 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetTextOperationResult.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetTextOperationResult.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "operationId": "49a36324-fc4b-4387-aa06-090cfbf0064f" }, diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulListDomainModels.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulListDomainModels.json index 9c43b772ed4d..5f95d6e1df7d 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulListDomainModels.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulListDomainModels.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithStream.json index fa75fb8e5801..c1454c82779b 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithStream.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "detectOrientation": "true", "language": "en", diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithUrl.json index f977123bfab8..9c4836415ccc 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithUrl.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "detectOrientation": "true", "language": "en", diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithStream.json index 27c8173c458b..c3c0a5f6a7ba 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithStream.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "mode": "Handwritten", "Image": "{binary}" diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithUrl.json index 98777b81141d..905c329d6670 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithUrl.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "mode": "Handwritten", "ImageUrl": "{url}" diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithStream.json index f17d6e2ceb8a..710cfc71a26d 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithStream.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "Image": "{binary}" }, diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithUrl.json index 7d018bc6697e..3d99dbf1337f 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithUrl.json @@ -1,6 +1,6 @@ { "parameters": { - "AzureRegion": "Westus", + "Endpoint": "https://westus.api.cognitive.microsoft.com/vision/v2.0", "Ocp-Apim-Subscription-Key": "{API key}", "ImageUrl": "{url}" },