Corrected a response of AcceptOwnershipStatus by adding provisioningState field #20250
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
added 2 commits
August 15, 2022 17:43
|
Hi, @Ochirkhuyag 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] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| subscriptions.json | 2021-10-01(bc09f11) | 2021-10-01(main) |
| Rule | Message |
|---|---|
|
The new version has a new property 'provisioningState' in response that was not found in the old version. New: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L853:7 Old: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L853:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2021-10 | package-2021-10(bc09f11) | package-2021-10(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Missing identifier id in array item property Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L590 |
|
Missing identifier id in array item property Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L993 |
| '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/stable/2021-10-01/subscriptions.json#L347 |
|
| '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/stable/2021-10-01/subscriptions.json#L380 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L643 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L721 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L820 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L929 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L978 |
|
| 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: 'Alias_Create' Request Model: 'PutAliasRequest' Response Model: 'SubscriptionAliasResponse' Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L155 |
|
| 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: 'SubscriptionPolicy_AddUpdatePolicyForTenant' Request Model: 'PutTenantPolicyRequestProperties' Response Model: 'GetTenantPolicyResponse' Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L378 |
|
| Based on the response model schema, operation 'Alias_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L265 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L21 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L54 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L90 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L297 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SubscriptionModel'. Consider using the plural form of 'Subscription' 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.Subscription/stable/2021-10-01/subscriptions.json#L347 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L611 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: blockSubscriptionsLeavingTenant Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L891 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: blockSubscriptionsIntoTenant Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L895 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowTransfers Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1002 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: blockSubscriptionsLeavingTenant Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1017 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: blockSubscriptionsIntoTenant Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1021 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L188 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L330 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L401 |
️⚠️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-2021-10 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"errorCode: AssertionError, errorMessage: ResourceType 'aliases' should be deployed in 'West Central US' on apiVersion '2021-10-01'.: expected [ Array(16) ] to satisfy [Function]" |
|
"errorCode: AssertionError, errorMessage: ResourceType 'aliases' should be deployed in 'West Central US' on apiVersion '2021-10-01'.: expected [ Array(16) ] to satisfy [Function]" |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/bc09f111cf0934b49944a7d0eb3fe8cda5c835ae/specification/subscription/resource-manager/readme.md#tag-package-2021-10">subscription/resource-manager/readme.md#package-2021-10
| Rule | Message |
|---|---|
| "readme":"subscription/resource-manager/readme.md", "tag":"package-2021-10", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
|
NewApiVersionRequired reason: |
|
Hi @Ochirkhuyag, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Aug 16, 2022
JeffreyRichter
added
the
Approved-BreakingChange
dw511214992
approved these changes
Aug 17, 2022
This was referenced Aug 17, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Aug 17, 2022
…s by adding provisioningState field (#2532) Create to sync Azure/azure-rest-api-specs#20250 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/subscription?expand=1)
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.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for 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
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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.