[Hub Generated] Review request for Microsoft.Marketplace to add version stable/2021-12-01 #17051
Conversation
This file contains hidden or 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, @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] |
|
[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 |
|---|---|
| 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/2021-12-01/Marketplace.json#L1252 |
|
| 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/2021-12-01/Marketplace.json#L1293 |
|
| 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/2021-12-01/Marketplace.json#L1331 |
|
| 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/2021-12-01/Marketplace.json#L1376 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEntire Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L2746 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: publicContext Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L2773 |
|
| 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L584 |
|
| 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L962 |
|
| 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L1085 |
|
| 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L1171 |
|
| 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L1216 |
|
| 'stopSellSubscriptions' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L1337 |
|
| 'newPlansNotifications' 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/2021-12-01/Marketplace.json#L2209 |
|
| 'subscriptionsIds' 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/2021-12-01/Marketplace.json#L2222 |
|
| 'stopSellNotifications' 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/2021-12-01/Marketplace.json#L2721 |
|
| 'subscriptions' 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/2021-12-01/Marketplace.json#L2792 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The schema 'PlanRequesterDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L1979 |
|
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L2909 |
|
The schema 'error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L2953 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L2970 |
|
The parameters:privateStoreId,offerId,collectionId should be kept in the same order as they present in the path. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L663 |
|
The parameters:privateStoreId,offerId,collectionId should be kept in the same order as they present in the path. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L700 |
|
The parameters:privateStoreId,offerId,collectionId should be kept in the same order as they present in the path. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L744 |
|
The parameters:privateStoreId,offerId,collectionId should be kept in the same order as they present in the path. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L781 |
| Since operation 'PrivateStore_QueryOffers' 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/2021-12-01/Marketplace.json#L172 |
|
| Since operation 'PrivateStore_BillingAccounts' 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/2021-12-01/Marketplace.json#L210 |
|
| Since operation 'PrivateStoreCollection_TransferOffers' 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/2021-12-01/Marketplace.json#L485 |
|
| Since operation 'PrivateStore_BulkCollectionsAction' 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/2021-12-01/Marketplace.json#L578 |
|
| 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. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L833 |
|
| 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. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L1001 |
|
| '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/2021-12-01/Marketplace.json#L1001 |
|
| '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/2021-12-01/Marketplace.json#L1076 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L2178 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L2664 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L2938 |
|
| 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/2021-12-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/2021-12-01/Marketplace.json#L289 |
|
| Based on the response model schema, operation 'PrivateStore_GetApprovalRequestsList' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L829 |
|
| Based on the response model schema, operation 'PrivateStore_AdminRequestApprovalsList' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L997 |
|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#L1405 |
|
| 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/2021-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. Location: Microsoft.Marketplace/stable/2021-12-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/2021-12-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/2021-12-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/2021-12-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/2021-12-01/Marketplace.json#L210 |
️️✔️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: 5 Errors, 2 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2021-12-01/Marketplace.json compared with base:stable/2021-06-01/Marketplace.json
️️✔️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 @MiriBerezin, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Dec 12, 2021
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @MiriBerezin your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
mentat9
reviewed
Dec 14, 2021
| } | ||
| } | ||
| }, | ||
| "/providers/Microsoft.Marketplace/privateStores/fetchAllSubscriptionsInTenant": { |
Member
Contributor
Author
There was a problem hiding this comment.
I sent an email to armapireview DL but did not get answer yet so I will ask my question here:
The purpose of this API is to fetch ALL the subscriptions of the tenant ( unlike the get subscriptions API of subscriptions RP ).
On the one hand, Subscription is not our RP resource, so cannot (and don't need) expose put/delete
On the other hand, it is a pageable API and the call to the next page should always be GET.
(according to this documentation)
So what is the correct way to design this API?
Maybe something like:
GET providers/Microsoft.Marketplace/privetestores/{privateStoreId}/Subscriptions
Member
There was a problem hiding this comment.
Yes, I think that's probably the best way of doing what you want. That creates a RO resource type: Microsoft.Marketplace/privateStores/subscriptions (note 'subscriptions' is lower/camel case. It also requires that the objects returned in your list follow ARM resource format with name, id, and type at the top level and everything else in a "properties" object.
You can also model this as a POST, but that requires you implement your own paging interfaces: Trying to use x-ms-pageable on a POST method still requires you to implement GET as you observed.
Regarding your question to armapireview DL: please submit questions to stackoverflow (you can also send the link to armapireview for visibility). Guidance for posting on SO is here: https://armwiki.azurewebsites.net/troubleshooting/stackoverflow_guide.html#prerequisite.
Contributor
Author
There was a problem hiding this comment.
As this is not our resource I will use the POST option. Committed the change
And thanks for the reference to SO :)
mentat9
reviewed
Dec 14, 2021
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-12-01/Marketplace.json
Outdated
Show resolved
Hide resolved
mentat9
reviewed
Dec 14, 2021
| "type": "object", | ||
| "properties": { | ||
| "offerId": { | ||
| "description": "Gets offer id", |
Member
mentat9
reviewed
Dec 14, 2021
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-12-01/Marketplace.json
Show resolved
Hide resolved
mentat9
reviewed
Dec 14, 2021
| "type": "boolean", | ||
| "readOnly": true | ||
| }, | ||
| "messageCode": { |
Member
Contributor
Author
There was a problem hiding this comment.
Again we have this term - messageCode - in previous API version and we would like to stay with this term
mentat9
reviewed
Dec 14, 2021
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-12-01/Marketplace.json
Show resolved
Hide resolved
mentat9
reviewed
Dec 14, 2021
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-12-01/Marketplace.json
Outdated
Show resolved
Hide resolved
mentat9
reviewed
Dec 14, 2021
| "type": "string", | ||
| "description": "The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000." | ||
| }, | ||
| "subscriptionId": { |
Member
Contributor
Author
There was a problem hiding this comment.
I copied it as is from Subscriptions RP documentation. I prefer to leave it as is
mentat9
reviewed
Dec 14, 2021
...cation/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-12-01/Marketplace.json
Show resolved
Hide resolved
mentat9
reviewed
Dec 14, 2021
| "Disabled", | ||
| "Deleted" | ||
| ], | ||
| "x-ms-enum": { |
Member
Contributor
Author
There was a problem hiding this comment.
I think that the enum values are self-explained ( and I copied it as is from Subscriptions RP documentation)
mentat9
added
the
ARMSignedOff
|
Hi @MiriBerezin, 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. |
ruowan
approved these changes
Dec 20, 2021
ruowan
added
the
Approved-BreakingChange
|
Hi, @MiriBerezin. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
the
|
Hi, @MiriBerezin. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ruowan
reviewed
Feb 15, 2022
| } | ||
| }, | ||
| "@ts-common/iterator": { | ||
| "version": "0.3.6", |
Contributor
Author
There was a problem hiding this comment.
removed changes that were committed by mistake
ruowan
added
Approved-OkToMerge
ruowan
approved these changes
Feb 17, 2022
Member
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Feb 28, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Feb 28, 2022
…Marketplace to add version stable/2021-12-01 (#2215) Create to sync Azure/azure-rest-api-specs#17051 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...AzureSDKAutomation:sdkAuto/marketplace?expand=1)
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
Mar 7, 2022
…on stable/2021-12-01 (Azure#17051) * Adds base for updating Microsoft.Marketplace from version stable/2021-06-01 to version 2021-12-01 * Updates readme * Updates API version in new specs and examples * Adding new apis * Fix failed tests * revert parameters changes * missing object type * prettier * Fix review comments * fix semanticValidations test * fix to nextLink * changing fetchAllSubscriptions to post. Fix more comments * change to post and remove the pageable tag * revert changes in package-lock.json * Add x-ms-identifiers property
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Changelog
Add a changelog entry for this PR by answering the following questions:
- [x] new API version
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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.