Enable Computer Vision Client to customize endpoint. (#3440)

* Enable Computer Vision Client to customize endpoint. * Update Corresponding examples.
Azure · Jul 20, 2018 · 6a7eb1d · 6a7eb1d
1 parent eddee65
commit 6a7eb1d
Show file tree

Hide file tree

Showing 18 changed files with 24 additions and 42 deletions.
diff --git 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
@@ -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/...eservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithStream.json b/...eservices/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/...tiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithUrl.json b/...tiveservices/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/...services/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithStream.json b/...services/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/...iveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithUrl.json b/...iveservices/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/...vices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithStream.json b/...vices/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/...services/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithUrl.json b/...services/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/...data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithStream.json b/...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/...es/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithUrl.json b/...es/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/...ices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetTextOperationResult.json b/...ices/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/...veservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulListDomainModels.json b/...veservices/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/...itiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithStream.json b/...itiveservices/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/...ognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithUrl.json b/...ognitiveservices/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/...ces/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithStream.json b/...ces/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/...rvices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithUrl.json b/...rvices/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/...itiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithStream.json b/...itiveservices/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/...ognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithUrl.json b/...ognitiveservices/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}"
   },