Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

docs(academy): teach explicit .input reference in actor.json; auto-discovery is deprecated

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#2,741 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc sources/academy/tutorials/apify_scrapers/getting_started.md, đặc biệt là ví dụ về schema và các hướng dẫn xung quanh ở dòng 8, 18 và 20–27. Thêm phần được đề xuất giải thích cả hai dạng của .input và liên kết đến trang đặc tả input-schema; hoàn thành khi tutorial hướng dẫn cách liên kết tường minh và cảnh báo rằng tính năng tự động phát hiện dựa trên tên tệp đã lỗi thời.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.json and reference it explicitly from actor.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._
Ngôn ngữ chính
JavaScript
Star
82
Fork
240
Merge trung bình
4 ngày 2 giờ
Pull request đã merge (30 ngày)
44

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của apify/apify-docs

Tất cả issue của apify/apify-docs

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.