fix: Mark generated model fields that the API can omit as optional - #979
Closed
apify-service-account wants to merge 2 commits into
Closed
fix: Mark generated model fields that the API can omit as optional#979apify-service-account wants to merge 2 commits into
apify-service-account wants to merge 2 commits into
Conversation
apify-service-account
added
the
t-tooling
Closed
vdusek
changed the title
vdusek
changed the title
vdusek
approved these changes
Jul 28, 2026
Contributor
|
Closing as superseded - this PR no longer carries any changes. Everything it contained has already landed on The conflict was a symptom of a workflow bug rather than a real spec change. The manual regeneration branch ( The underlying issues in ✍️ Drafted by Claude Code |
vdusek
added a commit
that referenced
this pull request
Aug 3, 2026
) Replaces the apify-docs-triggered model regeneration with a nightly job, and records which published OpenAPI specification the generated models came from. ## What changes - **`on_schedule_regenerate_models.yaml`** - nightly at 02:00 UTC plus manual dispatch. Regenerates on master and opens a pull request when the models change. `manual_regenerate_models.yaml` is deleted. - **`scripts/openapi_spec.py`** - downloads and validates the published specification into git-ignored `tmp/` (both codegen passes read that one copy), then records its `info.version` in `pyproject.toml` under `[tool.apify.openapi-spec]`. The specification itself is not committed. - **`_models.py`** loses the `Plan.available_proxy_groups` docstring - accumulated codegen drift from the `datamodel-code-generator` bumps (#968, #975), not a specification change. ## Why The old workflow was dispatched by apify-docs and checked out a permanent, never-rebased branch *before* regenerating, so it generated with that branch's stale tooling. In #979 that produced `_literals.py` in the pre-#941 closed `Literal[...]` form; merging it would have silently reverted the enum relaxation. It also opened with a `TODO` title that blocked `pr-title-check` - a design that needs human action to become mergeable, which is what let #979 rot for 20 days while the same spec changes were landed by hand (#923, #936, #947, #960, #974). The nightly job always generates on master and rebuilds its `ci/regenerate-models` branch from master instead of appending, so the diff is always "current spec vs current master" and can't resurrect a stale generated file. It opens with a mergeable `chore:` title; reviewers retitle to `fix:`/`feat:` when the diff is user-facing. ## Notes - **Merge apify/apify-docs#2835 first** - it removes the dispatch that still calls the workflow deleted here. - **Needs a `SLACK_WEBHOOK_URL` repository secret** for the failure alert. - The recorded version is a coarse marker, not a content identity: apify-docs bumps `components/version.yaml` in a follow-up `[skip ci]` commit, so a deploy can publish new content under the old stamp. A moved value proves the specification changed; an unchanged one proves nothing. *✍️ Drafted by Claude Code*
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
2 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.
Regenerates the auto-generated Pydantic models and TypedDicts from the latest published OpenAPI specification.
The spec change mostly relaxes fields that were declared required but can be absent in real API responses, so deserializing such responses no longer raises a
ValidationError:BuildStats.compute_unitsandRunStats.compute_unitsare now optional.RunStats.restart_countandRunStats.resurrect_countare now optional.KeyValueStoreStats.read_count,write_count,delete_countandlist_countare now optional.WebhookStats.total_dispatchesis now optional.Webhook.request_urlis now optional - it is omitted ornullfor hook actions other than the conventional HTTP case (e.g. Slack or email notifications). Documented on bothWebhookandWebhookDispatchWebhookSummary.StoreListActor.current_pricing_infois now optional.UserPrivateInfo.proxyis now optional.RunOptions.max_itemsnow allows0(constraint relaxed fromge=1toge=0).cannot-monetize-without-payout-billing-info.TaggedBuildInfo.build_numbernotes it can benullfor legacy builds; theDataset.schemadocs link now points tohttps://docs.apify.com/storage/dataset-schema.✍️ Drafted by Claude Code