Dev/iliaskhan/update blob api version #20827
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
|
Hi, @IliasKhan 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] |
Swagger Validation Report
|
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| default | default(474c395) | default(main) |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️~[Staging] TrafficValidation succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
️️✔️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
|
AzureRestAPISpecReview
added
ReadyForApiTest
This was referenced Sep 22, 2022
|
@IliasKhan I noticed that |
ericshape
reviewed
Sep 26, 2022
| @@ -563,14 +563,7 @@ APIs must only be added to this section when the API is publicly available in at | |||
|
|
|||
| ``` yaml $(tag) == 'package-composite-v5' | |||
| input-file: | |||
| - Microsoft.Sql/stable/2014-04-01-legacy/backups_legacy.json | |||
There was a problem hiding this comment.
why do we move these files to the bottom?
ericshape
reviewed
Sep 26, 2022
ericshape
reviewed
Sep 26, 2022
I just updated the api version to 2022-02-01 |
IliasKhan
force-pushed
the
dev/iliaskhan/UpdateBlobApiVersion
branch
from
a9b6f7c to
474c395
Compare
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
Wait for more careful breaking changes discussion. |
tadelesh
removed
the
Approved-SdkBreakingChange-Go
|
This PR's required for User Managed Identity release, Management Service changes already deployed, Portal changes are going to deploy. there will be incosistency if we don't deploy Powershell and CLI changes. |
|
Regarding Go breaking changes, I listed all related swagger change and breaking reasons as follows. @xiaoxuqi-ms, for this PR, I think the adding of Go breaking reasons: |
via git blame in the README.md file, I retrieved the PR for these breaking changes:
|
|
@ericshape I've reviewed the PR you listed. Actually, all breaking changes are from two main swagger change PRs: #19820 and #20469. The later one has been approved. But the former one seems not. The following breakings from the former PR need to be reviewed and approved: |
|
It is the PR I released the new API version 'cause the dev branch (https://github.com/Azure/azure-rest-api-specs/commits/dev-sql-Microsoft.Sql-2022-02-01-preview/specification) has so many conflicts we could not address. |
@tadelesh it seems you have approved the SDK breaking change in #19955 (comment) |
it seems the only PR for the SDK breaking change is https://github.com/Azure/azure-rest-api-specs/pull/18894/files |
|
The tools are not flagging any breaking changes in the REST API interface. I'm simply trusting the tools here as it would be difficult to determine the effect of the change in the readme.md. |
@mikekistler For SDK breaking changes, our tool will report the breaking changes only when author changing the swagger version in default tag. Sometimes such change is separated with the actual swagger file change, just like this PR. So, I need to find the previous swagger file change PR and see whether the breaking changes have been approved. @ericshape Thanks for the relay. I confirm with swagger team that the breaking changes of preview version in one year are not required to have been reviewed and approved. This PR detected the breakings but report them only with warning. So, I will approve the Go SDK breakings and for the new SDK release request with tag |
tadelesh
added
the
Approved-SdkBreakingChange-Go
xiaoxuqi-ms
approved these changes
Oct 13, 2022
This was referenced Oct 13, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Oct 13, 2022
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
Co-authored-by: Ilias Khan <[email protected]>
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.