New apis #14908
Closed
New apis #14908
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
This reverts commit dad4aba.
BulkCollectionsAction QueryApprovedPlans
|
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 |
|---|---|
|
The new version is adding a path that was not found in the old version. New: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L485:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L530:5 |
️⚠️LintDiff: 6 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
| Rule | Message |
|---|---|
| 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-06-01/Marketplace.json#L543 |
|
| 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-06-01/Marketplace.json#L498 |
|
| 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-06-01/Marketplace.json#L543 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allPlans Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L2226 |
|
| 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L501 |
|
| 'payload' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L546 |
The following errors/warnings exist before current PR submission:
Only 10 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-06-01/Marketplace.json#L1660 |
|
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L2341 |
|
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L2370 |
|
The schema 'error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L2414 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L2431 |
| 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-06-01/Marketplace.json#L165 |
|
| 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-06-01/Marketplace.json#L201 |
|
| 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-06-01/Marketplace.json#L453 |
|
| 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-06-01/Marketplace.json#L765 |
|
| 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-06-01/Marketplace.json#L923 |
️❌Avocado: 1 Errors, 21 Warnings failed [Detail]
Only 10 items are listed, please refer to log for more details.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️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.
️⚠️[Staging] SDK Track2 Validation: 2 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v2", "details":"The schema 'planDetails-requestDate' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#/components/schemas/planDetails-requestDate" |
|
| "readme":"marketplace/resource-manager/readme.md", "tag":"package-2021-06-01", "details":"The schema 'planDetails-requestDate' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#/components/schemas/planDetails-requestDate" |
|
| 💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v2", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v2", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"marketplace/resource-manager/readme.md",
"tag":"package-composite-v2",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"marketplace/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"marketplace/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️❌[Staging] Lint(RPaaS): 5 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
[RPaaS] An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/adp.json#L295 |
|
[RPaaS] An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/adp.json#L542 |
|
[RPaaS] An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.WindowsESU/preview/2019-09-16-preview/windowsesu.json#L198 |
|
[RPaaS] The resource PreviewSubscription is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it. Location: Microsoft.HybridNetwork/preview/2020-01-01-preview/vendor.json#L1039 |
|
[RPaaS] The resource RoleInstance is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it. Location: Microsoft.HybridNetwork/preview/2020-01-01-preview/vendorNetworkFunction.json#L664 |
Swagger Generation Artifacts
|
|
NewApiVersionRequired reason: |
This was referenced Jun 21, 2021
Draft
Draft
This was referenced Jun 21, 2021
Draft
Draft
Draft
Draft
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
Please ensure to add changelog with 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
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.
[V ] 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 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.