-
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
Tianxinliu/20230501 #23661
Tianxinliu/20230501 #23661
Conversation
…e/2022-12-01 to version 2023-05-01
Hi, @tianxin-ms 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
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
cognitiveservices.json | 2023-05-01(581b900) | 2022-12-01(main) |
cognitiveservices.json | 2023-05-01(581b900) | 2016-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 4 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) | new version | base version |
---|---|---|
package-2023-05 | package-2023-05(581b900) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Not using the common-types defined parameter 'location'. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L637 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Usages Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L676 |
||
Not using the common-types defined parameter 'location'. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L900 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L3997 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L68 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L81 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L114 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L114 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L114 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L137 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L152 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L181 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L281 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L313 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L612 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1005 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1018 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1062 |
RequestSchemaForTrackedResourcesMustHaveTags |
A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1062 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1099 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1106 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1121 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1153 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1198 |
ResourceNameRestriction |
The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1256 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1362 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1394 |
ResourceNameRestriction |
The resource name parameter 'commitmentPlanName' should be defined with a 'pattern' restriction. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1455 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1557 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1589 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1640 |
ProvisioningStateSpecifiedForLROPut |
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1989 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L1989 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.CognitiveServices/stable/2023-05-01/cognitiveservices.json#L2228 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.CognitiveServices' for api version '2023-05-01'. The supported api-versions are '2016-02-01-preview, 2017-04-18, 2021-04-30, 2021-10-01, 2022-03-01, 2022-10-01, 2022-12-01'." |
️❌
~[Staging] ServiceAPIReadinessTest: 28 Errors, 0 Warnings failed [Detail]
Tag package-2023-05; Prod region: Not deployed; Canary region: Deployed
Test run on region: eastus2euap; Operation coverage: total: 44, untested: 0, failed: 28, passed: 16
Service API Readiness Test failed. Check pipeline artifact for detail report.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidApiSetId, errorMessage: The account type 'Emotion' is either invalid or unavailable in given region. Source: runtime OperationId: Accounts_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Accounts_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Accounts_ListUsages |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Accounts_ListSkus |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Accounts_ListModels |
CLIENT_ERROR |
statusCode: 404, errorCode: PatchResourceNotFound, errorMessage: The resource '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-jhqUnm-23661/providers/Microsoft.CognitiveServices/accounts/accountnrruzxb' was not found when evaluating policies for a PATCH operation. Source: runtime OperationId: Accounts_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Accounts_RegenerateKey |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Accounts_ListKeys |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: CommitmentPlans_List |
CLIENT_ERROR |
statusCode: 400, errorCode: BadRequest, errorMessage: Updating Kind is not supported Source: runtime OperationId: CommitmentPlans_UpdatePlan |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnrruzxb' not found. Source: runtime OperationId: PrivateEndpointConnections_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnrruzxb' not found. Source: runtime OperationId: PrivateEndpointConnections_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnrruzxb' not found. Source: runtime OperationId: PrivateEndpointConnections_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: CommitmentPlans_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: CommitmentPlans_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Deployments_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Deployments_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Deployments_Get |
SERVER_ERROR |
statusCode: 500, errorCode: InternalServerError, errorMessage: Encountered internal server error. Please try again. Source: runtime OperationId: CommitmentPlans_CreateOrUpdateAssociation |
CLIENT_ERROR |
statusCode: 404, errorCode: NotFound, errorMessage: Specified resource '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-jhqUnm-23661/providers/Microsoft.CognitiveServices/commitmentPlans/commitme086er5/accountAssociations/commitmeuiiw1m' cannot be found. Source: runtime OperationId: CommitmentPlans_GetAssociation |
CLIENT_ERROR |
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'operations' could not be found in the namespace 'Microsoft.CognitiveServices' for api version '2023-05-01'. The supported api-versions are '2016-02-01-preview,2017-04-18,2021-04-30,2021-10-01,2022-03-01,2022-10-01,2022-12-01'. Source: runtime OperationId: Operations_List |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.CognitiveServices/locations/resourceGroups/deletedAccounts/delete' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/providers/Microsoft.CognitiveServices/locations/eastus2euap/resourceGroups/apiTest-jhqUnm-23661/deletedAccounts/accountnrruzxb' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: DeletedAccounts_Purge |
CLIENT_ERROR |
statusCode: 404, errorCode: NotFound, errorMessage: The deleted account '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-jhqUnm-23661/providers/Microsoft.CognitiveServices/accounts/accountnrruzxb' could not be found. Source: runtime OperationId: DeletedAccounts_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: locationInfo Source: response OperationId: ResourceSkus_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnrruzxb' not found. Source: runtime OperationId: PrivateLinkResources_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Deployments_Delete |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.CognitiveServices/accounts/accountnrruzxb' under resource group 'apiTest-jhqUnm-23661' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: CommitmentPlans_Delete |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnrruzxb' not found. Source: runtime OperationId: PrivateEndpointConnections_Delete |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
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).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @tianxin-ms, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
Hi @tianxin-ms, 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. |
f1c3d86
to
2370359
Compare
@raosuhas , "models" here means AI models, not an ARM resource. This API means to get the list of AI models. |
The models is read-only metadata for OpenAI models, it's very similar to "skus" API, so we don't include the "id", "type" as a regular ARM resource. |
@tianxin-ms Please fix API Readiness Check error. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
removed the JS breaking change label as there are no breaking changes. |
If you request SDK, comment in request when you think rollout be complete (so that user won't get SDK that not works). |
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.