Skip to content
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

Merged
merged 1 commit into from
Jun 26, 2023

Conversation

anandanthony
Copy link
Contributor

@anandanthony anandanthony commented Jun 12, 2023

ARM API Information (Control Plane)

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[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 to schedule does not impact customers since this was never the correct enum trigger value. In this PR we are aiming to fix this incorrect value.

@openapi-workflow-bot
Copy link

Hi, @anandanthony Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 12, 2023

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    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
    ⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
    Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L145
    ⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
    Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L209
    ⚠️ ListInOperationName 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
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L678
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L690
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.App/preview/2022-11-01-preview/Jobs.json#L812
    ⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
    Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L140
    ⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
    Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L203
    ⚠️ ListInOperationName 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
    ⚠️ GetInOperationName '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
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L690
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L702
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.App/preview/2023-04-01-preview/Jobs.json#L721
    ⚠️ AvoidNestedProperties 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 12, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/appcontainers/armappcontainers - Approved - 2.0.0-beta.4
    +	Function `*JobsClient.BeginStopMultipleExecutions` parameter(s) have been changed from `(context.Context, string, string, JobExecutionNamesCollection, *JobsClientBeginStopMultipleExecutionsOptions)` to `(context.Context, string, string, *JobsClientBeginStopMultipleExecutionsOptions)`
    +	`TriggerTypeScheduled` from enum `TriggerType` has been removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-appcontainers - Approved - 3.0.0b1
    +	Operation JobsOperations.begin_stop_multiple_executions no longer has parameter job_execution_name
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1f9b94d. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh] notice
      cmderr	[automation_generate.sh]  New minor version of npm available! 9.5.1 -> 9.7.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-appcontainers [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation ContainerAppsOperations.begin_start
      info	[Changelog]   - Added operation ContainerAppsOperations.begin_stop
      info	[Changelog]   - Added operation group ContainerAppsAPIClientOperationsMixin
      info	[Changelog]   - Model AzureCredentials has a new parameter kind
      info	[Changelog]   - Model Configuration has a new parameter service
      info	[Changelog]   - Model GithubActionConfiguration has a new parameter github_personal_access_token
      info	[Changelog]   - Model JobConfiguration has a new parameter event_trigger_config
      info	[Changelog]   - Model ManagedEnvironment has a new parameter peer_authentication
      info	[Changelog]   - Model Replica has a new parameter init_containers
      info	[Changelog]   - Model Replica has a new parameter running_state
      info	[Changelog]   - Model Replica has a new parameter running_state_details
      info	[Changelog]   - Model ReplicaContainer has a new parameter running_state
      info	[Changelog]   - Model ReplicaContainer has a new parameter running_state_details
      info	[Changelog]   - Model Revision has a new parameter running_state
      info	[Changelog]   - Model Template has a new parameter service_binds
      info	[Changelog]   - Model Template has a new parameter termination_grace_period_seconds
      info	[Changelog]   - Model Volume has a new parameter mount_options
      info	[Changelog]   - Model VolumeMount has a new parameter sub_path
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Operation JobsOperations.begin_stop_multiple_executions no longer has parameter job_execution_name
    ️🔄 azure-sdk-for-java inProgress [Detail]
    ️🔄 azure-sdk-for-go inProgress [Detail]
    ️🔄 azure-sdk-for-js inProgress [Detail]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1f9b94d. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 1f9b94d. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • Az.app.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.app.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 12, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.App https://apiview.dev/Assemblies/Review/dca36052ec464f449d2416d96e8a7f73
    Go sdk/resourcemanager/appcontainers/armappcontainers https://apiview.dev/Assemblies/Review/a211b8ceeb934fdb83e6b4d2545a99bf
    Java azure-resourcemanager-appcontainers https://apiview.dev/Assemblies/Review/267468d0e35e43bbadfead58b9cf398a
    JavaScript @azure/arm-appcontainers https://apiview.dev/Assemblies/Review/18a061d83cc643d5bb6226fe88683c35

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 12, 2023
    @openapi-workflow-bot
    Copy link

    Hi, @anandanthony your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @v-xuto
    Copy link
    Member

    v-xuto commented Jun 13, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Jun 13, 2023
    @openapi-workflow-bot
    Copy link

    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.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @v-xuto
    Copy link
    Member

    v-xuto commented Jun 13, 2023

    @JeffreyRichter Please help review the breaking change in this PR.

    @JeffreyRichter
    Copy link
    Member

    You have to justify the breaking change.

    @zizw123
    Copy link

    zizw123 commented Jun 13, 2023

    Please remove ARMChangesReuqested label and continue ARM review once the breaking change has been approved. Thanks.

    @zizw123 zizw123 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jun 13, 2023
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 13, 2023
    @v-xuto
    Copy link
    Member

    v-xuto commented Jun 15, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @v-xuto
    Copy link
    Member

    v-xuto commented Jun 15, 2023

    You have to justify the breaking change.

    @anandanthony Please explain it.

    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jun 19, 2023
    @anandanthony
    Copy link
    Contributor Author

    You have to justify the breaking change.

    @anandanthony Please explain it.

    @v-xuto discussed on the change in the 'Breaking Chance' office hours. The enum value was always incorrect (Scheduled) and does not match with the value in the RP (Schedule).

    @v-xuto v-xuto removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jun 20, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 20, 2023
    @ms-henglu ms-henglu added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 20, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 20, 2023
    @v-xuto
    Copy link
    Member

    v-xuto commented Jun 20, 2023

    @raych1 Please help review Go breaking change.
    @msyyc Please help review Python breaking change.

    @v-xuto
    Copy link
    Member

    v-xuto commented Jun 20, 2023

    Confirmed no JS SDK breaking change.

    @v-xuto
    Copy link
    Member

    v-xuto commented Jun 21, 2023

    @raych1 Please help review Go breaking change.

    @raych1 raych1 added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jun 26, 2023
    @v-xuto v-xuto self-requested a review June 26, 2023 04:25
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript FixS360 resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    10 participants