Refine Face existing spec #29064

Han-msft · 2024-05-10T06:56:40Z

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Refine existing face v1.1-preview.1 spec

Remove dedicate model for multipart/form-data
Remove locale in link
Add description for IdentifyFromPersonGroup
Add better name for Liveness Enum

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Getting help

First, please carefully read through this PR description, from top to bottom.
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2024-05-10T08:12:42Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2024-05-10T08:12:42Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail]

Compared specs (v0.10.8)	new version	base version
Face.json	v1.1-preview.1(bf75039)	v1.1-preview.1(main)

Rule	Message
`❌` 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Face/preview/v1.1-preview.1/Face.json#L7488:9 Old: Face/preview/v1.1-preview.1/Face.json#L7521:9

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
v1.1-preview.1	v1.1-preview.1(bf75039)	v1.1-preview.1(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
⚠️ VersionConvention	API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Face/preview/v1.1-preview.1/Face.json#L5
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L92
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Face/preview/v1.1-preview.1/Face.json#L167
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Face/preview/v1.1-preview.1/Face.json#L272
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Face/preview/v1.1-preview.1/Face.json#L280
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L354
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L407
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L448
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L449
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L487
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L488
⚠️ Delete204Response	A delete operation should have a `204` response. Location: Face/preview/v1.1-preview.1/Face.json#L496
⚠️ SuccessResponseBody	All success responses except 202 & 204 should define a response body. Location: Face/preview/v1.1-preview.1/Face.json#L497
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L524
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L525
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L586
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L642
⚠️ Formdata	Check for appropriate use of formData parameters. Location: Face/preview/v1.1-preview.1/Face.json#L643
⚠️ Formdata	Check for appropriate use of formData parameters. Location: Face/preview/v1.1-preview.1/Face.json#L646
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L681
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L682
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L720
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L721
⚠️ Delete204Response	A delete operation should have a `204` response. Location: Face/preview/v1.1-preview.1/Face.json#L729
⚠️ SuccessResponseBody	All success responses except 202 & 204 should define a response body. Location: Face/preview/v1.1-preview.1/Face.json#L730
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L757
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Face/preview/v1.1-preview.1/Face.json#L758
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L819
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L875
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Face/preview/v1.1-preview.1/Face.json#L917

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-05-10T08:12:43Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️⚠️ azure-sdk-for-python warning [Detail]

⚠️Warning in generating from 2e1a769. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[automation_init.sh]
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
cmderr	[automation_init.sh] npm notice Run `npm install -g npm@10.7.0` to update!
cmderr	[automation_init.sh] npm notice
warn		specification/ai/data-plane/Face/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-ai-vision-face [Preview SDK Changes]
- azure_ai_vision_face-1.0.0b1-py3-none-any.whl
- azure-ai-vision-face-1.0.0b1.zip
```
info	[Changelog] data-plan skip changelog generation temporarily
```

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed in generating from 2e1a769. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn		specification/ai/data-plane/Face/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1]
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g npm@10.7.0` to update!
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  141 |                GeneratePackage `
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  141 |                GeneratePackage `
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to packe sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  141 |                GeneratePackage `
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact

❌Azure.AI.Vision.Face [Preview SDK Changes]
```
info	[Changelog]
```

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded in generating from 2e1a769. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
warn		specification/ai/data-plane/Face/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure-rest/ai-vision-face [Preview SDK Changes]

azure-rest-ai-vision-face-1.0.0-beta.1.tgz

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded in generating from 2e1a769. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
warn		specification/ai/data-plane/Face/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-ai-vision-face [Preview SDK Changes]
- pom.xml
- azure-ai-vision-face-1.0.0-beta.1.jar
- azure-ai-vision-face-1.0.0-beta.1-sources.jar

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-05-10T08:12:43Z

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-ai-vision-face	https://apiview.dev/Assemblies/Review/572978f1cf2945df8bcf83aa83876685?revisionId=78396fdb80854857b17df85bf315ae4d
JavaScript	@azure-rest/ai-vision-face	https://apiview.dev/Assemblies/Review/6d965eeedcb649c4ac1540f49d24a308?revisionId=f365eeb25b504038b69ec48e33820193
Python	azure-ai-vision-face	https://apiview.dev/Assemblies/Review/902546534b9f40729eabfbd725b02bff?revisionId=6135dc5f347845deaa88f8765913210e
TypeSpec	Face	https://apiview.dev/Assemblies/Review/fd70378562b9470abec3d3f5e04aa38f?revisionId=8566ea33988041648086061cbf7a9519
Swagger	Face	https://apiview.dev/Assemblies/Review/2ab42e93e3c64f34aa8dfb69ea93cf15?revisionId=f3f046e33d1e4dea9f6bb3aa152b9353

Han-msft · 2024-05-12T13:12:22Z

There was a mistake when merging main to this PR branch, causing lots of reviewer added to this PR. Rebased and forced pushed to correct the merge, sorry for any inconvenience.

AzureRestAPISpecReview added data-plane TypeSpec Authored with TypeSpec labels May 10, 2024

Han-msft marked this pull request as ready for review May 10, 2024 14:10

Han-msft requested a review from a team as a code owner May 10, 2024 14:10

Han-msft requested review from JeffreyRichter and mikekistler and removed request for a team May 10, 2024 14:10

JeffreyRichter approved these changes May 10, 2024

View reviewed changes

Han-msft requested review from weshaggard, mikeharder, konrad-jamrozik, benbp, tadelesh, NonStatic2014, Kishp01, palma21, weinong, alvinli222, matthchr, circy9, annatisch and heaths as code owners May 12, 2024 12:47

Han-msft requested review from deyaaeldeen, kristapratico, mssfang, joseharriaga, minhanh-phan, yangyuan, wiboris, dpwatrous, skapur12, cRui861, wanghoppe, hmlam, nickghardwick, lmazuel, JoshLove-msft, swathipil and conniey as code owners May 12, 2024 12:47

Han-msft added 5 commits May 12, 2024 21:07

Remove multipart dedicated model

39025ff

Remove locale in links

d54c428

Add description for search over entire pd

9698bf9

Rename enum

d444567

Modify java config

bf75039

Han-msft force-pushed the hachiang/face-fix branch from cc08ca0 to bf75039 Compare May 12, 2024 13:07

weidongxu-microsoft approved these changes May 13, 2024

View reviewed changes

weidongxu-microsoft merged commit 969c685 into Azure:main May 13, 2024
30 of 32 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refine Face existing spec #29064

Refine Face existing spec #29064

Han-msft commented May 10, 2024 •

edited

openapi-pipeline-app bot commented May 10, 2024 •

edited

openapi-pipeline-app bot commented May 10, 2024 •

edited

openapi-pipeline-app bot commented May 10, 2024 •

edited

openapi-pipeline-app bot commented May 10, 2024 •

edited

Han-msft commented May 12, 2024

Refine Face existing spec #29064

Refine Face existing spec #29064

Conversation

Han-msft commented May 10, 2024 • edited

Data Plane API Specification Update Pull Request

PR review workflow diagram

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Getting help

openapi-pipeline-app bot commented May 10, 2024 • edited

Next Steps to Merge

openapi-pipeline-app bot commented May 10, 2024 • edited

Swagger Validation Report

openapi-pipeline-app bot commented May 10, 2024 • edited

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 10, 2024 • edited

Generated ApiView

Han-msft commented May 12, 2024

Han-msft commented May 10, 2024 •

edited

openapi-pipeline-app bot commented May 10, 2024 •

edited

openapi-pipeline-app bot commented May 10, 2024 •

edited

openapi-pipeline-app bot commented May 10, 2024 •

edited

openapi-pipeline-app bot commented May 10, 2024 •

edited