docs(academy): teach explicit .input reference in actor.json; auto-discovery is deprecated
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 82/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Ambito
- documentation
Direzione di ricerca
Leggi sources/academy/tutorials/apify_scrapers/getting_started.md, in particolare l’esempio dello schema e le istruzioni circostanti alle righe 8, 18 e 20–27. Aggiungi la sezione suggerita che spiega entrambe le forme di .input e rimanda alla pagina delle specifiche dello schema di input; il lavoro è concluso quando il tutorial insegna il collegamento esplicito e avverte che il rilevamento automatico basato sul nome del file è deprecato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Problem
Users (and agents) who follow the academy tutorial sources/academy/tutorials/apify_scrapers/getting_started.md learn to create an INPUT_SCHEMA.json (or input_schema.json) file, but the tutorial never mentions the required .input reference in actor.json — the surrounding text (around lines 8, 18, and 20-27) teaches "create the schema file" in isolation.
The deprecation warning lives at input_schema/specification.md line 21, a page most getting-started readers won't visit:
Note: Placing INPUT_SCHEMA.json in the Actor's root is deprecated. Use
.actor/INPUT_SCHEMA.jsonand reference it explicitly fromactor.json.
As a result, agent-authored Actors ship a schema file without the actor.json linkage and continue to rely on filename-based auto-discovery, which is scheduled for removal.
Suggested change
Add a short section to the academy tutorial (right after the schema example) that teaches the two accepted forms:
### Reference the input schema from `actor.json`
Once you've written the schema file, reference it from `actor.json`:
**Form 1 — path reference (recommended):**
```json
{
"actorSpecification": 1,
"name": "my-actor",
"input": "./input_schema.json"
}
Form 2 — inline object:
{
"actorSpecification": 1,
"name": "my-actor",
"input": { /* schema contents */ }
}
Filename-based auto-discovery (dropping the .input field and hoping the platform finds INPUT_SCHEMA.json) is deprecated and will be removed in a future release. Always add the explicit .input reference.
Cross-reference the specification page for the full deprecation note.
## Related
- Companion PR against `apify/actor-templates` to add the same teaching to the `ts-empty` (and `js-empty`, `python-empty`) AGENTS.md Do-list.
- The overlay in the internal eval pack already teaches this — this issue closes the durable upstream side.
## Impact
Medium. Every agent-authored Actor that follows the academy tutorial ships without the `.input` reference. Forward-compatibility risk when Apify removes auto-discovery; also propagates the anti-pattern through every Actor those agents inspire.
---
_Surfaced during an evaluation of Apify surfaces for agent-driven Actor development._
- Lingua principale
- JavaScript
- Stelle
- 82
- Fork
- 240
- Merge medio
- 4g 2h
- PR unite (30g)
- 44
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di apify/apify-docs
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
apify/apify-docs#3071 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
apify/apify-docs#3049 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
apify/apify-docs#2742 ·
I maintainer di solito rispondono entro 1 giorno
-
low priority t-unblocking tech enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
apify/apify-docs#2451 ·
I maintainer di solito rispondono entro 1 giorno
-
Add missing router docsApertat-builders t-docs
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
apify/apify-docs#1703 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di apify/apify-docs
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
I maintainer di solito rispondono entro 8 giorni
-
docs(stream-protocol): document messageMetatadata on start/finish and the message-metadata chunkApertafactory-active task-identify-harness-labels-done task-identify-issue-type-done
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
vercel/ai#23375 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
feature request
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
-
docs hacktoberfest help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
pacocartones/free-llm-api-hub#347 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
wpilibsuite/wpilib-docs#3378 ·
I maintainer di solito rispondono entro 1 giorno