From efa881a668f1b7848b45ab09b0e719086785a74c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20=C4=8Curn?= Date: Thu, 11 May 2023 13:38:10 +0200 Subject: [PATCH] docs: Update input_schema.md (#588) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added @metalwarrior665's razor --------- Co-authored-by: Martin Adámek --- sources/platform/actors/development/input_schema.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/sources/platform/actors/development/input_schema.md b/sources/platform/actors/development/input_schema.md index d1e6748ef..6166a30be 100644 --- a/sources/platform/actors/development/input_schema.md +++ b/sources/platform/actors/development/input_schema.md @@ -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,
then all fields following this field
(this field included) will be separated
into a collapsible section
with the value set as its caption.
The section ends at the last field
or the next field which has the
`sectionCaption` property set. | | `sectionDescription` | String | No | If the `sectionCaption` property is set,
then you can use this property to
provide additional description to the section.
The description will be visible right under
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 @@ -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).