ContainerAppsBuild and ContainerAppsPatch API #27982
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
Next Steps to Merge✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| Compared specs (v0.10.5) | new version | base version |
|---|---|---|
| CommonDefinitions.json | 2024-02-02-preview(7f862d5) | 2023-05-01(main) |
| CommonDefinitions.json | 2024-02-02-preview(7f862d5) | 2023-11-02-preview(main) |
| ContainerApps.json | 2024-02-02-preview(7f862d5) | 2023-05-01(main) |
| ContainerApps.json | 2024-02-02-preview(7f862d5) | 2023-11-02-preview(main) |
️⚠️LintDiff: 7 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-preview-2024-02 | package-preview-2024-02(7f862d5) | package-preview-2024-02(release-app-Microsoft.App-2024-02-02-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L738 |
||
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.App/preview/2024-02-02-preview/ContainerAppsBuilds.json#L36 |
RPC-Get-V1-11 | |
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json#L36 |
RPC-Get-V1-11 | |
| Use the latest version v5 of types.json. Location: Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json#L323 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json#L397 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2024-02-02-preview/ContainerAppsPatches.json#L416 |
||
| 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/2024-02-02-preview/ContainerAppsPatches.json#L526 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L293 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L428 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L451 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L513 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L513 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L513 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L534 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L538 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L542 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L622 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L622 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L622 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L639 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1063 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1110 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/CommonDefinitions.json#L1555 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L99 |
|
GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L100 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L131 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L198 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L224 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L267 |
|
Properties of a PATCH request body must not be required, property:location. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L307 |
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L307 |
|
Properties of a PATCH request body must not have default value, property:activeRevisionsMode. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L307 |
|
Properties of a PATCH request body must not have default value, property:transport. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L307 |
|
Properties of a PATCH request body must not be required, property:allowedOrigins. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L307 |
|
Properties of a PATCH request body must not have default value, property:appProtocol. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L307 |
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L307 |
|
Properties of a PATCH request body must not have default value, property:maxReplicas. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L307 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
harryli0108
changed the title
AzureRestAPISpecReview
added
ARMReview
resource-manager
WaitForARMFeedback
This was referenced Feb 29, 2024
ms-zhenhua
reviewed
Mar 1, 2024
| @@ -728,6 +731,10 @@ | |||
| "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileName", | |||
| "description": "Workload profile name to pin for container app execution." | |||
| }, | |||
| "s2CAutoPatchConfiguration": { | |||
There was a problem hiding this comment.
consider using enum instead of boolean:
https://github.com/Azure/azure-openapi-validator/blob/main/docs/enum-instead-of-boolean.md #Resolved
| }, | ||
| "readOnly": true | ||
| }, | ||
| "PatchProperties": { |
There was a problem hiding this comment.
please add description for PatchProperties #Resolved
| }, | ||
| "newLayer": { | ||
| "type": "object", | ||
| "properties": { |
There was a problem hiding this comment.
Consider using x-ms-client-flatten for nested properties: https://github.com/Azure/azure-openapi-validator/blob/main/docs/avoid-nested-properties.md
There was a problem hiding this comment.
I don't think you want to use flatten here - your newLayer and oldLayer property names will collide if you do.
| }, | ||
| "oldLayer": { | ||
| "type": "object", | ||
| "properties": { |
There was a problem hiding this comment.
Consider using x-ms-client-flatten for nested properties: https://github.com/Azure/azure-openapi-validator/blob/main/docs/avoid-nested-properties.md
There was a problem hiding this comment.
I don't think you want to use flatten here - your newLayer and oldLayer property names will collide if you do.
| } | ||
| } | ||
| }, | ||
| "delete": { |
There was a problem hiding this comment.
why is put not supported? how is this resource created?
There was a problem hiding this comment.
Sure thing!
For both ContainerAppsBuilds and ContainerAppsPatches, the proxy resources are created by services ourselves. ContainerAppsBuilds are created when user uploads a file to the upload endpoint of container app, ContainerAppsPatches are created when the control plane retrieves new detected vulnerability reports generated in data plane.
ContainerAppsPatches allow users to interact with it by applying, skipping, or deleting a patch. ContainerAppsBuilds is a representation of the image-building process when users upload their files to the specific container app.
There was a problem hiding this comment.
Is there any reason you couldn't use PUT of this type instead of (or in addition to) the other "upload" API/process to create the build? That would be a more ARM-like model.
There was a problem hiding this comment.
Unfortunately, the /upload is the only way to trigger the creation of this proxy resource. Reason being the build is more of a service that automatically gets triggered when users upload their source codes.
Similarly, patches are not created by user, but created when provider detected new potential patches the users can apply.
fyi, this type of design was introduced and approved in the past in #25446. We're aiming to add patching back specified in that PR, but move it under Microsoft.app/containerApps rather than Microsoft.App/builders. Meanwhile, we decided to adopt this design since ContainerAppsBuilds gets created and managed in a very similar fashion.
| } | ||
| } | ||
| }, | ||
| "delete": { |
There was a problem hiding this comment.
why is put not supported? how is this resource created?
There was a problem hiding this comment.
addressed in another comment
There was a problem hiding this comment.
See question in the other comment.
There was a problem hiding this comment.
addressed in the other comment
ms-zhenhua
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
|
Providing contexts for future reviewers: For both ContainerAppsBuilds and ContainerAppsPatches, the proxy resources are created by services ourselves. ContainerAppsBuilds are created when user uploads a file to the upload endpoint of container app, and ContainerAppsPatches are created when the control plane retrieves new detected vulnerability reports generated in data plane. ContainerAppsPatches allow users to interact with it by applying, skipping, or deleting a patch. ContainerAppsBuilds is a representation of the image-building process when users upload their files to the specific container app. FYI: Patch was once a proxy resource of Microsoft.app/Builders. The design was approved in PR #25446 but reverted before release because RP wasn't ready at the time. |
harryli0108
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
| "type": "string", | ||
| "description": "The name of the target image for the patch.", | ||
| "readOnly": true | ||
| }, |
There was a problem hiding this comment.
I am guessing these are references to azure resources? (I might be wrong... ) Consider instead using full azure resource ids, so that its a flexible API with respect to resource container, like subscription, resource group, management group.
| }, | ||
| "description": "New layer update details in the target image.", | ||
| "readOnly": true, | ||
| "x-ms-client-flatten": true |
| }, | ||
| "description": "The old layer details in the target image.", | ||
| "readOnly": true, | ||
| "x-ms-client-flatten": true |
| "targetEnvironmentId": { | ||
| "format": "arm-id", | ||
| "type": "string", | ||
| "description": "The id of the target environment for the patch." |
| "targetContainerAppId": { | ||
| "format": "arm-id", | ||
| "type": "string", | ||
| "description": "The id of the target container app for the patch." |
| "targetRevisionId": { | ||
| "format": "arm-id", | ||
| "type": "string", | ||
| "description": "The id of the target revision for the patch." |
| "$ref": "#/definitions/PatchProvisioningState", | ||
| "description": "Patch provisioning state.", | ||
| "readOnly": true | ||
| }, |
There was a problem hiding this comment.
I have a doubt about whether its really a provisioning state - is just apply status good enough?
| "description": "The status of the patch operation once it has been provisioned", | ||
| "readOnly": true | ||
| }, | ||
| "createdTime": { |
There was a problem hiding this comment.
consider instead calling 'createdAt'
| "description": "The UTC timestamp that describes when the patch object was created.", | ||
| "readOnly": true | ||
| }, | ||
| "updatedTime": { |
There was a problem hiding this comment.
consider instead calling 'lastModifiedAt'
TimLovellSmith
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
harryli0108
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
…li/add-cloudbuild-cloudpatch
…li/add-cloudbuild-cloudpatch
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
/pr RequestMerge |
raosuhas
approved these changes
Mar 15, 2024
raosuhas
merged commit 18fdfcc
into
release-app-Microsoft.App-2024-02-02-preview
28 checks passed
Juliehzl
pushed a commit
to Juliehzl/azure-rest-api-specs
that referenced
this pull request
Jun 4, 2024
* Added CloudBuild and CloudPatch * Fixed pipeline errors * Added ContainerApp example * Fixed typo in example * Fixed linting error * Fixed spacing * Addressed comments * Addressed comments and modified sample * Fixed linting error * Addressed comments * Linting * Fixed typo * Fixed Typo * Resolving model validation error
mentat9
pushed a commit
that referenced
this pull request
Jun 17, 2024
* Adds base for updating Microsoft.App from version preview/2023-11-02-preview to version 2024-02-02-preview * Updates readme * Updates API version in new specs and examples * Functions Extension endpoint for Web RP (#27873) * Functions extension api-spec commit * merge with latest * Functions Extension in 2024-02-02-preview * correcetd version in readme * avacado fail fix - version * pattern addition * fix for PathForResourceAction * lint diff and model validation checks * AutoRest exception fix * endpoint response as string and not schema * response schema with string * example schema * example within spec * extension example with data * extensions example with body * body as string * [Microsoft.App] add runtime attribute to app configuration (#27892) * add configuration.runtime for apps * Add Nacos For Java Component. (#28045) * Add Nacos For Java Component. * fix spell check. * [Container Apps] Update Runtime to add DotNet support (#28001) * [Container Apps] Update Runtime to add DotNet support * Remove default value * Rename dotNet to dotnet * [Container Apps] Remove AspireResourceServerApi type for DotNetComponent (#28005) * [Container Apps] Remove AspireResourceServerApi type for DotNetComponent * Only keep changes to 2024-02-02-preview * [ContainerApp] Support peer traffic encryption. (#28129) * Make the JavaComponent definitions polymorphism and expose fqdn for sba and eureka (#28102) * Make the JavaComponent definitions polymorphism * fix api version * revert error response change * refine examples * fix default value * fix * fix * try to remove required * try remove require in patch body * fix * try fix lint * fix * add suppression for discriminator * fix --------- Co-authored-by: Xuyang Cao <[email protected]> * ContainerAppsBuild and ContainerAppsPatch API (#27982) * Added CloudBuild and CloudPatch * Fixed pipeline errors * Added ContainerApp example * Fixed typo in example * Fixed linting error * Fixed spacing * Addressed comments * Addressed comments and modified sample * Fixed linting error * Addressed comments * Linting * Fixed typo * Fixed Typo * Resolving model validation error * [Microsoft.App] add java agent related properties (#28192) * add java agent related properties * fix build error * fix format * re-run pipeline * update enum list and fix typo * revert cspell config * update level field type from enum to string * add identifiers for array prop * Fix error response for aca (#28425) * fix * fix * Adding identity for scale rules (#28283) * Adding identity for scale rules * fix scale example * Fix schema issue for Microsoft.App in 2024-02-02-preview (#28454) * fix * fix * fix * fix * fix * fix * Update Container Apps Swagger Schema to include kind property (#28405) * Added support for KIND property to container apps schema * added reference to example request schema * prettier check * changes to example conforming to swagger * used enum for app kind * minor fixes * merged main * Revert "merged main" This reverts commit 2437d60. * fixed checks * Add detailed job execution to api (#27977) * Add detailed job execution to api * Add fields * address comment * add x-ms-identifiers * prettier * address comments * Address comments * Address comments * update example * Fix property name * Fix example * [Microsoft.App] optimize java agent related properties (#28573) * optimize java agent related props * fix * adding logging property to include logger settings --------- Co-authored-by: Bowen Wan <[email protected]> * Add accountName for queueScaler (#28672) * add accountName for queueScaler * updated example * updated * updated * updated * Adding identity settings (#28117) * Adding identity settings * fix casing in examples * Switch to array since ARM doesn't allow dictionaries. * identity property should be required. * prettier * Updating description * Adding Jobs spec * Update specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/Jobs.json Co-authored-by: Jitin John <[email protected]> * Move IdentitySettings to CommonDefinitions --------- Co-authored-by: Jitin John <[email protected]> * Add SessionPools and Sessions (#28047) * Add SessionPools.json and Sessions.json * Add private endpoint connections for managed environment (#28775) * add pe * fix * fix * fix * fix * fix * fix * use v5 * fix * fix * Add support for SMB storage in connectedEnvironment (#29158) * Add support for SMB storage in connectedEnvironment * move smb properties to common * fix reference --------- Co-authored-by: [email protected] <[email protected]> * API spec for LogicApps extension on Microsoft.App (#29083) * API spec for LogicApps extension on Microsoft.App * format * fix typos * fix issues * fix example references * fix more issues * fix issues * fix more model validation * fix * fix model * fix format * fix lintdiff * fix example * fix headers * add delete * add missing file --------- Co-authored-by: Anand G Menon <[email protected]> * Add publicNetworkAccess in managed environment (#29092) * fix * fix * fix example * fix lint * revert previous change for patch * fix go sdk duplicate schema * fix go sdk duplicate schema * fix billing meter * fix billing meter --------- Co-authored-by: Jitin John <[email protected]> Co-authored-by: SushmithaVReddy <[email protected]> Co-authored-by: sonwan2020 <[email protected]> Co-authored-by: Xiangyang Yu <[email protected]> Co-authored-by: daniv-msft <[email protected]> Co-authored-by: Xuyang Cao <[email protected]> Co-authored-by: Xuyang Cao <[email protected]> Co-authored-by: Harry Li <[email protected]> Co-authored-by: Jimmy Fang <[email protected]> Co-authored-by: Vaclav Turecek <[email protected]> Co-authored-by: Shubham Sachdeva <[email protected]> Co-authored-by: lihaMSFT <[email protected]> Co-authored-by: Bowen Wan <[email protected]> Co-authored-by: njucz <[email protected]> Co-authored-by: yitaopan <[email protected]> Co-authored-by: anandgmenon <[email protected]> Co-authored-by: [email protected] <[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 (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.