Skip to content

Commit f028a1d

Browse files
msyachekayousef
authored andcommitted
Face PersonDirectory argument type mismatch fix (Azure#21572)
* Fix Face PersonDirectory argument type mismatch Update the Person related operations in PersonDirectory to consume personId as GUID as opposed to string. The change adheres to the existing pattern for Person Group and Large Person Group, clarifies intended usage, and should reduce confusion from the current discrepancy between returned GUIDs in responses while the corresponding operation arguments are string. * Fix person request type * Fix AddPersonFace missing url in json
1 parent 9fc3494 commit f028a1d

File tree

1 file changed

+42
-12
lines changed
  • specification/cognitiveservices/data-plane/Face/preview/v1.0-preview

1 file changed

+42
-12
lines changed

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

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2542,6 +2542,7 @@
25422542
{
25432543
"in": "query",
25442544
"name": "start",
2545+
"format": "uuid",
25452546
"type": "string"
25462547
},
25472548
{
@@ -2591,7 +2592,7 @@
25912592
"name": "body",
25922593
"required": true,
25932594
"schema": {
2594-
"$ref": "#/definitions/EnrolledPerson"
2595+
"$ref": "#/definitions/EnrollmentRequest"
25952596
}
25962597
}
25972598
],
@@ -2640,6 +2641,7 @@
26402641
"in": "path",
26412642
"name": "personId",
26422643
"required": true,
2644+
"format": "uuid",
26432645
"type": "string"
26442646
},
26452647
{
@@ -2682,6 +2684,7 @@
26822684
"in": "path",
26832685
"name": "personId",
26842686
"required": true,
2687+
"format": "uuid",
26852688
"type": "string"
26862689
}
26872690
],
@@ -2723,6 +2726,7 @@
27232726
"name": "personId",
27242727
"description": "Person id.",
27252728
"required": true,
2729+
"format": "uuid",
27262730
"type": "string"
27272731
}
27282732
],
@@ -2753,7 +2757,7 @@
27532757
"PersonDirectory"
27542758
],
27552759
"summary": "Add a new face to person.",
2756-
"operationId": "PersonDirectory_AddPersonFace",
2760+
"operationId": "PersonDirectory_AddPersonFaceFromUrl",
27572761
"produces": [
27582762
"application/json"
27592763
],
@@ -2763,6 +2767,7 @@
27632767
"name": "personId",
27642768
"description": "Person id.",
27652769
"required": true,
2770+
"format": "uuid",
27662771
"type": "string"
27672772
},
27682773
{
@@ -2789,6 +2794,9 @@
27892794
"name": "targetFace",
27902795
"description": "Target face.",
27912796
"type": "string"
2797+
},
2798+
{
2799+
"$ref": "../../../Common/Parameters.json#/parameters/ImageUrl"
27922800
}
27932801
],
27942802
"responses": {
@@ -2832,6 +2840,7 @@
28322840
"name": "personId",
28332841
"description": "Target person to get persistedFaceIds from.",
28342842
"required": true,
2843+
"format": "uuid",
28352844
"type": "string"
28362845
},
28372846
{
@@ -2879,6 +2888,7 @@
28792888
"name": "personId",
28802889
"description": "Person id.",
28812890
"required": true,
2891+
"format": "uuid",
28822892
"type": "string"
28832893
},
28842894
{
@@ -2893,6 +2903,7 @@
28932903
"name": "persistedFaceId",
28942904
"description": "Persisted face id to delete.",
28952905
"required": true,
2906+
"format": "uuid",
28962907
"type": "string"
28972908
}
28982909
],
@@ -2934,6 +2945,7 @@
29342945
"name": "personId",
29352946
"description": "Target person to get face from.",
29362947
"required": true,
2948+
"format": "uuid",
29372949
"type": "string"
29382950
},
29392951
{
@@ -2948,6 +2960,7 @@
29482960
"name": "persistedFaceId",
29492961
"description": "Target person face id to get.",
29502962
"required": true,
2963+
"format": "uuid",
29512964
"type": "string"
29522965
}
29532966
],
@@ -2989,6 +3002,7 @@
29893002
"name": "personId",
29903003
"description": "Target person to update face from.",
29913004
"required": true,
3005+
"format": "uuid",
29923006
"type": "string"
29933007
},
29943008
{
@@ -3003,6 +3017,7 @@
30033017
"name": "persistedFaceId",
30043018
"description": "PersistedFaceId created from Person Face Create",
30053019
"required": true,
3020+
"format": "uuid",
30063021
"type": "string"
30073022
},
30083023
{
@@ -3245,6 +3260,7 @@
32453260
"in": "query",
32463261
"name": "start",
32473262
"description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.",
3263+
"format": "uuid",
32483264
"type": "string"
32493265
},
32503266
{
@@ -3339,6 +3355,7 @@
33393355
"name": "personId",
33403356
"description": "Valid PersonId created from Person Create.",
33413357
"required": true,
3358+
"format": "uuid",
33423359
"type": "string"
33433360
},
33443361
{
@@ -3694,6 +3711,7 @@
36943711
"name": "personId",
36953712
"description": "Person id.",
36963713
"required": true,
3714+
"format": "uuid",
36973715
"type": "string"
36983716
},
36993717
{
@@ -5218,7 +5236,8 @@
52185236
"properties": {
52195237
"personId": {
52205238
"format": "uuid",
5221-
"type": "string"
5239+
"type": "string",
5240+
"x-nullable": false
52225241
},
52235242
"name": {
52245243
"type": "string"
@@ -5233,7 +5252,8 @@
52335252
"properties": {
52345253
"personId": {
52355254
"format": "uuid",
5236-
"type": "string"
5255+
"type": "string",
5256+
"x-nullable": false
52375257
},
52385258
"name": {
52395259
"type": "string"
@@ -5248,7 +5268,8 @@
52485268
"properties": {
52495269
"personId": {
52505270
"format": "uuid",
5251-
"type": "string"
5271+
"type": "string",
5272+
"x-nullable": false
52525273
}
52535274
}
52545275
},
@@ -5268,7 +5289,8 @@
52685289
"properties": {
52695290
"persistedFaceId": {
52705291
"format": "uuid",
5271-
"type": "string"
5292+
"type": "string",
5293+
"x-nullable": false
52725294
},
52735295
"recognitionModel": {
52745296
"type": "string"
@@ -5283,13 +5305,15 @@
52835305
"properties": {
52845306
"personId": {
52855307
"format": "uuid",
5286-
"type": "string"
5308+
"type": "string",
5309+
"x-nullable": false
52875310
},
52885311
"persistedFaceIds": {
52895312
"type": "array",
52905313
"items": {
52915314
"format": "uuid",
5292-
"type": "string"
5315+
"type": "string",
5316+
"x-nullable": false
52935317
}
52945318
},
52955319
"name": {
@@ -5342,7 +5366,9 @@
53425366
"addPersonIds": {
53435367
"type": "array",
53445368
"items": {
5345-
"type": "string"
5369+
"format": "uuid",
5370+
"type": "string",
5371+
"x-nullable": false
53465372
}
53475373
}
53485374
}
@@ -5365,7 +5391,9 @@
53655391
"addPersonIds": {
53665392
"type": "array",
53675393
"items": {
5368-
"type": "string"
5394+
"format": "uuid",
5395+
"type": "string",
5396+
"x-nullable": false
53695397
}
53705398
}
53715399
}
@@ -5391,7 +5419,8 @@
53915419
"type": "array",
53925420
"items": {
53935421
"format": "uuid",
5394-
"type": "string"
5422+
"type": "string",
5423+
"x-nullable": false
53955424
}
53965425
}
53975426
}
@@ -5401,7 +5430,8 @@
54015430
"properties": {
54025431
"personId": {
54035432
"format": "uuid",
5404-
"type": "string"
5433+
"type": "string",
5434+
"x-nullable": false
54055435
},
54065436
"dynamicPersonGroupIds": {
54075437
"type": "array",

0 commit comments

Comments
 (0)