Cognitive Services 2022-03-01 #17712
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e/2021-10-01 to version 2022-03-01
yangyuan
added
the
DoNotMerge
|
Hi, @yangyuan 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] |
|
[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 Validation Report
|
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: dynamicThrottlingEnabled Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1744 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Since operation 'CheckSkuAvailability' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L757 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1604 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2557 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2621 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2695 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2907 |
|
| Based on the response model schema, operation 'Accounts_ListSkus' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L584 |
|
| Based on the response model schema, operation 'Accounts_ListUsages' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L626 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L890 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1083 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'Account', must have a list by immediate parent operation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2554 |
|
| The child tracked resource, 'deployments' with immediate parent 'Account', must have a list by immediate parent operation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2682 |
|
| The child tracked resource, 'commitmentPlans' with immediate parent 'Account', must have a list by immediate parent operation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2894 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isMigrated Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1675 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: restrictOutboundNetworkAccess Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1752 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1761 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: restore Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1771 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: statisticsEnabled Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1805 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: dynamicThrottlingEnabled Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1902 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: skuAvailable Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2165 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSubdomainAvailable Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2219 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: ignoreMissingVnetServiceEndpoint Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2420 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoRenew Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2933 |
|
| The resource 'PrivateLinkResource' does not have get operation, please add it. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2618 |
|
| 'restrictOutboundNetworkAccess' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1752 |
|
| 'allowedFqdnList' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1755 |
|
| 'disableLocalAuth' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1761 |
|
| 'endpoints' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1764 |
|
| 'restore' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1771 |
|
| 'rules' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1855 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 88 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2022-03-01/cognitiveservices.json compared with base:stable/2021-10-01/cognitiveservices.json
- current:stable/2022-03-01/cognitiveservices.json compared with base:preview/2016-02-01-preview/cognitiveservices.json
| Rule | Message |
|---|---|
| The new version has a different type 'object' than the previous one ''. New: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1574:9 Old: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L1528:9 |
|
| The new version has a different type 'object' than the previous one ''. New: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L2005:9 Old: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L1945:9 |
|
| The new version has a different type 'object' than the previous one ''. New: Microsoft.CognitiveServices/stable/2022-03-01/cognitiveservices.json#L1521:5 Old: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L1476:5 |
The following breaking changes are detected by comparison with latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @yangyuan, Your PR has some issues. Please fix the CI sequentially by following the order of
|
yangyuan
force-pushed
the
dev-cognitiveservices-Microsoft.CognitiveServices-2022-03-01
branch
from
81967b0 to
efdecf2
Compare
yangyuan
force-pushed
the
dev-cognitiveservices-Microsoft.CognitiveServices-2022-03-01
branch
from
efdecf2 to
f4a4e8e
Compare
This was referenced Feb 10, 2022
|
Hi, @yangyuan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
yangyuan
removed
the
WaitForARMFeedback
j5lim
approved these changes
Mar 1, 2022
j5lim
added
ARMSignedOff
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi @ArcturusZhang , could you help to review this PR? |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
xiaoxuqi-ms
approved these changes
Mar 10, 2022
This was referenced Mar 10, 2022
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
May 16, 2022
* Adds base for updating Microsoft.CognitiveServices from version stable/2021-10-01 to version 2022-03-01 * Updates readme * Updates API version in new specs and examples * Cognitive Services 2022-03-01 * Remove location/models. * Address issues * update sample * Remove breaking changes. * add x-ms-identifiers * add x-ms-identifiers
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
March 2nd
March 2nd
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the 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.