Skip to content

Commit 8bac285

Browse files
committed
docs: Update resource input field docs
1 parent 4961335 commit 8bac285

File tree

1 file changed

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

1 file changed

+23
-12
lines changed

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

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -831,9 +831,9 @@ As with objects, the sub-schema feature for arrays only works for level 1 sub-pr
831831
Resource type identifies what kind of Apify Platform object is referred to in the input field. For example, the Key-value store resource type can be referred to using a string ID.
832832
Currently, it supports storage resources only, allowing the reference of a Dataset, Key-Value Store or Request Queue.
833833

834-
For Actor developers, the resource input value is a string representing the storage ID.
835-
The type of the property is either `string` or `array`. In case of `array` (for multiple resources) the return value is an array of IDs.
836-
In the user interface, a picker is provided for easy selection, where users can search and choose from their own storages or those they have access to.
834+
For Actor developers, the resource input value is a string representing either the resource ID or (unique) name.
835+
The type of the property is either `string` or `array`. In case of `array` (for multiple resources) the return value is an array of IDs or names.
836+
In the user interface, a picker (`resourcePicker` editor) is provided for easy selection, where users can search and choose from their own resources or those they have access to.
837837

838838
Example of a Dataset input:
839839

@@ -869,12 +869,23 @@ Rendered input:
869869

870870
![Apify Actor input schema datasets](./images/input-schema-datasets.png)
871871

872-
Properties:
873-
874-
| Property | Value | Required | Description |
875-
|----------------|-----------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------|
876-
| `type` | One of <ul><li>`string`</li><li>`array`</li></ul> | Yes | Specifies the type of input - string for single value or array for multiple values |
877-
| `editor` | One of <ul><li>`resourcePicker`</li><li>`hidden`</li></ul> | No | Visual editor used for <br/>the input field. Defaults to `resourcePicker`. |
878-
| `resourceType` | One of <ul><li>`dataset`</li><li>`keyValueStore`</li><li>`requestQueue`</li></ul> | Yes | Type of Apify Platform resource |
879-
| `minItems` | Integer | No | Minimum number of items the array can contain. Only for `type: array` |
880-
| `maxItems` | Integer | No | Maximum number of items the array can contain. Only for `type: array` |
872+
##### Single value properties
873+
874+
| Property | Value | Required | Description |
875+
|----------------|-----------------------------------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------|
876+
| `type` | `string` | Yes | Specifies the type of input - `string` for single value. |
877+
| `editor` | One of <ul><li>`resourcePicker`</li><li>`textfield`</li><li>`hidden`</li></ul> | No | Visual editor used for <br/>the input field. Defaults to `resourcePicker`. |
878+
| `resourceType` | One of <ul><li>`dataset`</li><li>`keyValueStore`</li><li>`requestQueue`</li></ul> | Yes | Type of Apify Platform resource |
879+
| `pattern` | String | No | Regular expression that will be used to validate the input. If validation fails, the Actor will not run. |
880+
| `minLength` | Integer | No | Minimum length of the string. |
881+
| `maxLength` | Integer | No | Maximum length of the string. |
882+
883+
##### Multiple values properties
884+
885+
| Property | Value | Required | Description |
886+
|----------------|-----------------------------------------------------------------------------------|----------|----------------------------------------------------------------------------|
887+
| `type` | `array` | Yes | Specifies the type of input - `array` for multiple values. |
888+
| `editor` | One of <ul><li>`resourcePicker`</li><li>`hidden`</li></ul> | No | Visual editor used for <br/>the input field. Defaults to `resourcePicker`. |
889+
| `resourceType` | One of <ul><li>`dataset`</li><li>`keyValueStore`</li><li>`requestQueue`</li></ul> | Yes | Type of Apify Platform resource |
890+
| `minItems` | Integer | No | Minimum number of items the array can contain. |
891+
| `maxItems` | Integer | No | Maximum number of items the array can contain. |

0 commit comments

Comments
 (0)