-
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
New swagger version - Add new rules API to privatestore #20577
Conversation
Hi, @tomercigler 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.0)] | new version | base version |
---|---|---|
Marketplace.json | 2022-09-01(6436351) | 2022-03-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 11 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-09 | package-2022-09(6436351) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Since operation 'QueryUserRules' 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.Marketplace/stable/2022-09-01/Marketplace.json#L293 |
||
Since operation 'QueryRules' 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.Marketplace/stable/2022-09-01/Marketplace.json#L922 |
||
OperationId should contain the verb: 'setrules' in:'SetCollectionRules'. Consider updating the operationId Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L877 |
||
'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L299 |
||
'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L886 |
||
'RuleListResponse' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2100 |
||
'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2103 |
||
'SetRulesRequest' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2119 |
||
'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2122 |
||
'Rule' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2137 |
||
'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2152 |
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 'PrivateStoreQueryOffers' 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.Marketplace/stable/2022-09-01/Marketplace.json#L210 |
|
Since operation 'PrivateStoreQueryUserOffers' 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.Marketplace/stable/2022-09-01/Marketplace.json#L248 |
|
Since operation 'PrivateStoreBillingAccounts' 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.Marketplace/stable/2022-09-01/Marketplace.json#L338 |
|
Since operation 'PrivateStoreCollectionTransferOffers' 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.Marketplace/stable/2022-09-01/Marketplace.json#L613 |
|
Since operation 'PrivateStoreBulkCollectionsAction' 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.Marketplace/stable/2022-09-01/Marketplace.json#L706 |
|
Since operation 'PrivateStoreGetApprovalRequestsList' 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.Marketplace/stable/2022-09-01/Marketplace.json#L1180 |
|
Since operation 'PrivateStoreAdminRequestApprovalsList' 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.Marketplace/stable/2022-09-01/Marketplace.json#L1348 |
|
'GET' operation 'PrivateStore_AdminRequestApprovalsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1348 |
|
'PUT' operation 'PrivateStore_UpdateAdminRequestApproval' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1423 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L2675 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3223 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L3502 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'PrivateStore_CreateOrUpdate' Request Model: 'PrivateStore' Response Model: '' Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L95 |
|
Based on the response model schema, operation 'PrivateStoreCollection_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L417 |
|
Based on the response model schema, operation 'PrivateStore_GetApprovalRequestsList' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1176 |
|
Based on the response model schema, operation 'PrivateStore_AdminRequestApprovalsList' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1344 |
|
Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1752 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L32 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L68 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L99 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L134 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L172 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L210 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L248 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L338 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L376 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L661 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L706 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1180 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#L1218 |
️️✔️
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.Marketplace' for api version '2022-09-01'. The supported api-versions are '2018-03-01-beta, 2021-12-01, 2022-03-01'." |
️❌
~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
Tag package-2022-09; Prod region: Not deployed; Canary region: Not deployed
️❌
~[Staging] TrafficValidation: 0 Errors, 0 Warnings failed [Detail]
Tag package-2022-09; Prod region: Not deployed; Canary region: Not deployed
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/643635180e008f3c05780f567adf8daadf562d6f/specification/marketplace/resource-manager/readme.md#tag-package-2022-09">marketplace/resource-manager/readme.md#package-2022-09
Rule | Message |
---|---|
"readme":"marketplace/resource-manager/readme.md", "tag":"package-2022-09", "details":"The schema 'planDetails-requestDate' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json#/components/schemas/planDetails-requestDate" |
️️✔️
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.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
Hi @tomercigler, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @tomercigler your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
This looks like a mistake, since there is no response payload. x-ms-pageable doesn't work on POST actions anyway, AFAIK. In reply to: 1241287893 Refers to: specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json:905 in a129502. [](commit_id = a12950206627190cad541e23c95bff7266f6ca26, deletion_comment = False) |
Removing the GET method is a cross-version breaking change. You'll need to get this reviewed by the breaking change board. I'll add the BreakingChangReviewRequired label - instructions will be in PR comments. In reply to: 1241287930 In reply to: 1241287930 Refers to: specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json:921 in 6436351. [](commit_id = 6436351, deletion_comment = False) |
Hi @tomercigler, 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. |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Hi @mentat9 , thank you very much for your great review. BTW we added more 1 API change, can you check that please? |
Hi @lirenhe , |
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2022-09-01/Marketplace.json
Show resolved
Hide resolved
@tomercigler, could you fix the tool check errors in the PR? thanks |
Fixed, thanks |
About these 2 other comments.
I see that there is new test failing - braking changes - something with enum changed, i checked that with few tools and im 100% sure that i didn't change that. Can you please help me understand what is the root cause? |
It's not that it's wrong to add needed POST APIs, it's that it's not a good practice to have overlapping APIs. The feedback here is based on current ARM design and guidelines. There are 1000s of Azure APIs added over the past 8 years. These vary in degree of compliance with current guidelines: the past is not a guide to the future. I understand that making changes is hard: I'm not blocking ARM signoff on this. Two asks:
|
Hi @mentat9 |
@tomercigler , see the details of |
I sampled checked the failures but seems they're false alarm. @jianyexi , can you confirm? |
@tomercigler - Sorry, I think you are right: I intended to sign off but didn't for whatever reason. One more thing to say about POST APIs (vs. GET/PUT/PATCH payloads) is that ARM features like Azure Policy and template deployments don't work with POST. That's the fundamental reason we favor putting as much capability into the CRUD resource model as possible. Customers expect to be able to use these basic ARM features, so when you ship APIs that bypass this functionality, it creates friction and frustration for them. |
The cross version breaking changes seem to be the false alarm. No action needed |
* Clone 2022-03-01 to 2022-09-01 * Add new private store api version 2022-09-01 And new private store rules API * Fix from PR CR * Fix
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.