docs: storage tasks - #2975
Open
TC-MO wants to merge 16 commits into
Open
docs: storage tasks#2975TC-MO wants to merge 16 commits into
TC-MO wants to merge 16 commits into
Conversation
The sharing procedure and the between-runs procedure were each written out four times, on the storage overview and all three type pages, with only the noun changed.
The overview's exception list omitted the request queue lock tier and the 40/s batch tier, so it understated the real limits.
The API reference link pointed at key-value stores, the #sharing anchor had no matching heading, and the description promised sharing content.
Record CRUD is a 200/s tier per openapi.yaml, not the 60/s default.
Nesting it under sharing implied a subset relationship that isn't there: granting a person access and addressing your own storage from code are unrelated mechanisms that only shared the word "share".
Request queue limits were lowered in apify-core#29428 (Jul 2026) to avoid DynamoDB partition throttling and the docs were never updated. Also documents the key-value store keys and records list tiers.
Drops a fabricated redoc anchor and corrects the key-value store records endpoint, which downloads a ZIP archive rather than listing records. Restores the concurrent write-order caveat to the storage overview.
The three per-type sections differed only in one method name and one client accessor, so the extraction had relocated duplication rather than removing it. One example per surface plus a lookup table covers all three.
The API client section led with the SDK's "open" flow; the replacement describes the client accessor, and the username/name form it documents is what both clients' to_safe_id conversions accept.
TC-MO
added
documentation
Contributor
|
✅ Preview for this PR (commit |
… anchors Pre-signed URLs cover only selected dataset and key-value store endpoints, so the request queue stub dropped the claim. Headings keep master's #share id; the between-runs fragments decay deliberately - Docusaurus offsets only heading anchors, so span targets hide under the navbar.
One designed SVG, dead links stripped, SVGO) covers what datasets-app.png and find-store-id.png showed. overview-api.png was referenced nowhere.
TC-MO
marked this pull request as ready for review
September 15, 2026 16:30
TC-MO
requested review from
fnesveda,
janbuchar and
szaganek
as code owners
September 15, 2026 16:30
Restatements only, checked by an independent fidelity review; the one factual change is Python SDK 3.8 -> 3.10, per its pyproject. Also drops the hub's dangling share paragraph and its stale concurrency note.
Fix broken example URLs and leftover filler.
janbuchar
approved these changes
Sep 16, 2026
janbuchar
left a comment
janbuchar
left a comment
Contributor
There was a problem hiding this comment.
Changes to the OpenAPI spec are fine.
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
3 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.
Sharing and cross-run usage were documented three times over, once per storage type, and had drifted apart; this consolidates them into two shared pages (Share storage, Use storage from another run) that the type pages now link to. Along the way it corrects the storage rate limits against
apify-core.