Add container apps job specs#21916
Merged
leniatgh merged 33 commits intoAzure:release-app-Microsoft.App-2022-11-01-previewfrom Feb 6, 2023
Merged
Add container apps job specs#21916leniatgh merged 33 commits intoAzure:release-app-Microsoft.App-2022-11-01-previewfrom
leniatgh merged 33 commits intoAzure:release-app-Microsoft.App-2022-11-01-previewfrom
Conversation
|
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 swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| CommonDefinitions.json | 2022-11-01-preview(0a28508) | 2022-10-01(main) |
| CommonDefinitions.json | 2022-11-01-preview(0a28508) | 2022-06-01-preview(main) |
️⚠️LintDiff: 23 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(0a28508) | 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#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 |
RPC-Async-V1-06 | |
| 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 |
||
| 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#L392 |
||
| OperationId should contain the verb: 'stop' in:'Job_terminate'. Consider updating the operationId Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L392 |
||
| 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#L393 |
||
| 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#L449 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L595 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L655 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L657 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L678 |
|
| 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/preview/2022-11-01-preview/CommonDefinitions.json#L687 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L851 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L854 |
|
| 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/preview/2022-11-01-preview/CommonDefinitions.json#L923 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L981 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L984 |
️️✔️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
|
This was referenced Dec 16, 2022
This was referenced Dec 16, 2022
jijohn14
reviewed
Dec 17, 2022
...ication/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/ContainerAppsJobs.json
Outdated
Show resolved
Hide resolved
...nager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerAppsJob_CreateorUpdate.json
Outdated
Show resolved
Hide resolved
...resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerAppsJob_Run.json
Outdated
Show resolved
Hide resolved
...ce-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerAppsJob_Terminate.json
Outdated
Show resolved
Hide resolved
...ication/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/ContainerAppsJobs.json
Outdated
Show resolved
Hide resolved
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @anandanthony, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
mentat9
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
11 tasks
anthonychu
reviewed
Jan 11, 2023
Member
anthonychu
left a comment
anthonychu
left a comment
There was a problem hiding this comment.
@anandanthony A couple of small comments.
...ication/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/ContainerAppsJobs.json
Show resolved
Hide resolved
| "replicaTimeout": 10, | ||
| "replicaRetryLimit": 10, | ||
| "manualTriggerConfig": { | ||
| "replicaCount": 1, |
Member
There was a problem hiding this comment.
replicaCount should be >= parallelism
Contributor
Author
There was a problem hiding this comment.
@anthonychu this was modified as per the following suggestion - https://github.com/Azure/azure-rest-api-specs/pull/21846/files/feaac967641b198543cd57b4fb2644b3b3a80a18#r1048685332
@trajkobal requesting your input on this.
Contributor
There was a problem hiding this comment.
It can go both ways.
- If the replica count (completions) is less than parallelism (e.g. you execute 2 parallel replicas and only need one of them to complete, then the job is done when one replica finishes. This is more like providing redundancy.
- If the replica count is more than parallelism then it will repeat replica count / parallelism number of times. i.e run 10 replicas 2 at a time way
vinisoto
approved these changes
Feb 2, 2023
Contributor
Member
Contributor
Author
|
@tadelesh thank you for your comment, can you please confirm if the version difference in the following files is causing the SDK generation failure? |
Member
I'm not sure it is the only discrepancy, but you could revert it or consolidate them to the new version and see if the SDK generation will pass. |
Contributor
Author
@tadelesh we have reverted the version changes and now the breaking change validation is successful. |
tadelesh
added
the
Approved-SdkBreakingChange-Go
leniatgh
approved these changes
Feb 6, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
10 participants
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.