Container Apps Jobs Execution History - Refactor #22844
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
|
Swagger pipeline can not start as the pull request has merge conflicts. |
|
Hi, @tdaroly 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 pipeline can not start as the pull request has merge conflicts. |
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
tdaroly
changed the base branch from
release-app-2022-11-01-preview
to
release-app-Microsoft.App-2022-11-01-preview
Swagger Validation Report
|
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(3dabdcf) | 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] |
|---|---|---|
| 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 |
||
| 'GET' operation 'Job_Executions' should use method name 'Get' or Method name start with 'List'. 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 |
||
| 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#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 |
|
| 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#L598 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L744 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L804 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L806 |
️️✔️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.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @tdaroly, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Mar 1, 2023
jijohn14
reviewed
Mar 1, 2023
| @@ -560,14 +560,6 @@ | |||
| "$ref": "#/definitions/ContainerAppJobExecutions" | |||
| } | |||
| }, | |||
| "202": { | |||
There was a problem hiding this comment.
Also, rename example as [Job_Executions_Get.json](https://github.com/Azure/azure-rest-api-specs/blob/release-app-Microsoft.App-2022-11-01-preview/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Executions.json)
jijohn14
approved these changes
Mar 1, 2023
anandanthony
approved these changes
Mar 1, 2023
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.