-
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
Microsoft.Subscriptions 2021-01-01-privatepreview #14390
Conversation
…ure-rest-api-specs into shahraj/2021-subscriptions-api
…tor and Rearrange Swagger Sections
Hi, @rajshah11 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. |
Hi, @rajshah11 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ |
Swagger Validation Report
|
Rule | Message |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'Subscriptions_CreateAlias' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L20 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Subscriptions_GetAlias' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L66 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'SubscriptionPolicy_AddUpdatePolicyForTenant' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L633 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'SubscriptionPolicy_GetPolicyForTenant' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L669 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BillingAccount_GetPolicy' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L732 |
Per the Noun_Verb convention for Operation Ids, the noun 'Subscriptions' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L245 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Subscriptions' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L305 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Subscriptions' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L380 |
|
'GET' operation 'Subscription_AcceptOwnershipStatus' 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.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L212 |
|
'PUT' operation 'SubscriptionPolicy_AddUpdatePolicyForTenant' 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.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L635 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
ModelValidation: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND |
In operation "Subscription_AcceptOwnershipStatus", parameter subscriptionId is required in the swagger spec but is not present in the provided example parameter values. Url: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L233 |
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 22 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2021-01-01-privatepreview/subscriptions.json compared with base:preview/2019-10-01-preview/subscriptions.json
- current:preview/2021-01-01-privatepreview/subscriptions.json compared with base:stable/2020-09-01/subscriptions.json
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️🔄
CredScan inProgress [Detail]
️️✔️
[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":"subscription/resource-manager/readme.md",
"tag":"package-2020-09",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2020-09",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2021-01-privatepreview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2021-01-privatepreview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2020-09",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2019-10-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2019-10-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).
Swagger Generation Artifacts
|
The swagger was mostly reviewed and updated in this PR - #12551. However, we had to move it to a new version and make a few changes that this PR includes. Thanks! |
...resource-manager/Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json
Outdated
Show resolved
Hide resolved
Updated alias name description
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.
What is your intention with this PR? The new spec you have created is not referenced from the readme file, so won't be used anywhere. Also, it is marked as a private preview, which means it likely should not be in the public repo.
Finally, there are several breaking changes from the previous stable version, as shown by the ci checks. These would all need approval by the breakiing change board.
Please respond on these issues before a review can proceed.
Swagger Validation Report
|
Rule | Message |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'Subscriptions_CreateAlias' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L20 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Subscriptions_GetAlias' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L66 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'SubscriptionPolicy_AddUpdatePolicyForTenant' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L633 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'SubscriptionPolicy_GetPolicyForTenant' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L669 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'BillingAccount_GetPolicy' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L732 |
Per the Noun_Verb convention for Operation Ids, the noun 'Subscriptions' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L245 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Subscriptions' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L305 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Subscriptions' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L380 |
|
'GET' operation 'Subscription_AcceptOwnershipStatus' 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.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L212 |
|
'PUT' operation 'SubscriptionPolicy_AddUpdatePolicyForTenant' 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.Subscription/preview/2021-01-01-privatepreview/subscriptions.json#L635 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/subscription/resource-manager/readme.md tag: specification/subscription/resource-manager/readme.md#tag-package-2020-09 |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 22 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2021-01-01-privatepreview/subscriptions.json compared with base:preview/2019-10-01-preview/subscriptions.json
- current:preview/2021-01-01-privatepreview/subscriptions.json compared with base:stable/2020-09-01/subscriptions.json
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️️✔️
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":"subscription/resource-manager/readme.md",
"tag":"package-2020-09",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2020-09",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2021-01-privatepreview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2021-01-privatepreview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2020-09",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2019-10-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"subscription/resource-manager/readme.md",
"tag":"package-2019-10-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).
bf15c40
to
acc3a45
Compare
The automatic checks failing are the following - |
Hi @rajshah11, 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. |
Closing this pull request as the intention of the authors is not clear. It is not appropriate to check in a private preview api here, nor to name a version 'privatepreview' |
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.
Already deployed
By end of this month, As soon as, possible
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.