Skip to content

fix: relax required stats fields (compute units, counts) to optional - #947

Merged
Pijukatel merged 2 commits into
masterfrom
update-models-docs-pr-2763
Jul 13, 2026
Merged

fix: relax required stats fields (compute units, counts) to optional#947
Pijukatel merged 2 commits into
masterfrom
update-models-docs-pr-2763

Conversation

@apify-service-account

Copy link
Copy Markdown
Contributor
  • Updates the auto-generated Pydantic models and TypedDicts based on the proposed OpenAPI specification changes.
  • Based on apify-docs PR #2763.

@codecov

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.54%. Comparing base (dbd39d0) to head (3f4ca2b).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #947      +/-   ##
==========================================
- Coverage   94.56%   94.54%   -0.03%     
==========================================
  Files          48       48              
  Lines        5119     5116       -3     
==========================================
- Hits         4841     4837       -4     
- Misses        278      279       +1     
Flag Coverage Δ
integration 92.84% <100.00%> (-0.13%) ⬇️
unit 83.42% <100.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Pijukatel Pijukatel changed the title TODO fix: Relax constraints on generated models based on updated specification Jul 13, 2026
@vdusek vdusek changed the title fix: Relax constraints on generated models based on updated specification fix: relax required stats fields (compute units, counts) to optional Jul 13, 2026

@vdusek vdusek left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

I just made the PR title more specific. The previous one ("Relax constraints on generated models based on updated specification") doesn't say much in the changelog (which constraints? which fields?), and we already have another PR with that exact title, so we'd get two identical changelog lines.

Please be more specific in these. And ask Claude if you can't come up with a good title 😄.

@Pijukatel
Pijukatel merged commit 46f1286 into master Jul 13, 2026
56 of 57 checks passed
@Pijukatel
Pijukatel deleted the update-models-docs-pr-2763 branch July 13, 2026 09:24
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*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants