-
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
Adding 2020-09-Preview same as 11-preview #14997
Conversation
Hi, @rkapso 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 |
Swagger Validation Report
|
Rule | Message |
---|---|
'GET' operation 'Promotion_CheckEligibility' 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.Billing/preview/2020-09-01-preview/billingPromotions.json#L142 |
|
'PUT' operation 'Activate_Promotion' 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.Billing/preview/2020-09-01-preview/billingPromotions.json#L23 |
|
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: 'Activate_Promotion' Request Model: 'PromotionCreateRequest' Response Model: 'PromotionResponse' Location: Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json#L20 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: eligible Location: Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json#L326 |
|
'PromotionCreateRequest' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json#L178 |
|
'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json#L182 |
|
'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json#L186 |
|
'PromotionCreateSkuNameRequestProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json#L192 |
|
'PromotionCreateRequestProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json#L201 |
|
'PromotionList' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json#L218 |
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.Billing/stable/2020-05-01/billing.json#L3140 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Billing/stable/2020-05-01/billing.json#L3231 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Billing/stable/2020-05-01/billing.json#L3316 |
R4037 - MissingTypeObject |
The schema 'CustomerListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2020-05-01/billing.json#L3704 |
R4037 - MissingTypeObject |
The schema 'CustomerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2020-05-01/billing.json#L3744 |
R4037 - MissingTypeObject |
The schema 'TransferProductRequestProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2020-05-01/billing.json#L3810 |
R4037 - MissingTypeObject |
The schema 'BillingAccountListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2020-05-01/billing.json#L3895 |
R4037 - MissingTypeObject |
The schema 'BillingAccountProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2020-05-01/billing.json#L3929 |
R4037 - MissingTypeObject |
The schema 'BillingProfilesOnExpand' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2020-05-01/billing.json#L4021 |
R4037 - MissingTypeObject |
The schema 'BillingAccountUpdateRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Billing/stable/2020-05-01/billing.json#L4038 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/billing/resource-manager/readme.md tag: specification/billing/resource-manager/readme.md#tag-package-2020-05 |
️️✔️
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 succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"billing/resource-manager/readme.md",
"tag":"package-2020-09-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"billing/resource-manager/readme.md",
"tag":"package-2020-09-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"billing/resource-manager/readme.md",
"tag":"package-2020-09-preview",
"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).
[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 Generation Artifacts
|
Thank you for your contribution rkapso! We will review the pull request and get back to you soon. |
Promotions base api version is 2020-11-01-preview. Compared the changes with base API version -> just the api version is updated. Signing off from ARM side. |
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.
@jianyexi pls help check the lintdiff errors, we should fix the lintdiff error, correct? |
Yes |
done |
Hi @rkapso, Your PR has some issues. Please fix the CI sequentially by following the order of
|
* Adding 2020-09-Preview same as 11-preview * fixing lint issue * fixing model * fixing model * fixing model * pretify fix * fixing linting * more linting fix
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.
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.