Add necessary prerequisite to register the API #22623
Merged
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
I'm Penny Ko from MSFT. Proposing to add below to the doc page. Without the register action, customer will only get 404 error. Please register the feature with AZ CLI “az feature register -n AvailabilityZonePeering --namespace Microsoft.Resources”, and check the status with “az feature show -n AvailabilityZonePeering --namespace Microsoft.Resources” before calling the checkZonePeers API."
|
Hi, @pinyuko 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| subscriptions.json | 2020-01-01(f622043) | 2020-01-01(main) |
️️✔️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 v2.0.0) | new version | base version |
|---|---|---|
| package-subscriptions-2020-01 | package-subscriptions-2020-01(f622043) | package-subscriptions-2020-01(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L49 |
|
The response schema of operations API '/providers/Microsoft.Resources/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L52 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L62 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L78 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L96 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L111 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L126 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L138 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L156 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L168 |
|
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L186 |
|
The schema 'PairedRegion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L273 |
|
The schema 'LocationMetadata' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L293 |
|
The schema 'Location' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L351 |
|
The schema 'LocationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L385 |
|
The schema 'Subscription' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L397 |
|
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L443 |
|
The schema 'SubscriptionPolicies' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L461 |
|
The schema 'ManagedByTenant' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L490 |
|
The schema 'SubscriptionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L500 |
|
The schema 'TenantIdDescription' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L519 |
|
The schema 'TenantListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L587 |
|
The schema 'ResourceName' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L606 |
|
The schema 'CheckResourceNameResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L623 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L648 |
|
The schema 'ErrorDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L657 |
|
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L678 |
|
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L701 |
|
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L704 |
|
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L747 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
x-ms-example not found in Operations_List. Url: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L38:14 |
|
api-version 2021-01-01 is not equal to swagger version Url: Microsoft.Resources/stable/2020-01-01/subscriptions.json#L187:15 ExampleUrl: stable/2020-01-01/examples/PostCheckZonePeers.json#L2:17 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
|
Hi @pinyuko, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 15, 2023
Closed
This was referenced Feb 15, 2023
I'm Penny Ko from MSFT. Proposing to add below to the doc page. Without the register action, customer will only get 404 error. Please register the feature with AZ CLI “az feature register -n AvailabilityZonePeering --namespace Microsoft.Resources”, and check the status with “az feature show -n AvailabilityZonePeering --namespace Microsoft.Resources” before calling the checkZonePeers API."
leni-msft
approved these changes
Feb 16, 2023
leni-msft
reviewed
Feb 16, 2023
...fication/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/subscriptions.json
Show resolved
Hide resolved
leni-msft
added
WaitForARMFeedback
This was referenced Feb 17, 2023
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @pinyuko your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
* Add necessary prerequisite to register the API I'm Penny Ko from MSFT. Proposing to add below to the doc page. Without the register action, customer will only get 404 error. Please register the feature with AZ CLI “az feature register -n AvailabilityZonePeering --namespace Microsoft.Resources”, and check the status with “az feature show -n AvailabilityZonePeering --namespace Microsoft.Resources” before calling the checkZonePeers API." * Add required registration prerequisite. I'm Penny Ko from MSFT. Proposing to add below to the doc page. Without the register action, customer will only get 404 error. Please register the feature with AZ CLI “az feature register -n AvailabilityZonePeering --namespace Microsoft.Resources”, and check the status with “az feature show -n AvailabilityZonePeering --namespace Microsoft.Resources” before calling the checkZonePeers API." * Minor update
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.
ARM API Information (Control Plane)
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 (MS Employees Only):
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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.