Adding xms-ids to CognitiveServices #17627
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
|
Hi, @agalerrotaru 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. vsswagger@microsoft.com |
|
[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 |
|---|---|
|
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L1476 |
| 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/2021-10-01/cognitiveservices.json#L712 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L1558 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L2497 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L2561 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L2635 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L2841 |
|
| Based on the response model schema, operation 'Accounts_ListSkus' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.CognitiveServices/stable/2021-10-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/2021-10-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/2021-10-01/cognitiveservices.json#L845 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L1038 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'Account', must have a list by immediate parent operation. Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L2494 |
|
| The child tracked resource, 'deployments' with immediate parent 'Account', must have a list by immediate parent operation. Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L2622 |
|
| The child tracked resource, 'commitmentPlans' with immediate parent 'Account', must have a list by immediate parent operation. Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L2828 |
|
| 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/2021-10-01/cognitiveservices.json#L1629 |
|
| 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/2021-10-01/cognitiveservices.json#L1702 |
|
| 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/2021-10-01/cognitiveservices.json#L1711 |
|
| 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/2021-10-01/cognitiveservices.json#L1721 |
|
| 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/2021-10-01/cognitiveservices.json#L1745 |
|
| 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/2021-10-01/cognitiveservices.json#L1842 |
|
| 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/2021-10-01/cognitiveservices.json#L2105 |
|
| 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/2021-10-01/cognitiveservices.json#L2159 |
|
| 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/2021-10-01/cognitiveservices.json#L2360 |
|
| 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/2021-10-01/cognitiveservices.json#L2867 |
|
| The resource 'PrivateLinkResource' does not have get operation, please add it. Location: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L2558 |
|
| '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/2021-10-01/cognitiveservices.json#L1702 |
|
| '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/2021-10-01/cognitiveservices.json#L1705 |
|
| '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/2021-10-01/cognitiveservices.json#L1711 |
|
| '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/2021-10-01/cognitiveservices.json#L1714 |
|
| '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/2021-10-01/cognitiveservices.json#L1721 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json#L130:22 ExampleUrl: stable/2021-10-01/examples/UpdateAccount.json |
️️✔️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.
️️✔️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 @agalerrotaru, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 2, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 17627 in repo Azure/azure-rest-api-specs |
xiaomin-ms
reviewed
Feb 11, 2022
| @@ -2692,6 +2724,10 @@ | |||
| "items": { | |||
| "$ref": "#/definitions/CommitmentTier" | |||
| }, | |||
| "x-ms-identifiers": [ | |||
| "kind", | |||
| "tier" | |||
There was a problem hiding this comment.
need to add skuName, hostingModel, planType
xiaomin-ms
reviewed
Feb 11, 2022
| @@ -2054,6 +2076,10 @@ | |||
| "items": { | |||
| "$ref": "#/definitions/SkuAvailability" | |||
| }, | |||
| "x-ms-identifiers": [ | |||
| "skuName", | |||
| "type" | |||
| } | ||
| }, | ||
| "x-ms-identifiers": [ | ||
| "path" |
xiaomin-ms
reviewed
Feb 11, 2022
| @@ -2254,6 +2281,10 @@ | |||
| "items": { | |||
| "$ref": "#/definitions/ResourceSku" | |||
| }, | |||
| "x-ms-identifiers": [ | |||
| "resourceType", | |||
| "name" | |||
yangyuan
approved these changes
Feb 15, 2022
|
@agalerrotaru please fix the validation error. |
xiaoxuqi-ms
approved these changes
Feb 23, 2022
This was referenced Feb 23, 2022
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
Mar 7, 2022
* Adding xms-ids to CognitiveServices * corrections after rebase * Update PR per feedback Co-authored-by: Yanming Tang <yantang@microsoft.com>
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:
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.