-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Marketplace miberezi 2020 #12495
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
Marketplace miberezi 2020 #12495
Conversation
…rezin/azure-rest-api-specs into Marketplace-miberezi-2020
|
Hi, @MiriBerezin 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 |
|---|---|
| Since operation 'PrivateStore_GetApprovalRequestsList' 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. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L113 |
|
| Since operation 'PrivateStore_AdminRequestApprovalsList' 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. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L316 |
|
| '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. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L316 |
|
| '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. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L386 |
|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L937 |
|
| Based on the response model schema, operation 'PrivateStore_GetApprovalRequestsList' might be pageable. Consider adding the x-ms-pageable extension. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L109 |
|
| Based on the response model schema, operation 'PrivateStore_AdminRequestApprovalsList' might be pageable. Consider adding the x-ms-pageable extension. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L312 |
|
| 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. New: Microsoft.Marketplace/stable/2020-12-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. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L71 |
|
| 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. New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L113 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 14 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2020-01-01/Marketplace.json <---> new: stable/2020-12-01/Marketplace.json
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L19:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L61:5 |
|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L106:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L247:5 |
|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L333:5 |
|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L375:5 |
|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/operations' removed or restructured? Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L478:5 |
|
| The new version is missing a definition that was found in the old version. Was 'PrivateStoreOperation' removed or renamed? New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3 Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3 |
|
| The new version is missing a definition that was found in the old version. Was 'PrivateStore' removed or renamed? New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3 Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3 |
|
| The new version is missing a definition that was found in the old version. Was 'PrivateStoreProperties' removed or renamed? New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3 Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
|
Hi @MiriBerezin, Your PR has some issues. Please fix the CI sequentially by following the order of
|
...source-manager/Microsoft.Marketplace/stable/2020-12-01/examples/AcknowledgeNotification.json
Outdated
Show resolved
Hide resolved
...source-manager/Microsoft.Marketplace/stable/2020-12-01/examples/GetApprovalRequestsList.json
Outdated
Show resolved
Hide resolved
...urce-manager/Microsoft.Marketplace/stable/2020-12-01/examples/AdminRequestApprovalsList.json
Outdated
Show resolved
Hide resolved
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json
Show resolved
Hide resolved
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json
Show resolved
Hide resolved
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json
Show resolved
Hide resolved
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json
Outdated
Show resolved
Hide resolved
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json
Show resolved
Hide resolved
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json
Show resolved
Hide resolved
|
Are your POST and PUT operations long running operations? If yes, you need to conform to this |
|
@jorgearteiro no, our APIs are NOT long-running operations |
Ok. There's an important checkbox that was not marked: [] I have reviewed the documentation for the workflow. We'll let it pass this time, but future PRs if the documentation was not read prior creating the PR, the PR would not be reviewed. |
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.
new API version for new APIs
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 API 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.