[Microsoft.App] add java agent related properties #28192
Merged
Conversation
This file contains hidden or 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 |
|---|---|---|
| ContainerApps.json | 2024-02-02-preview(305cfdc) | 2023-05-01(main) |
| ContainerApps.json | 2024-02-02-preview(305cfdc) | 2023-11-02-preview(main) |
️⚠️LintDiff: 2 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-preview-2024-02 | package-preview-2024-02(305cfdc) | 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#L897 |
||
| 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/ContainerApps.json#L901 |
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/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 |
|
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#L333 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L345 |
|
customHostname is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L352 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L397 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L443 |
|
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L444 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L475 |
|
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#L537 |
|
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#L596 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L781 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L781 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L781 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L781 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L813 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L813 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/preview/2024-02-02-preview/ContainerApps.json#L813 |
️️✔️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
|
This was referenced Mar 11, 2024
Contributor
|
/rerun |
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
Contributor
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
yiliuTo
reviewed
Mar 12, 2024
specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json
Outdated
Show resolved
Hide resolved
specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json
Outdated
Show resolved
Hide resolved
bowen5
reviewed
Mar 12, 2024
AzureRestAPISpecReview
added
ARMReview
WaitForARMFeedback
raosuhas
reviewed
Mar 15, 2024
specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json
Show resolved
Hide resolved
raosuhas
reviewed
Mar 15, 2024
| "type": "object", | ||
| "properties": { | ||
| "enabled": { | ||
| "description": "Enable java agent injection for the java app.", |
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
thx for your feedback. It's intended to keep consistent with the enableMetrics property which is also boolean.
|
Looks like there are few warnings in the Lint diff , I have pointed them out above. : https://github.com/Azure/azure-rest-api-specs/pull/28192/checks?check_run_id=22694542007 The avoid nested properties is up to you based on how you want the SDK to look. The other 2 are recommended to be fixed |
|
Please address or respond to feedback from the ARM API reviewer. |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ms-zhenhua
added
ARMSignedOff
bowen5
approved these changes
Mar 22, 2024
fangjian0423
merged commit 719fbfe
into
Azure:release-app-Microsoft.App-2024-02-02-preview
howang-ms
reviewed
Apr 2, 2024
| "enableMetrics": true, | ||
| "javaAgent": { | ||
| "enabled": true, | ||
| "logLevelSettings": [ |
Contributor
There was a problem hiding this comment.
Since this more than logLevel , should we call it logSettings extendibility?
Contributor
Author
There was a problem hiding this comment.
hi @howang-ms , current design is aslo extendibility. When adding some new settings, the payload will looks like:
{
"enabled": true,
"logLevelSettings": [
{
"logger": "org.springframework.boot",
"level": "debug"
}
],
"logXXXSettings": {
"sth": "sth"
}
}
Juliehzl
pushed a commit
to Juliehzl/azure-rest-api-specs
that referenced
this pull request
Jun 4, 2024
* 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
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
8 participants
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
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
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.