feat: add batch size option to certificate retirement API call

[ttak-apphelix]

Overview:

Adds optional batching support to the retired-user certificate cleanup Jenkins script by allowing the retire_certs_s3 API call to be parameterized with a batch_size query param.

Changes:

Extend call_retire_certs_api(...) to accept an optional batch_size and include it in request params when set.
Update the Click CLI to accept a --batch-size argument.
Change --dry-run from a boolean flag

JIRA ticket:

• https://2u-internal.atlassian.net/browse/BOMS-488

Related PR:

• feat: Add batch size parameter to retire_certs_s3 for incremental processing edx-arch-experiments#1203
• feat: add DRY_RUN and BATCH_SIZE parameters to RetireCertificates job and check_retire_users script jenkins-job-dsl#1841
• https://github.com/edx/edx-internal/pull/14343

[Copilot]

Pull request overview

Adds optional batching support to the retired-user certificate cleanup Jenkins script by allowing the retire_certs_s3 API call to be parameterized with a batch_size query param.

Changes:

• Extend call_retire_certs_api(...) to accept an optional batch_size and include it in request params when set.
• Update the Click CLI to accept a --batch-size argument.
• Change --dry-run from a boolean flag to a string option and parse it into a boolean.

Comments suppressed due to low confidence (1)

util/jenkins/retired_user_cert_remover/retired_user_cert_remover.py:142

• --batch-size accepts negative integers, and if batch_size: will then include a negative value in the request params. If the API expects a non-negative limit, enforce it at the CLI level (e.g., type=click.IntRange(min=0)) and/or guard with if batch_size > 0: before adding the param.

@click.option('--dry-run', default='true', help='Run in dry-run mode without making any changes (true/false)')
@click.option('--batch-size', default=0, type=int, help='Max certificates to process per run (0 = no limit)')

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.