-
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
update trigger type enum - schedule for jobs #24400
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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
Jobs.json | 2022-11-01-preview(75e463b) | 2022-11-01-preview(main) |
Jobs.json | 2023-04-01-preview(75e463b) | 2023-04-01-preview(main) |
Rule | Message |
---|---|
1019 - RemovedEnumValue |
The new version is removing enum value(s) 'Scheduled' from the old version. New: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L654:9 Old: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L654:9 |
1019 - RemovedEnumValue |
The new version is removing enum value(s) 'Scheduled' from the old version. New: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L666:9 Old: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L666:9 |
1020 - AddedEnumValue |
The new version is adding enum value(s) 'Schedule' from the old version. New: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L654:9 Old: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L654:9 |
1020 - AddedEnumValue |
The new version is adding enum value(s) 'Schedule' from the old version. New: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L666:9 Old: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L666:9 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.3) | new version | base version |
---|---|---|
package-preview-2023-04 | package-preview-2023-04(75e463b) | package-preview-2023-04(main) |
package-preview-2022-11 | package-preview-2022-11(75e463b) | package-preview-2022-11(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L179 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L195 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L252 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L318 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L383 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L399 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L447 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L515 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L170 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L186 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L242 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L304 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L364 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L380 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L418 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L472 |
The summary and description values should not be same. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L145 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L209 |
|
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 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L678 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L690 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L812 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L140 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L203 |
|
Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L434 |
|
'GET' operation 'JobExecution' 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/2023-04-01-preview/Jobs.json#L545 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L690 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L702 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L721 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L839 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView 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.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @anandanthony your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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. |
@JeffreyRichter Please help review the |
You have to justify the breaking change. |
Please remove ARMChangesReuqested label and continue ARM review once the breaking change has been approved. Thanks. |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@anandanthony Please explain it. |
@v-xuto discussed on the change in the 'Breaking Chance' office hours. The enum value was always incorrect ( |
Confirmed no JS SDK breaking change. |
@raych1 Please help review Go breaking change. |
ARM API Information (Control Plane)
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.
-[x] 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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.
@v-xuto the change added in this PR to update the trigger type enum value from
scheduled
toschedule
does not impact customers since this was never the correct enum trigger value. In this PR we are aiming to fix this incorrect value.