Release app microsoft.app 2023 04 01 preview #24103
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
…preview to version 2023-04-01-preview
…me (#23496) * Support SubPath in volume mount and mount options for azure file volume * update description
* add replica/container running state * spell error fix
* add event trigger for Container Jobs 2023-04-01-preview * prettier and avocado fix --------- Co-authored-by: Taher Darolywala <tdarolywala@microsoft.com>
* Resolve Comments for Event driven jobs * change scaling rule to azure-servicebus * update example --------- Co-authored-by: Taher Darolywala <tdarolywala@microsoft.com>
* 1. Add mtls properties for managed ManagedEnvironment 2. Add running state for Revision * fix
* 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 * Update examples * fix examples
#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
#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 * CR comments * Update specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_CreateOrUpdate.json Co-authored-by: Jitin John <jijohn@microsoft.com> * Update specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_CreateOrUpdate.json Co-authored-by: Jitin John <jijohn@microsoft.com> --------- Co-authored-by: Jitin John <jijohn@microsoft.com>
|
Hi, @howang-ms 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 |
|---|---|---|
| AuthConfigs.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| AuthConfigs.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| AvailableWorkloadProfiles.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| AvailableWorkloadProfiles.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| BillingMeters.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| BillingMeters.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| CommonDefinitions.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| CommonDefinitions.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ConnectedEnvironments.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ConnectedEnvironments.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ConnectedEnvironmentsCertificates.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ConnectedEnvironmentsCertificates.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ConnectedEnvironmentsDaprComponents.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ConnectedEnvironmentsDaprComponents.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ConnectedEnvironmentsStorages.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ConnectedEnvironmentsStorages.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ContainerApps.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ContainerApps.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ContainerAppsRevisions.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ContainerAppsRevisions.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| Diagnostics.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| Diagnostics.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| Global.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| Global.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ManagedEnvironments.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ManagedEnvironments.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ManagedEnvironmentsDaprComponents.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ManagedEnvironmentsDaprComponents.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| ManagedEnvironmentsStorages.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| ManagedEnvironmentsStorages.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
| SourceControls.json | 2023-04-01-preview(37dba84) | 2022-10-01(main) |
| SourceControls.json | 2023-04-01-preview(37dba84) | 2022-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/37dba84d175e14a4f6a8df69689387a16416ca1b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/Jobs.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.54/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nERROR: Schema violation: Array is too short (0), minimum 1\n - file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json:791:6 ($.definitions.Job.required)\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 4 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| package-preview-2023-04 | package-preview-2023-04(37dba84) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/ContainerApps.json#L531 |
|
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/ContainerApps.json#L590 |
|
| 'GET' operation 'JobExecution' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L545 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L721 |
||
| 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 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2023-04-01-preview/ManagedEnvironments.json#L1253 |
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/2023-04-01-preview/AuthConfigs.json#L18 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/AuthConfigs.json#L67 |
|
The resource name parameter 'authConfigName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/AuthConfigs.json#L67 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2023-04-01-preview/AuthConfigs.json#L160 |
|
Property name should be camel case. Location: Microsoft.App/preview/2023-04-01-preview/AuthConfigs.json#L547 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.App/preview/2023-04-01-preview/BillingMeters.json#L37 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironments.json#L100 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironments.json#L182 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironments.json#L198 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironments.json#L255 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironments.json#L311 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsCertificates.json#L18 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsCertificates.json#L68 |
|
The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsCertificates.json#L68 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsCertificates.json#L161 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsDaprComponents.json#L18 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsDaprComponents.json#L67 |
|
The resource name parameter 'componentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsDaprComponents.json#L67 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsDaprComponents.json#L160 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsDaprComponents.json#L235 |
|
The resource name parameter 'componentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsDaprComponents.json#L235 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsStorages.json#L18 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsStorages.json#L47 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsStorages.json#L65 |
|
The resource name parameter 'storageName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsStorages.json#L65 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2023-04-01-preview/ConnectedEnvironmentsStorages.json#L159 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-04-01-preview/ContainerApps.json#L99 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.App/preview/2023-04-01-preview/ContainerApps.json#L131 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.App/preview/2023-04-01-preview/ContainerApps.json#L182 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/ContainerApps.json#L198 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/app/resource-manager/readme.md json: Microsoft.App/preview/2023-04-01-preview/CommonDefinitions.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️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.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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.
️️✔️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
ARMReview
BreakingChangeReviewRequired
11 tasks
* Fix lint issue * Fix format issue * Fix json format issue * Fix model validation * Fix lint error
|
@howang-ms , please fix lint diff error and if the swagger breaking changes have been approved, please give the pr link, thanks |
tadelesh
reviewed
May 25, 2023
specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/Jobs.json
Outdated
Show resolved
Hide resolved
tadelesh
added
the
WaitForARMFeedback
Co-authored-by: Chenghui Yu <chenghuiyu@microsoft.com>
|
Breaking changes have been reviewed and approved in last preview version: #22896. |
tadelesh
added
the
Approved-BreakingChange
visingla-ms
reviewed
May 25, 2023
| "description": "User friendly suffix that is appended to the revision name", | ||
| "type": "string" | ||
| }, | ||
| "terminationGracePeriodSeconds": { |
visingla-ms
reviewed
May 25, 2023
| "description": "Configuration to bind a ContainerApp to a dev ContainerApp Service", | ||
| "type": "object", | ||
| "properties": { | ||
| "serviceId": { |
There was a problem hiding this comment.
If it will always be an Azure Resource Id, consider using https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-arm-id-details.
visingla-ms
reviewed
May 25, 2023
| "properties": { | ||
| "type": { | ||
| "description": "Dev ContainerApp service type", | ||
| "type": "string" |
visingla-ms
reviewed
May 25, 2023
| "Jobs" | ||
| ], | ||
| "summary": "Get details of a single job execution", | ||
| "operationId": "JobExecution", |
visingla-ms
reviewed
May 25, 2023
| }, | ||
| "metadata": { | ||
| "description": "Metadata properties to describe the scale rule.", | ||
| "type": "object" |
visingla-ms
reviewed
May 25, 2023
| "type": "string" | ||
| }, | ||
| "githubPersonalAccessToken": { | ||
| "description": "One time Github PAT to configure github environment", |
visingla-ms
reviewed
May 25, 2023
| "kind": { | ||
| "description": "Kind of auth github does for deploying the template", | ||
| "type": "string", | ||
| "x-ms-mutability": [ |
There was a problem hiding this comment.
No body can read it, as it does not have "x-ms-mutability" as "read"?
visingla-ms
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
tadelesh
approved these changes
May 26, 2023
This was referenced May 26, 2023
This was referenced Jun 9, 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)
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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.