Skip to content

feat: backwards compatibility of max runs#3158

Open
grutt wants to merge 6 commits intomainfrom
fix--worker-max-runs-backwards-compatibility
Open

feat: backwards compatibility of max runs#3158
grutt wants to merge 6 commits intomainfrom
fix--worker-max-runs-backwards-compatibility

Conversation

@grutt
Copy link
Contributor

@grutt grutt commented Mar 4, 2026

Description

Multislot changed an api signature for workers, this reverts that change but marks these fields as deprecated

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Copilot AI review requested due to automatic review settings March 4, 2026 20:24
@vercel
Copy link

vercel bot commented Mar 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hatchet-docs Ready Ready Preview, Comment Mar 15, 2026 3:53pm

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restores backward compatibility for the worker “max runs” fields by reintroducing maxRuns / availableRuns into the Worker API schema as deprecated fields, while keeping the newer slotConfig model as the preferred representation. It then regenerates client SDKs and bumps SDK versions to ship the updated contract.

Changes:

  • Add deprecated maxRuns and availableRuns back to the Worker schema in the OpenAPI contract (and generated types).
  • Update API transformers to populate these deprecated fields from slotConfig / legacy worker.MaxRuns.
  • Regenerate SDK clients (TS/Python/Ruby) and bump patch versions + changelogs.

Reviewed changes

Copilot reviewed 15 out of 20 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
api-contracts/openapi/components/schemas/worker.yaml Adds deprecated maxRuns / availableRuns to Worker schema.
api/v1/server/oas/transformers/worker.go Populates deprecated run fields in Worker transformer.
api/v1/server/oas/transformers/v1/worker.go Same as above for v1 transformer variant.
api/v1/server/oas/gen/openapi.gen.go Regenerated OpenAPI server types/spec blob to include new fields.
pkg/client/rest/gen.go Regenerated Go REST client models to include deprecated fields.
frontend/app/src/lib/api/generated/data-contracts.ts Regenerated frontend API types to include deprecated fields.
sdks/typescript/src/clients/rest/generated/data-contracts.ts Regenerated TS SDK API types (Worker adds deprecated fields).
sdks/typescript/src/clients/rest/generated/http-client.ts Regenerated TS SDK HTTP client code.
sdks/typescript/src/clients/rest/generated/Api.ts Regenerated TS SDK API client wrapper.
sdks/typescript/package.json Bumps TS SDK version to 1.15.1.
sdks/typescript/CHANGELOG.md Adds 1.15.1 changelog entry.
sdks/python/hatchet_sdk/clients/rest/models/worker.py Adds deprecated fields to Python Worker model.
sdks/python/pyproject.toml Bumps Python SDK version to 1.28.1.
sdks/python/poetry.lock Regenerated Python lockfile.
sdks/python/CHANGELOG.md Adds 1.28.1 changelog entry.
sdks/ruby/src/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/models/worker.rb Adds deprecated fields to Ruby Worker model.
sdks/ruby/src/lib/hatchet/version.rb Bumps Ruby SDK version to 0.2.1.
sdks/ruby/src/lib/hatchet/clients/rest/lib/hatchet-sdk-rest/version.rb Bumps Ruby REST client version to 0.0.2.
sdks/ruby/src/Gemfile.lock Updates lockfile for Ruby SDK version bump.
sdks/ruby/examples/Gemfile.lock Updates examples lockfile for Ruby SDK version bump.
sdks/ruby/src/CHANGELOG.md Adds 0.2.1 changelog entry.

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

You can also share your feedback on Copilot code review. Take the survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants