Skip to content

docs: fix dataset schema link in generated Dataset model - #923

Merged
vdusek merged 5 commits into
masterfrom
update-models-docs-pr-2747
Jul 10, 2026
Merged

docs: fix dataset schema link in generated Dataset model#923
vdusek merged 5 commits into
masterfrom
update-models-docs-pr-2747

Conversation

@apify-service-account

@apify-service-account apify-service-account commented Jul 7, 2026

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 #2747.

@codecov

codecov Bot commented Jul 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.54%. Comparing base (587baa7) to head (c075c0c).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #923      +/-   ##
==========================================
- Coverage   94.56%   94.54%   -0.02%     
==========================================
  Files          48       48              
  Lines        5119     5119              
==========================================
- Hits         4841     4840       -1     
- Misses        278      279       +1     
Flag Coverage Δ
integration 92.65% <ø> (-0.32%) ⬇️
unit 83.43% <ø> (ø)

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.

@TC-MO TC-MO changed the title TODO docs: update links within OpenAPI spec Jul 7, 2026
@vdusek vdusek changed the title docs: update links within OpenAPI spec docs: update documentation links in generated models Jul 8, 2026
@vdusek

vdusek commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request

Copilot AI commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request

Resolved the merge conflict in src/apify_client/_literals.py. The conflict was in the RunOrigin type — kept the master version that adds | str to tolerate unknown API values (from #941). Commit: fix: resolve merge conflict in _literals.py.

Copilot AI requested a review from vdusek July 10, 2026 10:33
@vdusek vdusek changed the title docs: update documentation links in generated models docs: fix dataset schema link in generated Dataset model Jul 10, 2026
@vdusek
vdusek merged commit 783b3eb into master Jul 10, 2026
30 checks passed
@vdusek
vdusek deleted the update-models-docs-pr-2747 branch July 10, 2026 11:07
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.

4 participants