fix: correct actor.json version examples and clarify input schema linkage#2662
Draft
DaveHanns wants to merge 1 commit into
Draft
fix: correct actor.json version examples and clarify input schema linkage#2662DaveHanns wants to merge 1 commit into
DaveHanns wants to merge 1 commit into
Conversation
…kage
Three documentation gaps that collectively mis-teach agents and humans
writing Actors from scratch.
## F35 — dataset_schema page has 3 non-functional `1.0.0` examples
The dataset_schema page shows three inline `actor.json` examples with
`"version": "1.0.0"`. The platform rejects 3-part SemVer at the
admission gate `POST /v2/acts/{id}/versions` (MAJOR.MINOR only, each
0–99). Replaced all three with `"1.0"` and added a warning admonition
at the top of the page citing the actor.json reference.
## F40 — academy tutorial teaches schema file creation in isolation
`sources/academy/platform/deploying_your_code/input_schema.md` walks the
reader through creating an `input_schema.json` file but never mentions
how to reference it from `.actor/actor.json`. Agents extrapolate "the
file exists, that's the contract" — relying on the platform's
auto-discovery fallback, which is officially deprecated per
specification.md line 21.
Added a new "Reference the schema in actor.json" section showing:
- Option 1: path reference (recommended)
- Option 2: inline schema
- A `:::note` admonition flagging auto-discovery as deprecated
## F40 sub-patch — actor_json reference page demotes auto-discovery
The `.input` field row in actor_json.md treated auto-discovery as an
equally valid path. Reordered the description to lead with the
inline-or-path-reference forms and demote auto-discovery to a
backward-compat note, mirroring the language in specification.md.
Files changed:
- `sources/platform/actors/development/actor_definition/dataset_schema/index.md`
(3 `"1.0.0"` → `"1.0"`, plus a `:::warning` admonition at the top)
- `sources/academy/platform/deploying_your_code/input_schema.md`
(new "Reference the schema in actor.json" section before "Final
thoughts")
- `sources/platform/actors/development/actor_definition/actor_json.md`
(rewrite of `input` field row)
Refs: chocholous/apify-evals F35, F36, F40.
4 tasks
Contributor
|
✅ Preview for this PR (commit |
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
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.
Summary
Three documentation gaps that collectively mis-teach agents and humans writing Actors from scratch:
F35 —
dataset_schemapage has 3 non-functional1.0.0examplessources/platform/actors/development/actor_definition/dataset_schema/index.mdshows three inlineactor.jsonexamples with"version": "1.0.0". The platform rejects 3-part SemVer at the admission gatePOST /v2/acts/{id}/versions(MAJOR.MINOR only, each 0–99 — empirically reconfirmed 2026-06-21 against throwaway ActorvXEV76d7g0dyKXdPB).Fix: replace all three with
"1.0", plus add a:::warningadmonition at the top of the page linking the actor.json reference.F40 — academy tutorial teaches schema-file creation in isolation
sources/academy/platform/deploying_your_code/input_schema.mdwalks the reader through creating aninput_schema.jsonfile but never mentions how to reference it from.actor/actor.json. Agents extrapolate "the file exists, that's the contract" — relying on the platform's auto-discovery fallback, which is officially deprecated perinput_schema/specification.mdline 21.Fix: add a new "Reference the schema in actor.json" section showing both the path-reference (recommended) and inline forms, plus a
:::noteadmonition flagging auto-discovery as deprecated. Inserted between the existing schema example and the "Final thoughts" section.F40 sub-patch —
actor_json.mdreference page demotes auto-discoverysources/platform/actors/development/actor_definition/actor_json.mdline 83 (theinputfield row) treated auto-discovery as an equally-valid path. Reordered the description to lead with the inline-or-path-reference forms, mark them as the recommended pattern, and demote auto-discovery to a backwards-compat note, mirroring the language inspecification.md.Diffstat
Verification
Test plan
:::warningand:::noteare supported in the existing docs stack){#reference-in-actor-json}and the link to../actor_json.mdresolveRefs
🤖 Generated with Claude Code