Skip to content

Commit 90416b6

Browse files
authored
Update specification.md
1 parent bc9a6e8 commit 90416b6

File tree

1 file changed

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

1 file changed

+5
-8
lines changed

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

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

1212
---
1313

14-
The input schema serves two primary purposes for an Actor:
14+
The Actor input schema serves two primary purposes:
1515

1616
- It defines the structure and validation rules for the input data the Actor accepts.
1717
- It determines the user interface components rendered in the Apify Console for configuring the Actor's input.
1818

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.
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. Also, the input schema make it easy to call and integrate your Actor from external systems.
2020

21-
You can specify input schema for an Actor in multiple ways:
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.
2223

23-
- One approach embeds it as an object within the `.actor/actor.json` file under the `input` field or provide a path to a `JSON` file containing the input schema in the same `input` field.
24-
- If you omit the `input` field in the `.actor/actor.json` file, the system will look for an `INPUT_SCHEMA.json` file in the `.actor` directory.
25-
- In the absence of that file, it will search for an `INPUT_SCHEMA.json` file in the Actor's root directory.
26-
27-
The max 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.
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.
2825

2926
:::note Validation aid
3027

0 commit comments

Comments
 (0)