-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add job support #28044
Add job support #28044
Conversation
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 |
---|---|---|
appplatform.json | 2024-05-01-preview(f913577) | 2023-12-01(main) |
appplatform.json | 2024-05-01-preview(f913577) | 2024-01-01-preview(main) |
️⚠️
LintDiff: 4 Warnings warning [Detail]
Compared specs (v2.2.0) | new version | base version |
---|---|---|
package-preview-2024-05 | package-preview-2024-05(f913577) | package-preview-2024-05(dev-appplatform-Microsoft.AppPlatform-2024-05-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
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#L9071 |
||
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#L9173 |
||
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#L9221 |
||
Missing identifier id in array item property Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L15901 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutResponseCodes |
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 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L105 |
DeleteResponseCodes |
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 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L158 |
UnSupportedPatchProperties |
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 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L202 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:frequency. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L202 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:name. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L202 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:tier. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L202 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L214 |
PostResponseCodes |
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 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L431 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L434 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L438 |
PostResponseCodes |
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 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L479 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L482 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L486 |
PostResponseCodes |
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 |
PostResponseCodes |
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 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1007 |
EvenSegmentedPathForPutOperation |
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 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1049 |
EvenSegmentedPathForPutOperation |
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 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1219 |
ProvisioningStateSpecifiedForLROPut |
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 |
PutResponseCodes |
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 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1298 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:uri. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1345 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json#L1357 |
️️✔️
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
|
b9ba016
to
27cd2d5
Compare
"description": "Collection of resources.", | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/definitions/Secret" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where's this defined?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's using existing model Secret.
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Outdated
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Outdated
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Outdated
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Outdated
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Outdated
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Outdated
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Outdated
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Show resolved
Hide resolved
...urce-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/examples/JobExecution_Get.json
Show resolved
Hide resolved
}, | ||
"properties": { | ||
"description": "Job's execution properties.", | ||
"$ref": "#/definitions/JobExecutionProperties" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the difference between the job.properties.template.env
, jobExecution.properties.template.env
and jobExecution.jobSnapshot.template.env
? as well as the args...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One follow question, what if the execution only return the snapshot with applied data. Then from API version, it is clear to show what is the env, arg the execution really take, we don't need to explain the priority.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As offline synced, will return the real applied data from backend. No change in swagger model.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am confused about that, why the swagger model no need to be changed?
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Outdated
Show resolved
Hide resolved
...pplatform/resource-manager/Microsoft.AppPlatform/preview/2024-05-01-preview/appplatform.json
Show resolved
Hide resolved
3bf41e8
into
Azure:dev-appplatform-Microsoft.AppPlatform-2024-05-01-preview
* Adds base for updating Microsoft.AppPlatform from version preview/2024-01-01-preview to version 2024-05-01-preview * Updates readme * Updates API version in new specs and examples * Update language readme (#27911) * Update readme.go.md * Update readme.python.md * add 'enablePrivateLinks' to ServiceResource.properties.vnetAddons (#27966) * add 'enablePrivateLinks' to ServiceResource.properties.vnetAddons * fix comment * Support service mi for Azure Spring Apps in api 2024-05-01-preview (#27989) * feat: support mi for Spring Apps * fix comments --------- Co-authored-by: Frank Liu <[email protected]> * Add 'privateDnsZoneId' to ServiceResource.properties.vnetAddons (#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]> * Add job support (#28044) * update typescript.md for sapvirtualinstance (#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]> * Rename the 'privateLinkState' as 'privateStorageAccess' (#28293) * add 'enablePrivateLinks' to ServiceResource.properties.vnetAddons * fix comment * rename as 'privateStorageAccess' * remove default value * Add config server support in enterprise tier (#28212) * 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]> * add build settings API (#28103) * 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]> * Move ResourceRequest to JobExecutionTemplate (#28318) * revert build setting resource (#28337) * refine comments (#28377) --------- Co-authored-by: Zhe Li <[email protected]> Co-authored-by: Zhe Li <[email protected]> Co-authored-by: Frank Liu <[email protected]> Co-authored-by: Frank Liu <[email protected]> Co-authored-by: Wenhao Zhang <[email protected]> Co-authored-by: Wenhao Zhang <[email protected]> Co-authored-by: ninpan-ms <[email protected]> Co-authored-by: ZiWei Chen <[email protected]> Co-authored-by: sophiaso <[email protected]> Co-authored-by: Qingyi Liu <[email protected]>
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section 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 ApiView
comment 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 PR
andDue diligence checklist
.Next Steps to Merge
comment. 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.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.