diff --git a/sources/platform/actors/development/actor_definition/input_schema/specification.md b/sources/platform/actors/development/actor_definition/input_schema/specification.md index 4e8e76fd2a..f376c6d27d 100644 --- a/sources/platform/actors/development/actor_definition/input_schema/specification.md +++ b/sources/platform/actors/development/actor_definition/input_schema/specification.md @@ -3,6 +3,7 @@ title: Specification sidebar_position: 2 description: Learn how to define and validate a schema for your Actor's input with code examples. Provide an autogenerated input UI for your Actor's users. slug: /actors/development/actor-definition/input-schema/specification/v1 +toc_max_heading_level: 5 --- # Actor input schema specification @@ -148,6 +149,8 @@ Most types also support additional properties defining, for example, the UI inpu ### String +#### Code input + Example of a code input: ```json @@ -164,6 +167,8 @@ Rendered input: ![Apify Actor input schema page function](./images/input-schema-page-function.png) +#### Country selection + Example of country selection using a select input: ```json @@ -182,6 +187,8 @@ Rendered input: ![Apify Actor input schema - country input](./images/input-schema-country.png) +#### `datepicker` editor + Example of date selection using absolute and relative `datepicker` editor: ```json @@ -224,6 +231,8 @@ The `anyDate` property renders a date picker that accepts both absolute and rela ![Apify Actor input schema - country input](./images/input-schema-date-both.png) +#### `fileupload` editor + The `fileupload` editor enables users to specify a file as input. The input is passed to the Actor as a string. It is the Actor author's responsibility to interpret this string, including validating its existence and format. ![Apify Actor input schema - fileupload input](./images/input-schema-fileupload-input.png) @@ -234,17 +243,17 @@ The user provides either a URL or uploads the file to a key-value store (existin Properties: -| Property | Value | Required | Description | -|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `editor` | One of | Yes | Visual editor used for
the input field. | -| `pattern` | String | No | Regular expression that will be
used to validate the input.
If validation fails,
the Actor will not run. | -| `minLength` | Integer | No | Minimum length of the string. | -| `maxLength` | Integer | No | Maximum length of the string. | -| `enum` | [String] | Required if
`editor`
is `select` | Using this field, you can limit values
to the given array of strings.
Input will be displayed as select box. | -| `enumTitles` | [String] | No | Titles for the `enum` keys described. | -| `nullable` | Boolean | No | Specifies whether `null`
is an allowed value. | -| `isSecret` | Boolean | No | Specifies whether the input field
will be stored encrypted.
Only available
with `textfield` and `textarea` editors. | -| `dateType` | One of | No | This property, which is only available with `datepicker` editor, specifies what date format should visual editor accept (The JSON editor accepts any string without validation.).


Defaults to `absolute`. | +| Property | Value | Required | Description | +|----------|--------|-----------|-------------| +| `editor` | One of:
- `textfield`
- `textarea`
- `javascript`
- `python`
- `select`
- `datepicker`
- `fileupload`
- `hidden` | Yes | Visual editor used for the input field. | +| `pattern` | String | No | Regular expression that will be used to validate the input. If validation fails, the Actor will not run. | +| `minLength` | Integer | No | Minimum length of the string. | +| `maxLength` | Integer | No | Maximum length of the string. | +| `enum` | [String] | Required if `editor` is `select` | Using this field, you can limit values to the given array of strings. Input will be displayed as select box. | +| `enumTitles` | [String] | No | Titles for the `enum` keys described. | +| `nullable` | Boolean | No | Specifies whether `null` is an allowed value. | +| `isSecret` | Boolean | No | Specifies whether the input field will be stored encrypted. Only available with `textfield` and `textarea` editors. | +| `dateType` | One of | No | This property, which is only available with `datepicker` editor, specifies what date format should visual editor accept (The JSON editor accepts any string without validation.).


Defaults to `absolute`. | :::note Regex escape