Add specs for start, stop & executions for Container Apps Jobs #22594
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
|
Hi, @anandanthony Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(ee770b2) | package-preview-2022-11(release-app-Microsoft.App-2022-11-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L405 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L463 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L531 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobModel'. Consider using the plural form of 'Job' 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.App/preview/2022-11-01-preview/Jobs.json#L536 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L537 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L25 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L64 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobModel'. Consider using the plural form of 'Job' 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.App/preview/2022-11-01-preview/Jobs.json#L105 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L106 |
|
| The summary and description values should not be same. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L145 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobModel'. Consider using the plural form of 'Job' 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.App/preview/2022-11-01-preview/Jobs.json#L151 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L152 |
|
| The summary and description values should not be same. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L209 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobModel'. Consider using the plural form of 'Job' 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.App/preview/2022-11-01-preview/Jobs.json#L215 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L216 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L266 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobModel'. Consider using the plural form of 'Job' 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.App/preview/2022-11-01-preview/Jobs.json#L272 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L273 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'JobModel'. Consider using the plural form of 'Job' 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.App/preview/2022-11-01-preview/Jobs.json#L336 |
|
| OperationId should contain the verb: 'start' in:'Job_run'. Consider updating the operationId Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L336 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L337 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L469 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L599 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L745 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L805 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L807 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
Swagger Generation Artifacts
|
|
Hi, @anandanthony your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Generated ApiView
|
anandanthony
changed the title
anandanthony
changed the title
vinisoto
reviewed
Feb 14, 2023
| "description": "Job execution status.", | ||
| "type": "string" | ||
| }, | ||
| "startTime": { |
This was referenced Feb 17, 2023
vinisoto
reviewed
Feb 17, 2023
| @@ -430,9 +450,136 @@ | |||
| }, | |||
| "x-ms-examples": { | |||
| "Terminate a Container Apps Job": { | |||
| "$ref": "./examples/Job_Stop.json" | |||
| "$ref": "./examples/Job__Stop_Execution.json" | |||
There was a problem hiding this comment.
@vinisoto yes, it was a typo.. fixed it.
trajkobal
reviewed
Feb 17, 2023
...pp/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Multiple.json
Outdated
Show resolved
Hide resolved
trajkobal
reviewed
Feb 17, 2023
specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json
Outdated
Show resolved
Hide resolved
trajkobal
reviewed
Feb 17, 2023
specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json
Outdated
Show resolved
Hide resolved
trajkobal
reviewed
Feb 17, 2023
specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json
Outdated
Show resolved
Hide resolved
trajkobal
reviewed
Feb 17, 2023
| "final-state-via": "location" | ||
| } | ||
| } | ||
| }, |
There was a problem hiding this comment.
We should also add the stopAll endpoint here and implement it to reduce overhead.
There was a problem hiding this comment.
@trajkobal can we reuse this endpoint? If the customer does not give a payload consisting of the job executions to be stopped, we stop all? I believe we would have to rename the endpoint to "StopAll" just so their is no confusion and the payload will make sense then, that if we have a payload passed we will only stop those job executions.?
OR
we need a seperate endpoint /stopAll? The only concern with that is we would have 3 endpoints just for stop.
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}/stop
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/stop
- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/stopAll
There was a problem hiding this comment.
What would be the difference between these two in this case?:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/stop
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/stopAll
I think it is clearer to have only /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/stop. If a the payload is empty, we stop all executions; and if the payload contains a list of executions, we stop only that ilst.
tdaroly
reviewed
Feb 17, 2023
...n/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Executions.json
Show resolved
Hide resolved
rkmanda
reviewed
Feb 18, 2023
| @@ -349,13 +349,25 @@ | |||
| "type": "string", | |||
| "pattern": "^[-\\w\\._\\(\\)]+$" | |||
| }, | |||
| { | |||
| "name": "template", | |||
There was a problem hiding this comment.
pl check the warnings here and make corrections - https://github.com/Azure/azure-rest-api-specs/pull/22594/checks?check_run_id=11428332921
There was a problem hiding this comment.
@rkmanda we have addressed some of the comments. For the others related to the operation names, the current names best define the operation behavior. Can you please proceed with merging this PR?
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
tdaroly
approved these changes
Feb 20, 2023
leni-msft
merged commit 671716d
into
Azure:release-app-Microsoft.App-2022-11-01-preview
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 API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.