[ContainerRegistry] update for better codegen for data plane Track 2 SDK libraries #13711
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
Add a new folder Azure.ContainerRegistry with a copy of preview/2019-08-15 specs in preparation of further changes to make better codegen of Track 2 data plane SDK libraries
|
Hi, @jeremymeng 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 |
|
[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 Validation Report
|
| Rule | Message |
|---|---|
| The operation 'ContainerRegistry_DeleteManifest' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L172 |
|
| The operation 'ContainerRegistryBlob_DeleteBlob' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L318 |
|
| The operation 'ContainerRegistryBlob_UploadChunk' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L453 |
|
| The operation 'ContainerRegistry_DeleteRepository' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L665 |
|
| The operation 'ContainerRegistry_DeleteTag' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L864 |
|
| The operation 'ContainerRegistryBlob_StartUpload' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L1146 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"containerregistry/data-plane/Azure.ContainerRegistry/readme.md", "tag":"package-2019-08", "details":"The schema 'paths·v9pjtw·v2-name-manifests-reference·put·responses·201·content·application-json·schema' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#/components/schemas/paths·v9pjtw·v2-name-manifests-reference·put·responses·201·content·application-json·schema" |
|
| 💬 AutorestCore/Exception | "readme":"containerregistry/data-plane/Azure.ContainerRegistry/readme.md", "tag":"package-2019-08", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"containerregistry/data-plane/Azure.ContainerRegistry/readme.md", "tag":"package-2019-08", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"containerregistry/data-plane/Azure.ContainerRegistry/readme.md", "tag":"package-2019-08", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.15.456)" |
| 💬 AutorestCore/Exception | "readme":"containerregistry/data-plane/Azure.ContainerRegistry/readme.md", "tag":"package-2019-08", "details":"> Installed 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 pipeline restarted successfully, please wait for status update in this comment. |
|
Hi @jeremymeng, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
This was referenced Mar 29, 2021
This was referenced Mar 29, 2021
|
@jeremymeng , if the Track 1 swagger filepath is |
yes I believe it is the service version. At least that what I've been seeing in Storage. |
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
- rename folder to be consistent with api version - remove GetAccessToken.json example as the endpoint was removed in this swagger
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
also remove sections unrelated to Track 2 SDK
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
Hi, @jeremymeng. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
the
Add words to custom-words.txt
jeremymeng
commented
Jun 14, 2021
| python: true | ||
| ``` | ||
|
|
||
| ## Suppression |
There was a problem hiding this comment.
The Suppression section is copied from existing master branch
it breaks yaml
as `azurecr.io` is kust for public cloud and the format can be different for every cloud or vanity URLs.
tjprescott
approved these changes
Jun 22, 2021
|
@jeremymeng is this ready to merge? |
@tjprescott I contacted and would like to get some review and approval from the service team first. |
shahzzzam
reviewed
Jun 24, 2021
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Container Registry", |
There was a problem hiding this comment.
Azure Container Registry?
shahzzzam
reviewed
Jun 24, 2021
| "readEnabled": true, | ||
| "listEnabled": true, | ||
| "deleteEnabled": true, | ||
| "writeEnabled": true |
There was a problem hiding this comment.
can you add "teleportEnabled": false?
- Add "Azure" to title - add `"teleportEnabled": false` to example
|
@jeremymeng please ping me when you are ready to merge this |
|
@tjprescott It's ready to go! |
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…SDK libraries (Azure#13711) * [Track2 Data Plane SDK] prepare folder Add a new folder Azure.ContainerRegistry with a copy of preview/2019-08-15 specs in preparation of further changes to make better codegen of Track 2 data plane SDK libraries * Add Track 2 customizations * update PATCH return types * Add a preliminary readme.md * Fix CI Avocado failures - rename folder to be consistent with api version - remove GetAccessToken.json example as the endpoint was removed in this swagger * Add timeasc and timedesc to custom-words.txt also remove sections unrelated to Track 2 SDK * Update typescript customization * Fix required-ness for some properties Fix casing aadAccesstoken => aadAccessToken * Run prettier * updates to swagger for Beta 2 API * bug fix in arch enum * updates per apiview feedback * updates to manifest properties * Move some customization into swagger * Undo client name customization for `architecture` Now that we use `architecture` in the new API design. * Update arch and os types and set readOnly: true * make change for grant type = password * editing the correct swagger * undoing changes to the wrong swagger * adding internal enum for grant type * moving grant_type to the end of the parameters for .net * Incorporate Anne's beta.3 swagger update and make ManifestAttributes.manifest required so its flattened `digest` property can have their proper required-ness. * small name changes * updates to separate out ArtifactManifestReference * flatten writeable property types; add registry property back * update the delete methods * Remove property required-ness as they are used for input and cannot be used together with "readOnly" * Run prettier * Fix linting errors in examples * Remove extraneous brace * Add custom word for ACR * Fix more linting errors in examples * Revert "Remove property required-ness" This reverts commit 4eba58a. * Remove default value of "none" for architecture enum * renames per arch board review * Copy the existing suppression from master * Fix spellcheck errors Add words to custom-words.txt * More spelling fix * Suppress R2056 RequiredReadOnlyProperties Reasoning at Azure/azure-openapi-validator#243 * Remove `:` in reason value it breaks yaml * Update description of registryLoginServer as `azurecr.io` is kust for public cloud and the format can be different for every cloud or vanity URLs. * Address PR feedback - Add "Azure" to title - add `"teleportEnabled": false` to example * Minor update to tyepscript codegen customization section Co-authored-by: Anne Loomis Thompson <annelo@microsoft.com> Co-authored-by: seankane-msft <seankane@microsoft.com> Co-authored-by: Pallavi Taneja <pallavit@users.noreply.github.com>
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
Please ensure to add changelog with 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
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.