Update Face spec #29120

Han-msft · 2024-05-16T03:54:24Z

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.

Rename url to uri in csharp
Add PassiveActive mode

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.}

Design Document:
Previous API Spec Doc:
Updated paths:

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-16T03:54:28Z

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-16T03:54:28Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail]

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

Rule	Message
`❌` 1020 - AddedEnumValue	The new version is adding enum value(s) 'PassiveActive' from the old version. New: Face/preview/v1.1-preview.1/Face.json#L7437:9 Old: Face/preview/v1.1-preview.1/Face.json#L7437:9
`❌` 1020 - AddedEnumValue	The new version is adding enum value(s) 'PassiveActive' from the old version. New: Face/preview/v1.1-preview.1/Face.json#L8628:5 Old: Face/preview/v1.1-preview.1/Face.json#L8628:5

️️✔️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(e39a80a)	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-16T03:54:29Z

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

️❌ azure-sdk-for-python failed [Detail]

❌Code Generator Failed in generating from e49b15ad2db48c77332eca26814d88f1636d5a93. 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.
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
cmdout	[automation_generate.sh] [Autorest]../azure-sdk-for-python_tmp/generateOutput.json does not exist!!!Error happened during package
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed

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

❌Failed in generating from e49b15ad2db48c77332eca26814d88f1636d5a93. 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.8.0
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.8.0>
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g [email protected]` 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 e49b15ad2db48c77332eca26814d88f1636d5a93. 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]

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

️❌ azure-sdk-for-java failed [Detail]

❌Failed in generating from e49b15ad2db48c77332eca26814d88f1636d5a93. 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
cmderr	[generate.py] [COMPILE] Maven build fail.
cmderr	[generate.py] One reason of the compilation failure is that the existing code customization in SDK repository being incompatible with the class generated from updated TypeSpec source. In such case, you can ignore the failure, and fix the customization in SDK repository.
cmderr	[generate.py] You can inquire in "Language - Java" Teams channel. Please include the link of this Pull Request in the query.

❌azure-ai-vision-face [Preview SDK Changes]
- pom.xml

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

openapi-pipeline-app · 2024-05-16T03:54:29Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Face	https://apiview.dev/Assemblies/Review/2ab42e93e3c64f34aa8dfb69ea93cf15?revisionId=82edf25272204c439cc9930f33e5ecfd
TypeSpec	Face	https://apiview.dev/Assemblies/Review/fd70378562b9470abec3d3f5e04aa38f?revisionId=1fd8500f48e74e4f900685a31c9a2968

specification/ai/Face/routes.common.tsp

Han-msft · 2024-05-17T03:32:23Z

specification/ai/Face/models.session.tsp

  "Passive",
+
+  @doc("This mode utilizes a hybrid passive or active liveness technique that necessitates user cooperation. It is optimized to require active motion only under suboptimal lighting conditions. Unlike the passive mode, this mode has no lighting restrictions, and thus offering a broader operational envelope. This mode is preferable on Web based solutions due to the lack of automatic screen brightness control available on browsers which hinders the Passive mode’s operational envelope on Web based solutions.")
+  "PassiveActive",


PassiveActive is already in our service and has been there from the beginning. We wanted to hide though since the other component was not ready yet. It should be published for now.

* Rename url as uri for cs * Add PassiveActive for liveness * Update OAS

Han-msft added 2 commits May 16, 2024 11:24

Rename url as uri for cs

f652335

Add PassiveActive for liveness

3dfba0f

Update OAS

e39a80a

AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label May 16, 2024

AzureRestAPISpecReview added the data-plane label May 16, 2024

Han-msft marked this pull request as ready for review May 17, 2024 03:00

Han-msft requested a review from a team as a code owner May 17, 2024 03:00

Han-msft requested review from scgbear and MushMal and removed request for a team May 17, 2024 03:00

weidongxu-microsoft reviewed May 17, 2024

View reviewed changes

specification/ai/Face/routes.common.tsp Show resolved Hide resolved

weidongxu-microsoft approved these changes May 17, 2024

View reviewed changes

Han-msft commented May 17, 2024

View reviewed changes

weidongxu-microsoft merged commit 60161e2 into Azure:main May 17, 2024
27 of 32 checks passed

This was referenced May 17, 2024

Update Face SDK azure-sdk/azure-sdk-for-python#7173

Closed

Update Face SDK Azure/azure-sdk-for-python#35687

Merged

Francisco-Gamino pushed a commit to Francisco-Gamino/azure-rest-api-specs that referenced this pull request Jun 5, 2024

Update Face spec (Azure#29120)

deab077

* Rename url as uri for cs * Add PassiveActive for liveness * Update OAS

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Face spec #29120

Update Face spec #29120

Han-msft commented May 16, 2024

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

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading

Han-msft May 17, 2024

Update Face spec #29120

Update Face spec #29120

Conversation

Han-msft commented May 16, 2024

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 16, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented May 16, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 16, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 16, 2024 • edited Loading

Generated ApiView

Han-msft May 17, 2024

Choose a reason for hiding this comment

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

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading