Skip to content

Commit e06b8d4

Browse files
authored
docs: Update specification.md (#1361)
Improved docs - see https://apify.slack.com/archives/C010Q0FBYG3/p1734204494460739
2 parents e768c63 + 699e56a commit e06b8d4

File tree

1 file changed

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

1 file changed

+6
-3
lines changed

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,16 @@ The Actor input schema serves three main purposes:
2020
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.
2121
For backwards compatibility, 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.
2222

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.
23+
When you provide an input schema, the Apify platform will validate the input data passed to the Actor on start (via the API or Apify Console) to ensure compliance before starting the Actor.
2424
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

28-
You can also use our [visual input schema editor](https://apify.github.io/input-schema-editor-react/) to guide you through the creation of the `INPUT_SCHEMA.json` file.
29-
If you need to validate your input schemas, you can use the [`apify validate-schema`](/cli/docs/reference#apify-validate-schema-path) command in the Apify CLI.
28+
You can use our [visual input schema editor](https://apify.github.io/input-schema-editor-react/) to guide you through the creation of the `INPUT_SCHEMA.json` file.
29+
30+
To ensure the input schema is valid, here's a corresponding [JSON schema file](https://github.com/apify/apify-shared-js/blob/master/packages/input_schema/src/schema.json).
31+
32+
You can also use the [`apify validate-schema`](/cli/docs/reference#apify-validate-schema-path) command in the Apify CLI.
3033

3134
:::
3235

0 commit comments

Comments
 (0)