Add properties for secrets from KV #22652
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, @xwang971 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| CommonDefinitions.json | 2022-11-01-preview(4d4395b) | 2022-10-01(main) |
| CommonDefinitions.json | 2022-11-01-preview(4d4395b) | 2022-06-01-preview(main) |
| ContainerApps.json | 2022-11-01-preview(4d4395b) | 2022-10-01(main) |
| ContainerApps.json | 2022-11-01-preview(4d4395b) | 2022-06-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L928:7 Old: Microsoft.App/stable/2022-10-01/ContainerApps.json#L887:7 |
|
The new version has new required property 'certificateId' that was not found in the old version. New: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L770:11 Old: Microsoft.App/stable/2022-10-01/ContainerApps.json#L758:11 |
|
The new version has new required property 'certificateId' that was not found in the old version. New: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L921:5 Old: Microsoft.App/stable/2022-10-01/ContainerApps.json#L881:5 |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L928:7 Old: Microsoft.App/preview/2022-06-01-preview/ContainerApps.json#L865:7 |
|
| The new version has new required property 'certificateId' that was not found in the old version. New: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L770:11 Old: Microsoft.App/preview/2022-06-01-preview/ContainerApps.json#L753:11 |
|
| The new version has new required property 'certificateId' that was not found in the old version. New: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L921:5 Old: Microsoft.App/preview/2022-06-01-preview/ContainerApps.json#L859:5 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(4d4395b) | package-preview-2022-11(release-app-Microsoft.App-2022-11-01-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L99 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L148 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L215 |
|
A 202 response should include an Location response header. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L244 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L285 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L285 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L285 |
|
Properties of a PATCH request body must not be required, property:location. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L290 |
|
A 202 response should include an Location response header. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L305 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L323 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L375 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L421 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L686 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L695 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L859 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L862 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L931 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L989 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L992 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L25 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L64 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L106 |
|
| The summary and description values should not be same. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L148 |
|
| 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.App/preview/2022-11-01-preview/ContainerApps.json#L148 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L155 |
|
| The summary and description values should not be same. Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L215 |
|
| 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.App/preview/2022-11-01-preview/ContainerApps.json#L215 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L222 |
|
| 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.App/preview/2022-11-01-preview/ContainerApps.json#L264 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/ContainerApps.json#L271 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @xwang971, Your PR has some issues. Please fix the CI sequentially by following the order of
|
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @xwang971, 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. |
This was referenced Feb 16, 2023
[AutoPR @azure/arm-appcontainers] Add properties for secrets from KV
azure-sdk/azure-sdk-for-js#3949
Closed
|
@leni-msft Hi, this is a new preview API version which is not released. We need to add 2 properties to secrets so ideally this should not be a breaking change |
|
Hi @leni-msft can I get this PR approved please? We would need to kick off the release by the end of this month. Thank you! |
|
Hi @leni-msft can I get this PR approved please? We need to kick off the release by the end of this month |
leni-msft
removed
the
BreakingChangeReviewRequired
leni-msft
approved these changes
Feb 17, 2023
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.