[REVIEW ONLY] ACR API version 2023-01-01-preview #21678
Closed
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
AntonioVT
requested review from
msyyc,
Wzb123456789,
ArcturusZhang and
qiaozha
as code owners
|
Hi, @AntonioVT 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] |
ghost
added
the
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| containerregistry.json | 2023-01-01-preview(a5c41c8) | 2021-09-01(main) |
| containerregistry.json | 2023-01-01-preview(a5c41c8) | 2022-02-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-01-preview | package-2023-01-preview(a5c41c8) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L224 |
||
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L815 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The property 'properties.syncProperties' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L525 |
|
The async patch operation should return 202. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L530 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L559 |
|
Tracked resource 'ExportPipeline' must have patch operation that at least supports the update of tags. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L925 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1088 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1117 |
|
Tracked resource 'ImportPipeline' must have patch operation that at least supports the update of tags. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1189 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1363 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1405 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1654 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1672 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1696 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1742 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1789 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1831 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1867 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1906 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1949 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L1996 |
|
The async patch operation should return 202. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2051 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2051 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2094 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2130 |
|
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2148 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2214 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2259 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2295 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2337 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2383 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json#L2433 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/containerregistry/resource-manager/readme.md tag: specification/containerregistry/resource-manager/readme.md#tag-package-2023-01-preview |
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.ContainerRegistry' for api version '2023-01-01-preview'. The supported api-versions are '2017-03-01, 2017-06-01-preview, 2017-10-01, 2019-05-01, 2019-12-01-preview, 2020-11-01-preview, 2021-06-01-preview, 2021-08-01-preview, 2021-09-01, 2021-12-01-preview, 2022-02-01-preview'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 38 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️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
|
Generated ApiView
|
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @AntonioVT your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
This was referenced Nov 28, 2022
|
Hi @AntonioVT, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @AntonioVT, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This was referenced Nov 28, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . This helps us in reviewing only the new changes from previous base api version. Please remove the "ARMChangesRequested" label once you have fixed this issue. |
visingla-ms
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
Closing PR as I have generated a new one using the OpenAPI Hub flow: #21727 |
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:
What's the purpose of the update?
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
A: Deploy feature in canary regions by end of November 2022. Deploy feature in all public regions by Jan 2023.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
A: End of November 2022
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
A: This PR is for review only, please do NOT merge or automatically refresh the SDKs yet.
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.