Skip to content

Commit a86fc15

Browse files
authored
Update specification.md
1 parent d74d7e5 commit a86fc15

File tree

1 file changed

+8
-8
lines changed
  • sources/platform/actors/development/actor_definition/input_schema

1 file changed

+8
-8
lines changed

sources/platform/actors/development/actor_definition/input_schema/specification.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ slug: /actors/development/actor-definition/input-schema/specification/v1
1111

1212
---
1313

14-
The Actor input schema serves two primary purposes:
14+
The Actor input schema serves three main purposes:
1515

16-
- It defines the structure and validation rules for the input data the Actor accepts.
17-
- It determines the user interface components rendered in the Apify Console for configuring the Actor's input.
16+
- It ensures the input data supplied to the Actor adhere specified requirements and validation rules.
17+
- It is used by the Apify platform to generate a user-friendly interface for configuring and running your Actor.
18+
- It simplifies invoking your Actors from external systems by generating calling code and connectors for integrations.
1819

19-
By defining an input schema, you can provide a user-friendly interface for configuring your Actor while ensuring that the input data supplied by users adheres to the specified requirements and constraints. The input schema also makes it easy to call and integrate your Actor from external systems.
20+
To define an input schema for an Actor, set `input` field in the `.actor/actor.json` file to an input schema object (described below), or path to a JSON file containing the input schema object.
21+
For backwards compability, if the `input` field is omitted, the system looks for an `INPUT_SCHEMA.json` file either in the `.actor` directory or the Actor's top-level directory - but note that this functionality is deprececated and might be removed in the future. The maximum allowed size for the input schema file is 500 kB.
2022

21-
To define an input schema for an Actor, set `input` field in the `.actor/actor.json` file to an input schema object as described below, or path to a JSON file containing the input schema.
22-
For backwards compability, if the `input` field is omitted, the system looks for an `INPUT_SCHEMA.json` file in the `.actor` directory or for an `INPUT_SCHEMA.json` file in the Actor's root directory - but do not depend on this behavior as it might be removed in the future.
23-
24-
The maximum allowed size for the input schema file is 500 kB. When you provide an input schema, the system will validate the input data passed to the Actor during execution (via the API or the Apify Console) against the specified schema to ensure compliance before starting the Actor.
23+
When you provide an input schema, the system will validate the input data passed to the Actor on start (via the API or Apify Console) against the specified schema to ensure compliance before starting the Actor.
24+
If the input object doesn't conform the schema, the caller receives an error and the Actor is not started.
2525

2626
:::note Validation aid
2727

0 commit comments

Comments
 (0)