-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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 version apis documentation #13928
Conversation
Swagger Validation Report
|
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStoreClient/isPrivateClient' removed or restructured? Old: Microsoft.Marketplace/stable/2019-12-01/Marketplace.json#L18:5 |
1005 - RemovedPath |
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/2019-12-01/Marketplace.json#L51:5 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ApiVersionParameter' removed or renamed? New: Microsoft.Marketplace/stable/2019-12-01/Marketplace.json#L18:3 Old: Microsoft.Marketplace/stable/2019-12-01/Marketplace.json#L80:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'subscriptionIdParameter' removed or renamed? New: Microsoft.Marketplace/stable/2019-12-01/Marketplace.json#L18:3 Old: Microsoft.Marketplace/stable/2019-12-01/Marketplace.json#L80:3 |
️⚠️
LintDiff: 23 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
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 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L2084 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L2209 |
|
Based on the response model schema, operation 'PrivateStoreCollection_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L278 |
|
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#L165 |
|
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#L201 |
|
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#L237 |
|
OperationId should contain the verb: '{collectionid}' in:'PrivateStoreCollection_Post'. Consider updating the operationId Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L408 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L118 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L386 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Marketplace/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L436 |
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#L675 |
|
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#L833 |
|
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/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. Location: 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. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L833 |
|
'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/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. Location: Microsoft.Marketplace/stable/2021-06-01/Marketplace.json#L903 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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.
- Compared Swaggers (Based on Oad v0.8.9)
- current:stable/2021-06-01/Marketplace.json compared with base:stable/2020-12-01/Marketplace.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 3 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-2020-12-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/2020-12-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-v1", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v1", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v2", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v2", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 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)" |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
PreCheck/DuplicateSchema |
"readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v1", "details":"Duplicate Schema named Resource -- properties.systemData: undefined => "$ref":"#/components/schemas/schemas:157", "readOnly":true, "description":"Metadata pertaining to creation and last modification of the resource" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v1", "details":"Error: Plugin prechecker reported failure." |
💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-composite-v1", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-2020-01-01", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"marketplace/resource-manager/readme.md", "tag":"package-2020-01-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) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
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. vsswagger@microsoft.com |
[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. |
Hi @MiriBerezin, Your PR has some issues. Please fix the CI sequentially by following the order of
|
/azp run |
Pull request contains merge conflicts. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
This RP only enables the generation for dot net SDK and ARM template. @allenjzhang for dot net |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Schemas generation looks good.
@ArcturusZhang I added new APIs in the last commit. |
Hey @MiriBerezin now that the breaking change CI is failing, it is mandatory that we have to get sign off from the breaking change review board, otherwise we cannot merge this PR. |
…the operation succeeded or failed
* New version apis documentation * Fix Tests * fix tests * remove tag to v2019-12-01 as it is not in use * Fix tests * Fix version and readme.md * Align the title to Marketplace RP Service and add default response to v2019-12-01 * remove the default response on version 2019-12-01 * Fix Errors * Fix errors * remove 2019 api version * Revert "remove 2019 api version" This reverts commit effa0cc. * Adding v2019 back * remove v2019 * align with master latest changes * Fix conflict * fix conflict * Fix tests * adding more apis * Add API: collectionsSubscriptionsMapping * Adding api: query offers * Change transferOffers response body to retrieve which on collections the operation succeeded or failed
* New version apis documentation * Fix Tests * fix tests * remove tag to v2019-12-01 as it is not in use * Fix tests * Fix version and readme.md * Align the title to Marketplace RP Service and add default response to v2019-12-01 * remove the default response on version 2019-12-01 * Fix Errors * Fix errors * remove 2019 api version * Revert "remove 2019 api version" This reverts commit effa0cc. * Adding v2019 back * remove v2019 * align with master latest changes * Fix conflict * fix conflict * Fix tests * adding more apis * Add API: collectionsSubscriptionsMapping * Adding api: query offers * Change transferOffers response body to retrieve which on collections the operation succeeded or failed
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.
during June 2021
During June 2021
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
[V] 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 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.