Add AppPlatform 2024-05-01-preview #28341
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
…4-01-01-preview to version 2024-05-01-preview
* Update readme.go.md * Update readme.python.md
…ure#27966) * add 'enablePrivateLinks' to ServiceResource.properties.vnetAddons * fix comment
…zure#27989) * feat: support mi for Spring Apps * fix comments --------- Co-authored-by: Frank Liu <[email protected]>
…e#28099) * add 'privateDnsZoneId' to ServiceResource.properties.vnetAddons * only allow private dns zone id * test empty private dns zone id * test null private dns zone id * test null private dns id * add private dns id --------- Co-authored-by: Wenhao Zhang <[email protected]>
* update typescript.md for sapvirtualinstance (Azure#27819) * Add job related API * empty line * workload * lint * lint * part * lint * lint * lint * example * change env model * remove addon * prettier * Refine * lint * Add snapshot * add test * fix example * comments * Make job execution resource * remove resource --------- Co-authored-by: ZiWei Chen <[email protected]>
* add 'enablePrivateLinks' to ServiceResource.properties.vnetAddons * fix comment * rename as 'privateStorageAccess' * remove default value
* Support config server in enterprise tier * Add readonly * Update config server delete API Remove 200 and add Location header for 202 response * Add list config servers API * Update delete operation metadata * Add 201 for PUT config server API * fix build failure * fix check errors * do not change response code * fix typo --------- Co-authored-by: ninpan-ms <[email protected]>
* Update appplatform.json * Update appplatform.json * Update appplatform.json * Update appplatform.json * Create BuildSettings_Get.json * Update appplatform.json * Update BuildSettings_Get.json * Create BuildSettings_CreateOrUpdate.json * Update BuildSettings_Get.json * Create BuildSettings_Delete.json * Update BuildSettings_Get.json * Update BuildSettings_CreateOrUpdate.json * Create BuildSettings_List.json * Update appplatform.json * Update appplatform.json * Update appplatform.json * Update appplatform.json * Update appplatform.json * Update appplatform.json * Update appplatform.json * Create BuildSettings_ListSupportedBuildSettingTypes.json * Update BuildSettings_ListSupportedBuildSettingTypes.json * Update appplatform.json * Update BuildSettings_List.json * Update BuildSettings_Get.json * Update BuildSettings_Get.json * Update BuildSettings_CreateOrUpdate.json * Update BuildSettings_Delete.json * Update BuildSettings_List.json * Update appplatform.json * Update appplatform.json * Update appplatform.json * rename file * update * update --------- Co-authored-by: Zhe Li <[email protected]>
|
Hi @haoozhang, this service has enabled ShiftLeft Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth., please review this pull request if it is intentional or reject it if it is not expected. Normally, all the specification or example changes should start with PR created in ADO. |
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.5) | new version | base version |
|---|---|---|
| appplatform.json | 2024-05-01-preview(24de488) | 2023-12-01(main) |
| appplatform.json | 2024-05-01-preview(24de488) | 2024-01-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 1 Errors, 3 Warnings failed [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-preview-2024-05 | package-preview-2024-05(24de488) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L202 |
RPC-Patch-V1-10 |
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobExecutionModel'. Consider using the plural form of 'JobExecution' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L9162 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobExecutionModel'. Consider using the plural form of 'JobExecution' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L9264 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobExecutionModel'. Consider using the plural form of 'JobExecution' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L9312 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
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.AppPlatform/preview/2024-05-01-preview/appplatform.json#L63 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L105 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L134 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L158 |
|
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L197 |
|
Properties of a PATCH request body must not be required, property:frequency. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L202 |
|
Properties of a PATCH request body must not have default value, property:name. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L202 |
|
Properties of a PATCH request body must not have default value, property:tier. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L202 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L214 |
|
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L410 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L431 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L434 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L438 |
|
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L458 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L479 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L482 |
|
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L486 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L641 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L701 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1007 |
|
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1048 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1049 |
|
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1218 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1219 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1262 |
|
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.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1262 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1298 |
|
Properties of a PATCH request body must not be required, property:uri. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1345 |
|
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1357 |
|
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1472 |
️️✔️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.
️️✔️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
|
openapi-workflow-bot
bot
added
the
DoNotMerge
microsoft-github-policy-service
bot
added
the
customer-reported
AzureRestAPISpecReview
added
ARMReview
new-api-version
resource-manager
WaitForARMFeedback
This was referenced Mar 20, 2024
Closed
|
This error is not introduced by current PR: 2024-01-01-preview (previour version):
2024-05-01-preview (current version):
|
ms-zhenhua
reviewed
Mar 21, 2024
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Show resolved
Hide resolved
ms-zhenhua
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
…preview' into dev-appplatform-Microsoft.AppPlatform-2024-05-01-preview
ninpan-ms
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ms-zhenhua
added
Approved-LintDiff
ARMSignedOff
|
/pr RequestMerge |
|
/pr RequestMerge |
This PR has the DoNotMerge tag on it. PLease remove that if you really need it to be merged |
Sneezry
removed
the
DoNotMerge
removed |
raosuhas
approved these changes
Apr 19, 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.