Skip to content

Commit 9b3aa35

Browse files
msyachemsyache
authored
Updates for Face PersonDirectory (#21831)
* Updates for Face PersonDirectory Add parameter descriptions, and add flatten flags for currently nested request body. * Another description update * More
1 parent 23b62d4 commit 9b3aa35

File tree

2 files changed

+40
-18
lines changed
  • specification/cognitiveservices/data-plane/Face

2 files changed

+40
-18
lines changed

‎specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2543,11 +2543,13 @@
25432543
"in": "query",
25442544
"name": "start",
25452545
"format": "uuid",
2546+
"description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.",
25462547
"type": "string"
25472548
},
25482549
{
25492550
"in": "query",
25502551
"name": "top",
2552+
"description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.",
25512553
"type": "string"
25522554
}
25532555
],
@@ -2591,6 +2593,7 @@
25912593
"in": "body",
25922594
"name": "body",
25932595
"required": true,
2596+
"x-ms-client-flatten": true,
25942597
"schema": {
25952598
"$ref": "#/definitions/EnrollmentRequest"
25962599
}
@@ -2640,6 +2643,7 @@
26402643
{
26412644
"in": "path",
26422645
"name": "personId",
2646+
"description": "Person id to update.",
26432647
"required": true,
26442648
"format": "uuid",
26452649
"type": "string"
@@ -2648,6 +2652,7 @@
26482652
"in": "body",
26492653
"name": "body",
26502654
"required": true,
2655+
"x-ms-client-flatten": true,
26512656
"schema": {
26522657
"$ref": "#/definitions/EnrollmentRequest"
26532658
}
@@ -2683,6 +2688,7 @@
26832688
{
26842689
"in": "path",
26852690
"name": "personId",
2691+
"description": "Person id to delete.",
26862692
"required": true,
26872693
"format": "uuid",
26882694
"type": "string"
@@ -3023,8 +3029,9 @@
30233029
{
30243030
"in": "body",
30253031
"name": "body",
3026-
"description": "Target person face id to update.",
3032+
"description": "Target person face to update.",
30273033
"required": true,
3034+
"x-ms-client-flatten": true,
30283035
"schema": {
30293036
"$ref": "#/definitions/PersistedFaceWithType"
30303037
}
@@ -3074,6 +3081,7 @@
30743081
"name": "body",
30753082
"description": "",
30763083
"required": true,
3084+
"x-ms-client-flatten": true,
30773085
"schema": {
30783086
"$ref": "#/definitions/DynamicPersonGroupCreateRequest"
30793087
}
@@ -3130,6 +3138,7 @@
31303138
"name": "body",
31313139
"description": "",
31323140
"required": true,
3141+
"x-ms-client-flatten": true,
31333142
"schema": {
31343143
"$ref": "#/definitions/DynamicPersonGroupUpdateRequest"
31353144
}
@@ -5253,13 +5262,16 @@
52535262
"personId": {
52545263
"format": "uuid",
52555264
"type": "string",
5265+
"description": "Person id.",
52565266
"x-nullable": false
52575267
},
52585268
"name": {
5259-
"type": "string"
5269+
"type": "string",
5270+
"description": "User defined name, maximum length is 128."
52605271
},
52615272
"userData": {
5262-
"type": "string"
5273+
"type": "string",
5274+
"description": "User specified data. Length should not exceed 16KB."
52635275
}
52645276
}
52655277
},
@@ -5277,10 +5289,12 @@
52775289
"type": "object",
52785290
"properties": {
52795291
"name": {
5280-
"type": "string"
5292+
"type": "string",
5293+
"description": "User defined name, maximum length is 128."
52815294
},
52825295
"userData": {
5283-
"type": "string"
5296+
"type": "string",
5297+
"description": "User specified data. Length should not exceed 16KB."
52845298
}
52855299
}
52865300
},
@@ -5333,7 +5347,8 @@
53335347
"ir_detection_01",
53345348
"expression_01"
53355349
],
5336-
"type": "string"
5350+
"type": "string",
5351+
"description": "Detection model used when extracting the face."
53375352
},
53385353
"PersistedFaceWithType": {
53395354
"type": "object",
@@ -5358,13 +5373,16 @@
53585373
"type": "object",
53595374
"properties": {
53605375
"name": {
5361-
"type": "string"
5376+
"type": "string",
5377+
"description": "User defined name, maximum length is 128."
53625378
},
53635379
"userData": {
5364-
"type": "string"
5380+
"type": "string",
5381+
"description": "User specified data. Length should not exceed 16KB."
53655382
},
53665383
"addPersonIds": {
53675384
"type": "array",
5385+
"description": "Person ids to add to the dynamic person group.",
53685386
"items": {
53695387
"format": "uuid",
53705388
"type": "string",
@@ -5376,25 +5394,29 @@
53765394
"DynamicPersonGroupUpdateRequest": {
53775395
"type": "object",
53785396
"properties": {
5379-
"removePersonIds": {
5380-
"type": "array",
5381-
"items": {
5382-
"type": "string"
5383-
}
5384-
},
53855397
"name": {
5386-
"type": "string"
5398+
"type": "string",
5399+
"description": "User defined name, maximum length is 128."
53875400
},
53885401
"userData": {
5389-
"type": "string"
5402+
"type": "string",
5403+
"description": "User specified data. Length should not exceed 16KB."
53905404
},
53915405
"addPersonIds": {
53925406
"type": "array",
5407+
"description": "Person ids to add to the dynamic person group.",
53935408
"items": {
53945409
"format": "uuid",
53955410
"type": "string",
53965411
"x-nullable": false
53975412
}
5413+
},
5414+
"removePersonIds": {
5415+
"type": "array",
5416+
"description": "Person ids to remove from the dynamic person group.",
5417+
"items": {
5418+
"type": "string"
5419+
}
53985420
}
53995421
}
54005422
},
@@ -5663,7 +5685,7 @@
56635685
"name": "returnFaceId",
56645686
"in": "query",
56655687
"x-ms-parameter-location": "method",
5666-
"description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional permissions.",
5688+
"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.",
56675689
"type": "boolean"
56685690
},
56695691
"returnFaceLandmarks": {

‎specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4490,7 +4490,7 @@
44904490
"name": "returnFaceId",
44914491
"in": "query",
44924492
"x-ms-parameter-location": "method",
4493-
"description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional permissions.",
4493+
"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.",
44944494
"type": "boolean"
44954495
},
44964496
"returnFaceLandmarks": {

0 commit comments

Comments
 (0)