Skip to content

Commit

Permalink
docs: Update input_schema.md (#588)
Browse files Browse the repository at this point in the history
Added @metalwarrior665's razor

---------

Co-authored-by: Martin Adámek <[email protected]>
  • Loading branch information
jancurn and B4nan authored May 11, 2023
1 parent b377f60 commit efa881a
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions sources/platform/actors/development/input_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ Each field of your input is described under its key in `inputSchema.properties`
| `sectionCaption` | String | No | If this property is set, <br/>then all fields following this field <br/>(this field included) will be separated <br/>into a collapsible section <br/>with the value set as its caption. <br/>The section ends at the last field <br/>or the next field which has the <br/> `sectionCaption` property set. |
| `sectionDescription` | String | No | If the `sectionCaption` property is set, <br/>then you can use this property to <br/>provide additional description to the section. <br/>The description will be visible right under <br/>the caption when the section is open. |

Here is a rule of thumb wheteher an input field should have a `prefill`, `default`, or empty value:

- **Prefill** - For fields that don't have reasonable defaults and user should change them (e.g. search keyword, example start URL)
- **Default** - For everything that should be set for the actor run to some value (e.g. max pages to crawl, proxy settings)
- **Empty** - For purely opt-in features

## Additional properties

Expand Down Expand Up @@ -356,8 +361,8 @@ Properties:

Usage of this field is based on the selected editor:

* `requestListSources` - value from this field can be used as input of [RequestList](https://crawlee.dev/api/core/class/RequestList) class from Crawlee.
* `pseudoUrls` - is intended to be used with a combination of the [PseudoUrl](https://crawlee.dev/api/core/class/PseudoUrl) class and the [enqueueLinks()](https://crawlee.dev/api/core/function/enqueueLinks) function from Crawlee.
- `requestListSources` - value from this field can be used as input of [RequestList](https://crawlee.dev/api/core/class/RequestList) class from Crawlee.
- `pseudoUrls` - is intended to be used with a combination of the [PseudoUrl](https://crawlee.dev/api/core/class/PseudoUrl) class and the [enqueueLinks()](https://crawlee.dev/api/core/function/enqueueLinks) function from Crawlee.

Editor type `requestListSources` supports input in formats defined by the [sources](https://crawlee.dev/api/core/interface/RequestListOptions#sources) property of [RequestListOptions](https://crawlee.dev/api/core/interface/RequestListOptions).

Expand Down

0 comments on commit efa881a

Please sign in to comment.