From 6efdb6333a74ee82c40d1a34d7a966abb9a59b61 Mon Sep 17 00:00:00 2001 From: Yang Chen Date: Thu, 8 Dec 2022 16:44:49 -0800 Subject: [PATCH 1/3] Updates for Face PersonDirectory Add parameter descriptions, and add flatten flags for currently nested request body. --- .../Face/preview/v1.0-preview/Face.json | 36 ++++++++++++++----- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json index f5acd319c61f..076c103c6f8a 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json @@ -2543,11 +2543,13 @@ "in": "query", "name": "start", "format": "uuid", + "description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "type": "string" }, { "in": "query", "name": "top", + "description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.", "type": "string" } ], @@ -2591,6 +2593,7 @@ "in": "body", "name": "body", "required": true, + "x-ms-client-flatten": true, "schema": { "$ref": "#/definitions/EnrollmentRequest" } @@ -2640,6 +2643,7 @@ { "in": "path", "name": "personId", + "description": "Person id to update.", "required": true, "format": "uuid", "type": "string" @@ -2648,6 +2652,7 @@ "in": "body", "name": "body", "required": true, + "x-ms-client-flatten": true, "schema": { "$ref": "#/definitions/EnrollmentRequest" } @@ -2683,6 +2688,7 @@ { "in": "path", "name": "personId", + "description": "Person id to delete.", "required": true, "format": "uuid", "type": "string" @@ -5253,13 +5259,16 @@ "personId": { "format": "uuid", "type": "string", + "description": "Person id.", "x-nullable": false }, "name": { - "type": "string" + "type": "string", + "description": "User defined name, maximum length is 128." }, "userData": { - "type": "string" + "type": "string", + "description": "User specified data. Length should not exceed 16KB." } } }, @@ -5277,10 +5286,12 @@ "type": "object", "properties": { "name": { - "type": "string" + "type": "string", + "description": "User defined name, maximum length is 128." }, "userData": { - "type": "string" + "type": "string", + "description": "User specified data. Length should not exceed 16KB." } } }, @@ -5358,13 +5369,16 @@ "type": "object", "properties": { "name": { - "type": "string" + "type": "string", + "description": "User defined name, maximum length is 128." }, "userData": { - "type": "string" + "type": "string", + "description": "User specified data. Length should not exceed 16KB." }, "addPersonIds": { "type": "array", + "description": "Person ids to add to the dynamic person group.", "items": { "format": "uuid", "type": "string", @@ -5378,18 +5392,22 @@ "properties": { "removePersonIds": { "type": "array", + "description": "Person ids to remove from the dynamic person group.", "items": { "type": "string" } }, "name": { - "type": "string" + "type": "string", + "description": "User defined name, maximum length is 128." }, "userData": { - "type": "string" + "type": "string", + "description": "User specified data. Length should not exceed 16KB." }, "addPersonIds": { "type": "array", + "description": "Person ids to add to the dynamic person group.", "items": { "format": "uuid", "type": "string", @@ -5663,7 +5681,7 @@ "name": "returnFaceId", "in": "query", "x-ms-parameter-location": "method", - "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional permissions.", + "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.", "type": "boolean" }, "returnFaceLandmarks": { From 8ce6ccb0bb8e50ee9abad1d162a9105543be1cfb Mon Sep 17 00:00:00 2001 From: Yang Chen Date: Thu, 8 Dec 2022 17:04:50 -0800 Subject: [PATCH 2/3] Another description update --- .../cognitiveservices/data-plane/Face/stable/v1.0/Face.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json index e9323a2023b1..84e52040cbef 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json @@ -4490,7 +4490,7 @@ "name": "returnFaceId", "in": "query", "x-ms-parameter-location": "method", - "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional permissions.", + "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.", "type": "boolean" }, "returnFaceLandmarks": { From 207f6cfc608475e353a88286eb7649dd6f39f5a1 Mon Sep 17 00:00:00 2001 From: Yang Chen Date: Thu, 8 Dec 2022 18:03:07 -0800 Subject: [PATCH 3/3] More --- .../Face/preview/v1.0-preview/Face.json | 22 +++++++++++-------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json index 076c103c6f8a..4774ee8714e7 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json @@ -3029,8 +3029,9 @@ { "in": "body", "name": "body", - "description": "Target person face id to update.", + "description": "Target person face to update.", "required": true, + "x-ms-client-flatten": true, "schema": { "$ref": "#/definitions/PersistedFaceWithType" } @@ -3080,6 +3081,7 @@ "name": "body", "description": "", "required": true, + "x-ms-client-flatten": true, "schema": { "$ref": "#/definitions/DynamicPersonGroupCreateRequest" } @@ -3136,6 +3138,7 @@ "name": "body", "description": "", "required": true, + "x-ms-client-flatten": true, "schema": { "$ref": "#/definitions/DynamicPersonGroupUpdateRequest" } @@ -5344,7 +5347,8 @@ "ir_detection_01", "expression_01" ], - "type": "string" + "type": "string", + "description": "Detection model used when extracting the face." }, "PersistedFaceWithType": { "type": "object", @@ -5390,13 +5394,6 @@ "DynamicPersonGroupUpdateRequest": { "type": "object", "properties": { - "removePersonIds": { - "type": "array", - "description": "Person ids to remove from the dynamic person group.", - "items": { - "type": "string" - } - }, "name": { "type": "string", "description": "User defined name, maximum length is 128." @@ -5413,6 +5410,13 @@ "type": "string", "x-nullable": false } + }, + "removePersonIds": { + "type": "array", + "description": "Person ids to remove from the dynamic person group.", + "items": { + "type": "string" + } } } },