Release app microsoft.app 2024 03 01 #28571
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
…o version 2024-03-01
#28369) * fix * fix * fix * update readme * add sdk-suppressions.yaml --------- Co-authored-by: Alancere <804873052@qq.com>
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.7) | new version | base version |
|---|---|---|
| AuthConfigs.json | 2024-03-01(566baab) | 2023-05-01(main) |
| AuthConfigs.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| AvailableWorkloadProfiles.json | 2024-03-01(566baab) | 2023-05-01(main) |
| AvailableWorkloadProfiles.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| BillingMeters.json | 2024-03-01(566baab) | 2023-05-01(main) |
| BillingMeters.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| CommonDefinitions.json | 2024-03-01(566baab) | 2023-05-01(main) |
| CommonDefinitions.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ConnectedEnvironments.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ConnectedEnvironments.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ConnectedEnvironmentsCertificates.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ConnectedEnvironmentsCertificates.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ConnectedEnvironmentsDaprComponents.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ConnectedEnvironmentsDaprComponents.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ConnectedEnvironmentsStorages.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ConnectedEnvironmentsStorages.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ContainerApps.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ContainerApps.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ContainerAppsRevisions.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ContainerAppsRevisions.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| Diagnostics.json | 2024-03-01(566baab) | 2023-05-01(main) |
| Diagnostics.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| Global.json | 2024-03-01(566baab) | 2023-05-01(main) |
| Global.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| Jobs.json | 2024-03-01(566baab) | 2023-05-01(main) |
| Jobs.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ManagedEnvironments.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ManagedEnvironments.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ManagedEnvironmentsDaprComponents.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ManagedEnvironmentsDaprComponents.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| ManagedEnvironmentsStorages.json | 2024-03-01(566baab) | 2023-05-01(main) |
| ManagedEnvironmentsStorages.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| SourceControls.json | 2024-03-01(566baab) | 2023-05-01(main) |
| SourceControls.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| Subscriptions.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
| Usages.json | 2024-03-01(566baab) | 2023-11-02-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 5 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2024-03 | package-2024-03(566baab) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Missing identifier id in array item property Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L620 |
||
| The summary and description values should not be same. Location: Microsoft.App/stable/2024-03-01/Diagnostics.json#L536 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/stable/2024-03-01/ManagedEnvironments.json#L1263 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/stable/2024-03-01/ManagedEnvironments.json#L1267 |
||
| 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/stable/2024-03-01/ManagedEnvironments.json#L1271 |
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/stable/2024-03-01/AuthConfigs.json#L18 |
|
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/stable/2024-03-01/AuthConfigs.json#L67 |
|
The resource name parameter 'authConfigName' should be defined with a 'pattern' restriction. Location: Microsoft.App/stable/2024-03-01/AuthConfigs.json#L67 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.App/stable/2024-03-01/AuthConfigs.json#L119 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/AuthConfigs.json#L245 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/AuthConfigs.json#L277 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/AuthConfigs.json#L555 |
|
Property name should be camel case. Location: Microsoft.App/stable/2024-03-01/AuthConfigs.json#L601 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.App/stable/2024-03-01/BillingMeters.json#L16 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.App/stable/2024-03-01/BillingMeters.json#L37 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L281 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L412 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L435 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L497 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L497 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L497 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L518 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L522 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L526 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L606 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L606 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.App/stable/2024-03-01/CommonDefinitions.json#L606 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/stable/2024-03-01/ConnectedEnvironments.json#L100 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/stable/2024-03-01/ConnectedEnvironments.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/stable/2024-03-01/ConnectedEnvironments.json#L208 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/stable/2024-03-01/ConnectedEnvironments.json#L255 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/stable/2024-03-01/ConnectedEnvironments.json#L311 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsCertificates.json#L18 |
|
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsCertificates.json#L68 |
|
The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.App/stable/2024-03-01/ConnectedEnvironmentsCertificates.json#L68 |
️❌Avocado: 1 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.App/connectedEnvironments/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/app/resource-manager/readme.md json: Microsoft.App/stable/2022-10-01/ConnectedEnvironments.json |
| The JSON file has a circular reference. readme: specification/app/resource-manager/readme.md json: Microsoft.App/stable/2024-03-01/CommonDefinitions.json |
️️✔️SwaggerAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
new-api-version
resource-manager
WaitForARMFeedback
This was referenced Apr 3, 2024
Closed
gary-x-li
reviewed
Apr 12, 2024
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectorProperties/{apiName}": { |
There was a problem hiding this comment.
it is same with previous api version. I do not want to change it, which will cause breaking change.
There was a problem hiding this comment.
you have used the : "2023-05-01" as the base api version for this PR , and this api was not present there.
Can you please clarify which previous api version are you talking about ? and why is that not used as the base commit for this PR ?
gary-x-li
reviewed
Apr 12, 2024
| "type": "object", | ||
| "properties": { | ||
| "enabled": { | ||
| "type": "boolean", |
There was a problem hiding this comment.
ARM recommends enums over booleans for future proof APIs. Standard guidance is: replace boolean/switch properties with a more meaningful enum whenever possible.
A boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType]. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].
There was a problem hiding this comment.
it is the same with previous api version.
|
Also, please fill out the Purpose of this PR and Due diligence checklist sections. |
gary-x-li
added
the
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
This is our feature branch and all saparated PRs are get reviewed beofore. |
Juliehzl
added
the
WaitForARMFeedback
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
raosuhas
reviewed
Apr 16, 2024
| "application/json" | ||
| ], | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/providers/Microsoft.App/getCustomDomainVerificationId": { |
There was a problem hiding this comment.
it is a Post call in our backend and already be there in previous api version 2023-05-02-preview #24286
|
Please respond to this comment as well : |
Could you share the PR where the comments I made were reviewed ? |
raosuhas
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
Juliehzl
added
the
WaitForARMFeedback
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
|
Signing off on these since the changes have already been approved in a previous iteration. |
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
/pr RequestMerge |
raosuhas
approved these changes
Apr 18, 2024
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
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.