add 2021-07-01 swagger by shahzzzam · Pull Request #14854 · Azure/azure-rest-api-specs

shahzzzam · 2021-06-16T19:29:00Z

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.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
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.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

openapi-workflow-bot · 2021-06-16T19:29:03Z

Hi, @shahzzzam Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-workflow-bot · 2021-06-16T19:29:04Z

[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.

openapi-pipeline-app · 2021-06-16T19:29:04Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- data-plane/Azure.ContainerRegistry/readme.md tag:package-2021-07
Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- data-plane/Azure.ContainerRegistry/readme.md tag:default

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'ContainerRegistry_DeleteManifest' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L172
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'ContainerRegistryBlob_DeleteBlob' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L318
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'ContainerRegistryBlob_UploadChunk' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L453
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'ContainerRegistry_DeleteRepository' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L671
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'ContainerRegistry_DeleteTag' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L888
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'ContainerRegistryBlob_StartUpload' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L1243

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` RESPONSE_BODY_NOT_IN_EXAMPLE	Response statusCode "202" for operation "ContainerRegistry_DeleteRepository" has no response body provided in the example, however the response does have a "schema" defined in the swagger spec.
`❌` INVALID_TYPE	Expected type string but found type object Url: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L3172
`❌` INVALID_TYPE	Expected type string but found type object Url: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L3172
`❌` INVALID_TYPE	Expected type string but found type object Url: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L3172

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️⚠️Cross-Version Breaking Changes: 12 Warnings warning [Detail]

Compared Swaggers (Based on Oad v0.9.0)
- current:stable/2021-07-01/containerregistry.json compared with base:preview/2019-08-15-preview/containerregistry.json

The following breaking changes are detected by comparison with latest preview version:

Rule	Message
⚠️ 1016 - ConstantStatusHasChanged	The 'constant' status changed from the old version to the new. New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L1077:9 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L1041:9
⚠️ 1016 - ConstantStatusHasChanged	The 'constant' status changed from the old version to the new. New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L3011:5 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L2931:5
⚠️ 1025 - RequiredStatusChange	The 'required' status changed from the old version('True') to the new version('False'). New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L1077:9 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L1041:9
⚠️ 1025 - RequiredStatusChange	The 'required' status changed from the old version('True') to the new version('False'). New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L3057:5 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L2975:5
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L106:13 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L106:13
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'teleportEnabled' renamed or removed? New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L2492:7 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L2407:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'teleportEnabled' renamed or removed? Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L710:9
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'quarantineState' renamed or removed? New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L2459:7 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L2362:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'quarantineDetails' renamed or removed? New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L2459:7 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L2362:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'quarantineState' renamed or removed? Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L1003:9
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'quarantineDetails' renamed or removed? Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L1003:9
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'quarantineTag' renamed or removed? New: Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json#L2430:7 Old: Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json#L2328:7

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

containerregistry/data-plane/Azure.ContainerRegistry/readme.md#package-2021-07

️️✔️[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).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-06-16T19:29:04Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

openapi-workflow-bot · 2021-06-16T19:29:53Z

Hi, @shahzzzam your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

ghost · 2021-08-01T16:02:21Z

Hi, @shahzzzam. 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 no-recent-activity label.

openapi-workflow-bot · 2021-08-09T20:10:24Z

Hi @shahzzzam, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

...ontainerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json

shahzzzam · 2021-08-27T15:34:48Z

Can someone please help with the error? I don't understand what file it refers to.

ghost · 2021-09-19T16:02:46Z

Hi, @shahzzzam. 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 no-recent-activity label.

...ontainerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json

* add 2021-07-01 swagger * update swagger * update folders * update to support Azure/azure-sdk-for-net#22576 * remove preview items+introduce apiversion * address comments * run prettier-check * fix CI * re-add changes from old preview swagger * address comments * add missing example Co-authored-by: Anne Loomis Thompson <annelo@microsoft.com>

add 2021-07-01 swagger

1e3f901

openapi-assignment-bot bot assigned anuchandy Jun 16, 2021

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 16, 2021

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jun 16, 2021

openapi-sdkautomation bot mentioned this pull request Jun 16, 2021

[AutoPR Microsoft.Azure.ContainerRegistry] add 2021-07-01 swagger AzureSDKAutomation/azure-sdk-for-net#4436

Draft

markweitzel added the APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. label Jun 17, 2021

shahzzzam added 2 commits June 29, 2021 08:47

update swagger

5aa86ca

Merge branch 'master' into stable-swagger

94a381c

openapi-sdkautomation bot mentioned this pull request Jun 29, 2021

[AutoPR Microsoft.Azure.ContainerRegistry] add 2021-07-01 swagger AzureSDKAutomation/azure-sdk-for-net#4635

Draft

shahzzzam and others added 2 commits June 30, 2021 14:11

update folders

765876c

update to support Azure/azure-sdk-for-net#22576

2c33d55

ghost added no-recent-activity and removed no-recent-activity labels Aug 1, 2021

markweitzel requested a review from JeffreyRichter August 6, 2021 13:32

markweitzel assigned JeffreyRichter Aug 6, 2021

JeffreyRichter approved these changes Aug 6, 2021

View reviewed changes

JeffreyRichter added APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. and removed APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. labels Aug 6, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Aug 9, 2021

remove preview items+introduce apiversion

1ab33fd

shahzzzam force-pushed the stable-swagger branch from 5e043df to 1ab33fd Compare August 9, 2021 20:14

mnltejaswini reviewed Aug 9, 2021

View reviewed changes

...ontainerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json Show resolved Hide resolved

mnltejaswini reviewed Aug 9, 2021

View reviewed changes

...ontainerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json Show resolved Hide resolved

mnltejaswini reviewed Aug 9, 2021

View reviewed changes

...ontainerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json Outdated Show resolved Hide resolved

mnltejaswini reviewed Aug 9, 2021

View reviewed changes

...ontainerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json Outdated Show resolved Hide resolved

address comments

27d4aa5

mnltejaswini approved these changes Aug 18, 2021

View reviewed changes

shahzzzam added 2 commits August 25, 2021 16:57

run prettier-check

a96c5bb

fix CI

c74b69e

shahzzzam force-pushed the stable-swagger branch from 83652e4 to c74b69e Compare August 25, 2021 12:58

raych1 added the Approved-ModelValidation label Aug 30, 2021

Merge branch 'master' into stable-swagger

8148db1

ghost added the no-recent-activity label Sep 19, 2021

re-add changes from old preview swagger

76b7298

ghost removed the no-recent-activity label Sep 20, 2021

jeremymeng reviewed Sep 20, 2021

View reviewed changes

...ontainerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json Outdated Show resolved Hide resolved

jeremymeng reviewed Sep 20, 2021

View reviewed changes

...ontainerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json Outdated Show resolved Hide resolved

shahzzzam added 2 commits September 21, 2021 02:36

address comments

f3428a6

add missing example

d4d8733

lmazuel merged commit c8d9a26 into Azure:main Sep 22, 2021

shahzzzam deleted the stable-swagger branch September 22, 2021 20:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add 2021-07-01 swagger#14854

add 2021-07-01 swagger#14854
lmazuel merged 13 commits intoAzure:mainfrom
shahzzzam:stable-swagger

shahzzzam commented Jun 16, 2021 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Jun 16, 2021

Uh oh!

openapi-workflow-bot bot commented Jun 16, 2021

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2021 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2021 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Jun 16, 2021

Uh oh!

ghost commented Aug 1, 2021

Uh oh!

openapi-workflow-bot bot commented Aug 9, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shahzzzam commented Aug 27, 2021

Uh oh!

ghost commented Sep 19, 2021

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Conversation

shahzzzam commented Jun 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Jun 16, 2021

Uh oh!

openapi-workflow-bot bot commented Jun 16, 2021

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-workflow-bot bot commented Jun 16, 2021

Uh oh!

ghost commented Aug 1, 2021

Uh oh!

openapi-workflow-bot bot commented Aug 9, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shahzzzam commented Aug 27, 2021

Uh oh!

ghost commented Sep 19, 2021

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

shahzzzam commented Jun 16, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jun 16, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jun 16, 2021 •

edited

Loading