Skip to content

docs: ia v3 followups - Limits and dataset & kv store schemas#2747

Merged
marcel-rbro merged 3 commits into
masterfrom
ia-v3-followups
Jul 10, 2026
Merged

docs: ia v3 followups - Limits and dataset & kv store schemas#2747
marcel-rbro merged 3 commits into
masterfrom
ia-v3-followups

Conversation

@TC-MO

@TC-MO TC-MO commented Jul 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Resolves issue 2476

Removes Limits from topnav to Account section
Moves dataset & kv store schema to Storage
Restructures Storage to account for new content
Restructures KV Store schema docs to align wiwth dataset schema doc structure
Updates links within OpenAPI spec

TC-MO added 2 commits July 7, 2026 20:55
@TC-MO
refactor(storage): move schema pages into Storage, grouped by store t…
b023e2e 
…ype (#2746)

Move the dataset and key-value store schema pages out of Actor development
into the Storage section, grouped under Dataset and Key-value store
categories. Add nginx redirects for the old URLs and repoint internal
links; page slugs are unchanged.

Also align the two schema docs to a parallel structure and headings,
correct the Actor definition schema list to cover input and output
schemas, and drop first-person voice from the storage pages.
@TC-MO
refactor: move Limits from top nav into Account (#2746)
ea9182a 
Move the Limits page from the top navigation into the Account section
(/limits -> /account/limits) and add an nginx redirect. Remove the
top-nav entry from the shared theme.
@TC-MO TC-MO self-assigned this Jul 7, 2026
@TC-MO TC-MO added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels Jul 7, 2026
@apify-service-account

apify-service-account commented Jul 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

🗑️ Preview for this PR was deleted.

@apify-service-account apify-service-account mentioned this pull request Jul 7, 2026
Merged
@apify-service-account

apify-service-account commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Important

Action required — @TC-MO please coordinate this docs PR with the Python API client PR linked below.

Because this PR modifies the OpenAPI specification, the generated models in apify-client-python must be regenerated to stay in sync. This has already been done automatically:

A companion PR has been opened in apify-client-python with the regenerated models: apify/apify-client-python#923

  • Please make sure to review and merge both PRs together to keep the OpenAPI spec and API clients in sync.
  • You can ask for review and help from the Tooling team if needed.

@TC-MO TC-MO requested a review from marcel-rbro July 8, 2026 08:07
@TC-MO TC-MO marked this pull request as ready for review July 8, 2026 08:07
@marcel-rbro

marcel-rbro commented Jul 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Optional / out of strict scope — flagging since this PR already updates OpenAPI spec links and could be expanded to finish the set.

These four spec links still point at the old actor-definition/dataset-schema path. They're pre-existing and not broken by this PR — they resolved before and still resolve now (via the /platform-strip + new schema-move redirect, just an extra hop). If you'd like to knock them out here for consistency, swap /platform/actors/development/actor-definition/dataset-schema → /storage/dataset-schema:

  • apify-api/openapi/components/schemas/actors/ActorDefinition.yaml:44 → [Apify docs](https://docs.apify.com/storage/dataset-schema) (same text as the already-updated Dataset.yaml)
  • apify-api/openapi/components/objects/datasets/dataset-statistics.yaml:30 → [field statistics](https://docs.apify.com/storage/dataset-schema/validation#dataset-field-statistics)
  • apify-api/openapi/components/objects/datasets/dataset-items.yaml:445 → [Dataset schema](https://docs.apify.com/storage/dataset-schema/validation)
  • apify-api/openapi/components/schemas/datasets/DatasetStatistics.yaml:8 → both links to https://docs.apify.com/storage/dataset-schema/validation (and …/validation#dataset-field-statistics)

Equally fine to leave as-is and handle in a separate follow-up.

@fnesveda fnesveda removed their request for review July 9, 2026 11:00
marcel-rbro

This comment was marked as duplicate.

Sign in to view

@marcel-rbro @claude
docs: optimize kv store schema images to webp
e16501e 
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@apify-service-account

apify-service-account commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Important

Action required — @TC-MO please coordinate this docs PR with the Python API client PR linked below.

Because this PR modifies the OpenAPI specification, the generated models in apify-client-python must be regenerated to stay in sync. This has already been done automatically:

The companion apify-client-python PR has been updated with the latest spec changes: apify/apify-client-python#923

  • Please make sure to review and merge both PRs together to keep the OpenAPI spec and API clients in sync.
  • You can ask for review and help from the Tooling team if needed.

@marcel-rbro marcel-rbro merged commit 13b5290 into master Jul 10, 2026
16 checks passed
@marcel-rbro marcel-rbro deleted the ia-v3-followups branch July 10, 2026 10:59
vdusek pushed a commit to apify/apify-client-python that referenced this pull request Jul 10, 2026
@apify-service-account
docs: fix dataset schema link in generated Dataset model (#923)
783b3eb 
- Updates the auto-generated Pydantic models and TypedDicts based on the
proposed OpenAPI specification changes.
- Based on apify-docs PR
[#2747](apify/apify-docs#2747).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@marcel-rbro marcel-rbro marcel-rbro approved these changes
@janbuchar janbuchar Awaiting requested review from janbuchar janbuchar is a code owner
@honzajavorek honzajavorek Awaiting requested review from honzajavorek honzajavorek is a code owner
@szaganek szaganek Awaiting requested review from szaganek szaganek is a code owner

Assignees

@TC-MO TC-MO

Labels

documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Information architecture follow ups

3 participants

@TC-MO @apify-service-account @marcel-rbro