Dev cognitiveservices face v1.0 #13030

JinyuID · 2021-02-18T06:23:59Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify : fix broken link and markdown formatting
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2021-02-18T06:24:01Z

Hi, @JinyuID Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2021-02-18T06:24:03Z

Swagger Validation Report

️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.6)
- original: stable/v1.0/Face.json <---> new: stable/v1.0/Face.json

Rule	Message
`❌` 1043 - AddingOptionalParameter	The optional parameter 'faceIdTimeToLive' was added in the new version. New: Face/stable/v1.0/Face.json#L1053:9
`❌` 1043 - AddingOptionalParameter	The optional parameter 'faceIdTimeToLive' was added in the new version. New: Face/stable/v1.0/Face.json#L2564:9

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- data-plane/Face/readme.md tag:release_1_0
Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- data-plane/Face/readme.md tag:release_1_0

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

Validation passes for Avocado.

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]

The following tags are being changed in this PR

cognitiveservices/data-plane/Face/readme.md#release_1_0

Rule	Message
⚠️ PreCheck/CheckDuplicateSchemas	"readme":"cognitiveservices/data-plane/Face/readme.md", "tag":"release_1_0", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail."

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

openapi-pipeline-app · 2021-02-18T06:24:04Z

Swagger Generation Artifacts

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

⚠️Warning [Logs]Release - Generate from ea20b4f. 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.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-cognitiveservices-vision-face [View full logs] [Release SDK Changes] Breaking Change Detected
- azure_cognitiveservices_vision_face-0.4.0-py2.py3-none-any.whl
- azure-cognitiveservices-vision-face-0.4.0.zip
```
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Operation FaceOperations.detect_with_stream has a new signature
info	[Changelog]   - Operation FaceOperations.detect_with_url has a new signature
```

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

️✔️Succeeded [Logs]Release - Generate from ea20b4f. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/cognitiveservices/data-plane/Face/readme.md

️✔️@azure/cognitiveservices-face [View full logs] [Release SDK Changes]

azure-cognitiveservices-face-4.1.0.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/faceClient.js → ./dist/cognitiveservices-face.js...
cmderr	[npmPack] created ./dist/cognitiveservices-face.js in 566ms

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

⚠️Warning [Logs]Release - Generate from ea20b4f. 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
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-02-22 20:10:20 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

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

️✔️Succeeded [Logs]Release - Generate from ea20b4f. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️cognitiveservices/v1.0/face [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `Client.DetectWithStreamPreparer` parameter(s) have been changed from `(context.Context, io.ReadCloser, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel)` to `(context.Context, io.ReadCloser, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel, *int32)`
info	[Changelog] - Function `Client.DetectWithURL` parameter(s) have been changed from `(context.Context, ImageURL, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel)` to `(context.Context, ImageURL, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel, *int32)`
info	[Changelog] - Function `Client.DetectWithURLPreparer` parameter(s) have been changed from `(context.Context, ImageURL, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel)` to `(context.Context, ImageURL, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel, *int32)`
info	[Changelog] - Function `Client.DetectWithStream` parameter(s) have been changed from `(context.Context, io.ReadCloser, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel)` to `(context.Context, io.ReadCloser, *bool, *bool, []AttributeType, RecognitionModel, *bool, DetectionModel, *int32)`
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `Detection03`
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 1 additive change(s).
info	[Changelog]

️🔄[Staging] ApiDocPreview inProgress [Detail]

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

openapi-workflow-bot · 2021-02-18T06:26:32Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

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

cSpell.json

* fix broken links, remove broken markdown format for det/reco models * fix syntax error for new parameter * fix attributes location * replace 24 hours to faceIdTimeToLive * Add missing "produce" section for all delete methods * fix two missing space by prettier * add produces section to all "patches" method * one more missing for largepersongroup/put * add produces section for put * add override keyword for face.json * update by feedback * sort and remove redundant in override list Co-authored-by: Jinyu Li (FACE) <[email protected]>

Jinyu Li (FACE) added 4 commits February 17, 2021 21:22

fix broken links, remove broken markdown format for det/reco models

2ee609a

fix syntax error for new parameter

caebc7b

fix attributes location

ccc12a6

replace 24 hours to faceIdTimeToLive

bc465df

JinyuID requested a review from longli0 February 18, 2021 06:25

JinyuID self-assigned this Feb 18, 2021

JinyuID requested a review from nabilat February 18, 2021 06:26

openapi-pipeline-app bot added the NewApiVersionRequired label Feb 18, 2021

JinyuID requested a review from PatrickFarley February 18, 2021 06:27

openapi-sdkautomation bot mentioned this pull request Feb 18, 2021

[AutoPR @azure/cognitiveservices-face] Dev cognitiveservices face v1.0 AzureSDKAutomation/azure-sdk-for-js#3679

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Feb 18, 2021

openapi-sdkautomation bot mentioned this pull request Feb 18, 2021

[AutoPR azure-cognitiveservices-vision-face] Dev cognitiveservices face v1.0 AzureSDKAutomation/azure-sdk-for-python#4178

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python label Feb 18, 2021

Jinyu Li (FACE) added 4 commits February 17, 2021 23:09

Add missing "produce" section for all delete methods

5291693

fix two missing space by prettier

1cf0a53

add produces section to all "patches" method

845224b

one more missing for largepersongroup/put

d566ccd

longli0 reviewed Feb 18, 2021

View reviewed changes

specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json Outdated Show resolved Hide resolved

Jinyu Li (FACE) added 3 commits February 17, 2021 23:47

add produces section for put

8a2076f

add override keyword for face.json

8ca67e1

update by feedback

d01714b

longli0 reviewed Feb 18, 2021

View reviewed changes

cSpell.json Outdated Show resolved Hide resolved

sort and remove redundant in override list

3174e25

longli0 approved these changes Feb 18, 2021

View reviewed changes

JinyuID marked this pull request as ready for review February 18, 2021 08:55

JinyuID requested a review from yangyuan as a code owner February 18, 2021 08:55

JinyuID requested review from jhendrixMSFT and mayurid February 18, 2021 23:26

jhendrixMSFT approved these changes Feb 19, 2021

View reviewed changes

mayurid merged commit ea20b4f into Azure:master Feb 22, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dev cognitiveservices face v1.0 #13030

Dev cognitiveservices face v1.0 #13030

JinyuID commented Feb 18, 2021 •

edited

Loading

openapi-workflow-bot bot commented Feb 18, 2021

openapi-pipeline-app bot commented Feb 18, 2021 •

edited

Loading

openapi-pipeline-app bot commented Feb 18, 2021 •

edited

Loading

openapi-workflow-bot bot commented Feb 18, 2021

Dev cognitiveservices face v1.0 #13030

Dev cognitiveservices face v1.0 #13030

Conversation

JinyuID commented Feb 18, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Feb 18, 2021

openapi-pipeline-app bot commented Feb 18, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Feb 18, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Feb 18, 2021

JinyuID commented Feb 18, 2021 •

edited

Loading

openapi-pipeline-app bot commented Feb 18, 2021 •

edited

Loading

openapi-pipeline-app bot commented Feb 18, 2021 •

edited

Loading