Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add a note on compatibility between JSON schema and Actor input schema #757

Merged
merged 2 commits into from
Nov 13, 2023
Merged

docs: add a note on compatibility between JSON schema and Actor input schema #757

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c980b90
docs: add a note on compatibility between JSON schema and Actor input…
janbuchar Nov 9, 2023
f9d1c28
Update sources/platform/actors/development/actor_definition/input_sch…
janbuchar Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions sources/platform/actors/development/actor_definition/input_schema/specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ The input schema is a JSON file named **INPUT_SCHEMA.json**, placed in the root
| `properties` | Object | Yes | This is an object mapping each field key <br/>to its specification. |
| `required` | [String] | No | An array of field keys that are required. |

> Even though the structure of the Actor input schema is similar to JSON schema, there are a few important differences.
> Therefore, we cannot guarantee that JSON schema tooling will work correctly on input schema documents.
> For precise technical understanding of the matter, feel free to browse the code of the [@apify/input_schema](https://github.com/apify/apify-shared-js/tree/master/packages/input_schema/src) package.
janbuchar marked this conversation as resolved.
Show resolved Hide resolved

## Fields

Each field of your input is described under its key in `inputSchema.properties` object. The field might have `integer`, `string`, `array`, `object` or `boolean` type and its specification contains the following properties:
Expand Down