-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Fixes for FaceAPI #14556
Conversation
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.
Hi, @msyache Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
Rule | Message |
---|---|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 tags are being changed in this 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).
[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. |
Swagger Generation Artifacts
|
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. |
Background for the breaking changes: |
@@ -4813,6 +4861,24 @@ | |||
"minimum": 0, | |||
"maximum": 1 | |||
}, | |||
"NonNullableNameAndNullableUserDataContract": { |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed to NameAndUserDataContractForCreation
@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. |
Breaking change intake created at |
* 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]>
* 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]>
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.
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.
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.
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.