Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes for FaceAPI #14556

Merged
merged 3 commits into from
Jun 8, 2021
Merged

Conversation

msyache
Copy link
Contributor

@msyache msyache commented May 26, 2021

Added header definitions on PersonDirectory related 202 responses and fixed async operation
status names.
Fixed required name parameter being optional issue on FaceList/PersonGroup creation.

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.

  1. 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
  2. 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.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. 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:

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
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • 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.

Added header definitions on PersonDirectory related 202 responses and fixed async operation
status names.
Fixed required name parameter being optional issue on FaceList/PersonGroup creation.
@msyache msyache requested a review from yangyuan as a code owner May 26, 2021 19:07
@openapi-workflow-bot
Copy link

Hi, @msyache 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
    Copy link

    openapi-pipeline-app bot commented May 26, 2021

    Swagger Validation Report

    ️❌BreakingChange: 45 Errors, 10 Warnings failed [Detail]

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

    Rule Message
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L540:13
    Old: Face/preview/v1.0-preview/Face.json#L540:13
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L610:13
    Old: Face/preview/v1.0-preview/Face.json#L610:13
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L4676:7
    Old: Face/preview/v1.0-preview/Face.json#L4628:7
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L800:13
    Old: Face/preview/v1.0-preview/Face.json#L800:13
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L845:13
    Old: Face/preview/v1.0-preview/Face.json#L845:13
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L4649:7
    Old: Face/preview/v1.0-preview/Face.json#L4601:7
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L1492:13
    Old: Face/preview/v1.0-preview/Face.json#L1492:13
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L1562:13
    Old: Face/preview/v1.0-preview/Face.json#L1562:13
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L4791:7
    Old: Face/preview/v1.0-preview/Face.json#L4743:7
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Face/preview/v1.0-preview/Face.json#L1803:13
    Old: Face/preview/v1.0-preview/Face.json#L1803:13
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'PersonGroup_Train' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/stable/v1.0/Face.json#L757
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'LargePersonGroup_Train' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/stable/v1.0/Face.json#L1709
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'LargeFaceList_Train' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/stable/v1.0/Face.json#L2002
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Snapshot_Take' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/stable/v1.0/Face.json#L2238
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Snapshot_Apply' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/stable/v1.0/Face.json#L2434
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'PersonGroup_Train' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/preview/v1.0-preview/Face.json#L757
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'LargePersonGroup_Train' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/preview/v1.0-preview/Face.json#L1709
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'LargeFaceList_Train' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/preview/v1.0-preview/Face.json#L2002
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Snapshot_Take' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/preview/v1.0-preview/Face.json#L2238
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Snapshot_Apply' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Face/preview/v1.0-preview/Face.json#L2434
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Face/readme.md",
    "tag":"release_1_0",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Face/readme.md",
    "tag":"release_1_0",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Face/readme.md",
    "tag":"release_1_0",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Face/readme.md",
    "tag":"release_1_0_preview",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Face/readme.md",
    "tag":"release_1_0_preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 26, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - cognitiveservices/v1.0/face - v55.0.0
    +	Const `Glasses` has been removed
    +	Const `HeadWear` has been removed
    +	Const `Mask` has been removed
    +	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)`
    +	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)`
    +	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)`
    +	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)`
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1f26e64. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      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
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Parameter name of model LargeFaceList is now required
      info	[Changelog]   - Parameter name of model LargePersonGroup is now required
      info	[Changelog]   - Parameter name of model MetaDataContract is now required
      info	[Changelog]   - Parameter name of model FaceList is now required
      info	[Changelog]   - Parameter name of model PersonGroup is now required
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1f26e64. 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-06-08 16:05:17 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 1f26e64. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../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.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] - 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.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] - Const `Mask` has been removed
      info	[Changelog] - Const `Glasses` has been removed
      info	[Changelog] - Const `HeadWear` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `NoMask`
      info	[Changelog] - New const `Detection03`
      info	[Changelog] - New const `FaceMask`
      info	[Changelog] - New const `AccessoryTypeGlasses`
      info	[Changelog] - New const `AttributeTypeMask`
      info	[Changelog] - New const `Recognition04`
      info	[Changelog] - New const `OtherMaskOrOcclusion`
      info	[Changelog] - New const `AccessoryTypeHeadWear`
      info	[Changelog] - New const `AccessoryTypeMask`
      info	[Changelog] - New const `Uncertain`
      info	[Changelog] - New function `PossibleMaskTypeValues() []MaskType`
      info	[Changelog] - New struct `Mask`
      info	[Changelog] - New struct `NonNullableNameAndNullableUserDataContract`
      info	[Changelog] - New field `Mask` in struct `Attributes`
      info	[Changelog]
      info	[Changelog] Total 7 breaking change(s), 16 additive change(s).
      info	[Changelog]
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs]Release - Generate from 1f26e64. 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]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js/sdk/cognitiveservices/cognitiveservices-face]: npm pack --silent
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @msyache, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @msyache
    Copy link
    Contributor Author

    msyache commented May 26, 2021

    Background for the breaking changes:
    Azure/azure-sdk-for-net#4594
    https://dev.azure.com/msazure/Cognitive%20Services/_workitems/edit/6605582
    The "name" parameter for 4 FaceList/PersonGroup related APIs has been identified to be required in our service API specification but not so in the Swagger docs as well as SDK clients.
    The issue originates from the service code originally used to generate the Swagger document: while the same model was used in multiple sets of APIs (Create/Update/Get), only in Create API do we enforce a null check on the "name" parameter in question. If users treat it as optional and provides a null value, they will consistently receive an argument exception from the service. The changes in this commit attempt to provide mitigation for such user scenario and properly label the parameter with the expected format.

    @tjprescott

    @@ -4813,6 +4861,24 @@
    "minimum": 0,
    "maximum": 1
    },
    "NonNullableNameAndNullableUserDataContract": {
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    What is the rationale for this name? This seems like it will translate into a poor UX.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Mostly for internal disambiguation, as the struct is only consumed via the "allOf" in MetaDataContract.

    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    None of the properties in the model are nullable - it has an optional userDataContract field. I would strongly recommend trying to find a better name for this.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Renamed to NameAndUserDataContractForCreation

    @tjprescott
    Copy link
    Member

    @msyache since this represents a breaking change to released SDKs, you will need to go through the breaking change process outlined above by the openapi-workflow-bot.

    @msyache
    Copy link
    Contributor Author

    msyache commented Jun 2, 2021

    Breaking change intake created at
    https://msazure.visualstudio.com/One/_workitems/edit/10056711

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jun 7, 2021
    @tjprescott tjprescott merged commit 1f26e64 into Azure:master Jun 8, 2021
    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    * Fixes for FaceAPI
    
    Added header definitions on PersonDirectory related 202 responses and fixed async operation
    status names.
    Fixed required name parameter being optional issue on FaceList/PersonGroup creation.
    
    * Prettier fixes
    
    * Rename contract
    
    Co-authored-by: Yang Chen <[email protected]>
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Fixes for FaceAPI
    
    Added header definitions on PersonDirectory related 202 responses and fixed async operation
    status names.
    Fixed required name parameter being optional issue on FaceList/PersonGroup creation.
    
    * Prettier fixes
    
    * Rename contract
    
    Co-authored-by: Yang Chen <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go CI-BreakingChange-Python FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants