Swagger change for mtls and runningState #23767
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
2. Add running state for Revision
|
Hi, @zhenqxuMSFT 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 swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| ContainerAppsRevisions.json | 2023-04-01-preview(c5b1592) | 2022-10-01(main) |
| ContainerAppsRevisions.json | 2023-04-01-preview(c5b1592) | 2022-11-01-preview(main) |
| ManagedEnvironments.json | 2023-04-01-preview(c5b1592) | 2022-10-01(main) |
| ManagedEnvironments.json | 2023-04-01-preview(c5b1592) | 2022-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.1) | new version | base version |
|---|---|---|
| package-preview-2023-04 | package-preview-2023-04(c5b1592) | package-preview-2023-04(release-app-Microsoft.App-2023-04-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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/2023-04-01-preview/ManagedEnvironments.json#L1133 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response in the GET collection operation 'ContainerAppsDiagnostics_ListDetectors' does not match the response definition in the individual GET operation 'ContainerAppsDiagnostics_GetDetector' . Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L17 |
|
The response in the GET collection operation 'ManagedEnvironmentDiagnostics_ListDetectors' does not match the response definition in the individual GET operation 'ManagedEnvironmentDiagnostics_GetDetector' . Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L17 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L18 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L75 |
|
The resource name parameter 'revisionName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L75 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L128 |
|
The resource name parameter 'revisionName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L128 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L178 |
|
The resource name parameter 'revisionName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L178 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L228 |
|
The resource name parameter 'revisionName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L228 |
|
The resource name parameter 'replicaName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L228 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L288 |
|
The resource name parameter 'revisionName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L288 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L341 |
|
The resource name parameter 'revisionName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L341 |
|
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.App/preview/2023-04-01-preview/ContainerAppsRevisions.json#L464 |
|
The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L101 |
|
A 202 response should include an Location response header. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L240 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L281 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L281 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L281 |
|
Properties of a PATCH request body must not be required, property:location. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L286 |
|
A 202 response should include an Location response header. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L301 |
|
The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L319 |
|
The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L369 |
|
The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L369 |
|
The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L597 |
|
The resource name parameter 'managedCertificateName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L597 |
|
The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L839 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @zhenqxuMSFT, 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. |
|
Hi @zhenqxuMSFT, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
/azp run |
|
Commenter does not have sufficient privileges for PR 23767 in repo Azure/azure-rest-api-specs |
|
@weidongxu-microsoft @kazrael2119 the breaking change is not introduced by this PR. And it's already reviewed and approved: #22380, WI: https://msazure.visualstudio.com/One/_workitems/edit/16986590 |
@weidongxu-microsoft synced with me offline that there's still missing breaking change approval for some existing codes. @mikekistler could you help to review the breaking change, thanks! https://msazure.visualstudio.com/One/_workitems/edit/21201424 |
|
Breaking changes previously reviewed/approved in #22896 |
mikekistler
added
the
Approved-BreakingChange
kazrael2119
approved these changes
May 6, 2023
weidongxu-microsoft
merged commit 2ea2211
into
Azure:release-app-Microsoft.App-2023-04-01-preview
tadelesh
pushed a commit
that referenced
this pull request
May 26, 2023
* Adds base for updating Microsoft.App from version preview/2022-11-01-preview to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * support terminationGracePeriodSeconds (#23476) * Support SubPath in volume mount and mount options for azure file volume (#23496) * Support SubPath in volume mount and mount options for azure file volume * update description * Add replica/container running state (#23617) * add replica/container running state * spell error fix * add event trigger for Container Jobs 2023-04-01-preview (#23724) * add event trigger for Container Jobs 2023-04-01-preview * prettier and avocado fix --------- Co-authored-by: Taher Darolywala <[email protected]> * Resolve Comments for Event driven jobs (#23729) * Resolve Comments for Event driven jobs * change scaling rule to azure-servicebus * update example --------- Co-authored-by: Taher Darolywala <[email protected]> * Swagger change for mtls and runningState (#23767) * 1. Add mtls properties for managed ManagedEnvironment 2. Add running state for Revision * fix * Add ContainerApp Start/Stop for 2023-04-01-preview (#23497) * Add ContainerApp Start/Stop for 2023-04-01-preview * Fix validation error * Fix validation error * Change example to add location in header * Fix lint error * Fix lint issue * Fix lint issue * Fix lint issue * Fix lint issue * Fix lint issue * Fix lint issue * Fix lint issue * Fix lint issue * Add new source controls properties (#23891) * Add new source controls properties * Update examples * fix examples * Change event trigger replica properties to executions, add polling in… (#23810) * Change event trigger replica properties to executions, add polling interval to event trigger, fix typos and descriptions to accommodate both apps and jobs * Fix validation errors * code review comments * Fix formatting errors * Code review comments * Add single execution history endpoint, refactor copy paste code for j… (#23816) * Add single execution history endpoint, refactor copy paste code for jobName and jobExecutionName path parameters * Fix validation errors from ARM * Fix validation errors * Code review comments * Fix validation error * code review comments from Anand * Add springboard properties (#23932) * Add springboard properties * CR comments * Update specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_CreateOrUpdate.json Co-authored-by: Jitin John <[email protected]> * Update specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_CreateOrUpdate.json Co-authored-by: Jitin John <[email protected]> --------- Co-authored-by: Jitin John <[email protected]> * Fix Lint issues in ContainerApps.json (#24107) * Fix lint issue * Fix format issue * Fix json format issue * Fix model validation * Fix lint error * fix param (#24166) Co-authored-by: Chenghui Yu <[email protected]> --------- Co-authored-by: Zunli Hu <[email protected]> Co-authored-by: njucz <[email protected]> Co-authored-by: LaylaLiu-gmail <[email protected]> Co-authored-by: Xingjian Wang <[email protected]> Co-authored-by: Taher Daroly <[email protected]> Co-authored-by: Taher Darolywala <[email protected]> Co-authored-by: zhenqxuMSFT <[email protected]> Co-authored-by: Zijian-Ju <[email protected]> Co-authored-by: Sanchit Mehta <[email protected]> Co-authored-by: trajkobal <[email protected]> Co-authored-by: Ahmed ElSayed <[email protected]> Co-authored-by: Jitin John <[email protected]> Co-authored-by: Seris370 <[email protected]> Co-authored-by: Chenghui Yu <[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.