[Cognitive Services] Update endpoint URL template for Face. (#3490)

* [cognitive Services] Update endpoint URL template for Face. * Fix indent
Azure · Jul 26, 2018 · 041b654 · 041b654
1 parent 2ba52c8
commit 041b654
Show file tree

Hide file tree

Showing 34 changed files with 54 additions and 42 deletions.
diff --git a/specification/cognitiveservices/data-plane/Face/readme.nodejs.md b/specification/cognitiveservices/data-plane/Face/readme.nodejs.md
@@ -8,7 +8,6 @@ nodejs:
   package-name: azure-cognitiveservices-face
   package-version: 1.0.0-preview
   output-folder: $(node-sdks-folder)/lib/services/face
-  override-client-name: FaceAPIClient
   azure-arm: false
   generate-license-txt: true
   generate-package-json: true

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
@@ -17,11 +17,15 @@
       "apim_key": []
     }
   ],
-  "host": "api.cognitive.microsoft.com",
-  "basePath": "/face/v1.0",
-  "schemes": [
-    "https"
-  ],
+  "x-ms-parameterized-host": {
+    "hostTemplate": "{Endpoint}/face/v1.0",
+    "useSchemePrefix": false,
+    "parameters": [
+      {
+        "$ref": "#/parameters/Endpoint"
+      }
+    ]
+  },
   "paths": {
     "/findsimilars": {
       "post": {
@@ -2401,6 +2405,15 @@
       "format": "uuid",
       "x-ms-parameter-location": "method",
       "collectionFormat": "csv"
+    },
+    "Endpoint": {
+      "name": "Endpoint",
+      "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).",
+      "x-ms-parameter-location": "client",
+      "required": true,
+      "type": "string",
+      "in": "path",
+      "x-ms-skip-url-encoding": true
     }
   }
 }
diff --git a/...ion/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddFaceListFaceFromStream.json b/...ion/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddFaceListFaceFromStream.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/octet-stream",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "faceListId": "sample_face_list",

diff --git a/...cation/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddFaceListFaceFromUrl.json b/...cation/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddFaceListFaceFromUrl.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "faceListId": "sample_face_list",

diff --git a/...ation/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddPersonFaceFromStream.json b/...ation/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddPersonFaceFromStream.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/octet-stream",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/...fication/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddPersonFaceFromUrl.json b/...fication/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddPersonFaceFromUrl.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewFaceList.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewFaceList.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "faceListId": "sample_face_list",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewPerson.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewPerson.json
@@ -1,10 +1,10 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",
-    "body":{
+    "body": {
       "name": "mike",
       "userData": "{additional data associated with mike}"
     }

diff --git a/...fication/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewPersonGroup.json b/...fication/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewPersonGroup.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteFaceList.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteFaceList.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "faceListId": "sample_face_list"

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteFaceListFace.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteFaceListFace.json
@@ -1,10 +1,10 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "faceListId": "sample_face_list",
-    "persistedFaceId":"62004fa7-1ac0-478e-9d5a-b38f9e7fbc68"
+    "persistedFaceId": "62004fa7-1ac0-478e-9d5a-b38f9e7fbc68"
   },
   "responses": {
     "200": {

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeletePerson.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeletePerson.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeletePersonFace.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeletePersonFace.json
@@ -1,11 +1,11 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",
     "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
-    "persistedFaceId":"62004fa7-1ac0-478e-9d5a-b38f9e7fbc68"
+    "persistedFaceId": "62004fa7-1ac0-478e-9d5a-b38f9e7fbc68"
   },
   "responses": {
     "200": {

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeletePersonGroup.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeletePersonGroup.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc"

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithStream.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithStream.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/octet-stream",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "returnFaceAttributes": [

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DetectWithUrl.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "returnFaceAttributes": [

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/FindSimilar.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/FindSimilar.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "body": {
@@ -20,4 +20,4 @@
       ]
     }
   }
-}
+}
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetFaceList.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetFaceList.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "faceListId": "sample_face_list"

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetFaceLists.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetFaceLists.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Ocp-Apim-Subscription-Key": "{API key}"
   },
   "responses": {

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetPersistedFace.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetPersistedFace.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetPerson.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetPerson.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetPersonGroup.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetPersonGroup.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc"

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetPersonGroups.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetPersonGroups.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "start": "sample_group",
     "top": 2

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetTrainingStatus.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetTrainingStatus.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc"

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/Group.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/Group.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "body": {

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/Identify.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/Identify.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "body": {

diff --git a/...cation/cognitiveservices/data-plane/Face/stable/v1.0/examples/ListPersonGroupPersons.json b/...cation/cognitiveservices/data-plane/Face/stable/v1.0/examples/ListPersonGroupPersons.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/QueueTraining.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/QueueTraining.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc"

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdateFaceList.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdateFaceList.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "faceListId": "sample_face_list",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdatePerson.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdatePerson.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdatePersonFace.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdatePersonFace.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdatePersonGroup.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdatePersonGroup.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "personGroupId": "abc",

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/VerifyFaceToFace.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/VerifyFaceToFace.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "body": {

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/VerifyFaceToPerson.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/VerifyFaceToPerson.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "AzureRegion": "westus",
+    "Endpoint": "{Endpoint}",
     "Content-Type": "application/json",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "body": {