ACR API version 2021-09-01 #16481
Merged
ACR API version 2021-09-01 #16481
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
|
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. vsswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The child tracked resource, 'privateLinkResources' with immediate parent 'Registry', must have a list by immediate parent operation. Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L2501 |
The following errors/warnings exist before current PR submission:
Only 29 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.ContainerRegistry/stable/2021-09-01/containerregistry.json#L48 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L82 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L124 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L163 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L205 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L251 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L295 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L329 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L365 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L404 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L447 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L491 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L538 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L581 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L617 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L701 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L746 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L782 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L824 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L870 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L917 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L967 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1010 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1052 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1098 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1142 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1192 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1238 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1277 |
️⚠️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-2021-09 |
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 2 Errors, 67 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.1)
- current:stable/2021-09-01/containerregistry.json compared with base:stable/2019-05-01/containerregistry.json
- current:stable/2021-09-01/containerregistry.json compared with base:preview/2021-08-01-preview/containerregistry.json
| Rule | Message |
|---|---|
|
The new version is missing a property found in the old version. Was 'storageAccount' renamed or removed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1888:7 Old: Microsoft.ContainerRegistry/stable/2019-05-01/containerregistry.json#L1378:7 |
|
The new version is missing a property found in the old version. Was 'virtualNetworkRules' renamed or removed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L2099:7 Old: Microsoft.ContainerRegistry/stable/2019-05-01/containerregistry.json#L1472:7 |
The following breaking changes are detected by comparison with latest preview version:
Only 29 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L18:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L66:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}/deactivate' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L276:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L322:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L361:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L546:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L585:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L790:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L829:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L1767:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L1806:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L1992:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2031:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials' removed or restructured? Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2217:5 |
|
| The new version is missing a definition that was found in the old version. Was 'ConnectedRegistry' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ConnectedRegistryProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ActivationProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ParentProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'LoginServerProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'LoggingProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'SyncProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'TlsProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'TlsCertificateProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ConnectedRegistryUpdateParameters' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ConnectedRegistryUpdateProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'SyncUpdateProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ExportPipeline' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ExportPipelineProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ExportPipelineTargetProperties' removed or renamed? New: Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json#L1335:3 Old: Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json#L2612:3 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
- containerregistry/resource-manager/readme.md#package-2021-08-preview-only
- containerregistry/resource-manager/readme.md#package-2021-08-preview
- containerregistry/resource-manager/readme.md#package-2021-06-preview-only
- containerregistry/resource-manager/readme.md#package-2021-06-preview
- containerregistry/resource-manager/readme.md#package-2020-11-preview-only
- containerregistry/resource-manager/readme.md#package-2020-11-preview
- containerregistry/resource-manager/readme.md#package-2019-12-preview
- containerregistry/resource-manager/readme.md#package-2019-06-preview
- containerregistry/resource-manager/readme.md#package-2019-06-preview-only
- containerregistry/resource-manager/readme.md#package-2021-09-only
- containerregistry/resource-manager/readme.md#package-2021-09
️️✔️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).
|
[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
|
|
Hi @AntonioVT, Your PR has some issues. Please fix the CI sequentially by following the order of
|
AntonioVT
changed the title
This was referenced Oct 20, 2021
AntonioVT
requested review from
00Kai0,
ArcturusZhang,
jsntcy,
msyyc,
qiaozha and
RAY-316
as code owners
list** are reserved for POST operations. If you want to list usages you need to update your api to be: Refers to: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json:560 in 580d610. [](commit_id = 580d610, deletion_comment = False) |
when you model a collection GET the expectation is to have a single get call, I assume these resources are proxy and created by your RP, so I recommend naming a resource: Refers to: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json:596 in 580d610. [](commit_id = 580d610, deletion_comment = False) |
POST must not be used on a collection of resources. Please see our docs: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html Refers to: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json:1208 in 580d610. [](commit_id = 580d610, deletion_comment = False) |
this seems a bit odd, you use get verb but your method is POST, Refers to: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json:1250 in 580d610. [](commit_id = 580d610, deletion_comment = False) |
this could contain authorization headers? if yes, mark as x-ms-secret, see here: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html Refers to: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json:3165 in 580d610. [](commit_id = 580d610, deletion_comment = False) |
@jorgecotillo After updating the swagger to add |
Yes please, just noticed that this definition is used as a response of your POST operation so no need to mark it as secret. |
jorgecotillo
added
ARMSignedOff
|
Hi @AntonioVT, 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. |
|
@fengzhou-msft FYI, there is an issue in a property named Thanks! |
JeffreyRichter
added
the
Approved-BreakingChange
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
CI-BreakingChange-Go
and removed
CI-FixRequiredOnFailure
labels
fengzhou-msft
approved these changes
Nov 18, 2021
This was referenced Nov 18, 2021
Closed
Merged
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Nov 18, 2021
11 tasks
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
24 tasks
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.
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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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.