Skip to content

Commit d2f0598

Browse files
mforimfori
committed
address PR comments
1 parent 8467240 commit d2f0598

File tree

1 file changed

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

1 file changed

+15
-15
lines changed

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -209,32 +209,32 @@ Example of date selection using absolute and relative `datepicker` editor:
209209
}
210210
```
211211

212-
Rendered input for `absolute_date` property. See that by default, the date picker allows selecting only an absolute date in the form `YYYY-MM-DD`:
212+
The `absolute_date` property renders a date picker that allows selection of a specific date and returns string value in the format `YYYY-MM-DD`.
213213

214214
![Apify Actor input schema - country input](./images/input-schema-date-absolute.png)
215215

216-
Rendered input for `relative_date` property in form of `+/- {number} {unit}`. (The `allowAbsolute` is explicitly set to `false`):
216+
The `relative_date` property renders an input field that enables the user to choose the relative date and returns the value in the format `+/- {number} {unit}`, for example `"+ 2 days"`. The `allowAbsolute` parameter is set to `false` to restrict input to relative dates only.
217217

218218
![Apify Actor input schema - country input](./images/input-schema-date-relative.png)
219219

220-
Rendered input for `any_date` property. The date picker allows selecting both absolute and relative dates, and it's up to the Actor author to parse recognize the chosen form:
220+
The `any_date` property renders a date picker that accepts both absolute and relative dates. The Actor author is responsible for parsing and interpreting the selected date format.
221221

222222
![Apify Actor input schema - country input](./images/input-schema-date-both.png)
223223

224224
Properties:
225225

226-
| Property | Value | Required | Description |
227-
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
228-
| `editor` | One of <ul><li>`textfield`</li><li>`textarea`</li><li>`javascript`</li><li>`python`</li><li>`select`</li><li>`datepicker`</li><li>`hidden`</li></ul> | Yes | Visual editor used for <br/>the input field. |
229-
| `pattern` | String | No | Regular expression that will be <br/>used to validate the input. <br/> If validation fails, <br/>the Actor will not run. |
230-
| `minLength` | Integer | No | Minimum length of the string. |
231-
| `maxLength` | Integer | No | Maximum length of the string. |
232-
| `enum` | [String] | Required if <br/>`editor` <br/>is `select` | Using this field, you can limit values <br/>to the given array of strings. <br/>Input will be displayed as select box. |
233-
| `enumTitles` | [String] | No | Titles for the `enum` keys described. |
234-
| `nullable` | Boolean | No | Specifies whether `null` <br/>is an allowed value. |
235-
| `isSecret` | Boolean | No | Specifies whether the input field<br />will be stored encrypted.<br />Only available <br />with `textfield` and `textarea` editors. |
236-
| `allowAbsolute` | Boolean | No | Used only with `datepicker` editor for absolute date value picker in form `YYYY-MM-DD`. This defaults to `true`. |
237-
| `allowRelative` | Boolean | No | Used only with `datepicker` editor for relative input in form `+/- {number} {unit}`.<br/>The value passed to Actor input is in plain text e.g. `"+ 3 weeks"` and it's up to Actor author to parse it.<br/>Supported units are: days, weeks, months and years.<br/>If only relative input is required, `allowAbsolute` needs to be explicitly set to `false`, otherwise both formats are supported. |
226+
| Property | Value | Required | Description |
227+
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
228+
| `editor` | One of <ul><li>`textfield`</li><li>`textarea`</li><li>`javascript`</li><li>`python`</li><li>`select`</li><li>`datepicker`</li><li>`hidden`</li></ul> | Yes | Visual editor used for <br/>the input field. |
229+
| `pattern` | String | No | Regular expression that will be <br/>used to validate the input. <br/> If validation fails, <br/>the Actor will not run. |
230+
| `minLength` | Integer | No | Minimum length of the string. |
231+
| `maxLength` | Integer | No | Maximum length of the string. |
232+
| `enum` | [String] | Required if <br/>`editor` <br/>is `select` | Using this field, you can limit values <br/>to the given array of strings. <br/>Input will be displayed as select box. |
233+
| `enumTitles` | [String] | No | Titles for the `enum` keys described. |
234+
| `nullable` | Boolean | No | Specifies whether `null` <br/>is an allowed value. |
235+
| `isSecret` | Boolean | No | Specifies whether the input field<br />will be stored encrypted.<br />Only available <br />with `textfield` and `textarea` editors. |
236+
| `allowAbsolute` | Boolean | No | Enables absolute date input in `YYYY-MM-DD` format. Only available with `datepicker` editor. <br/><br/>Defaults to `true`. |
237+
| `allowRelative` | Boolean | No | Enables relative date input in <br/>`+/- {number} {unit}` format. <br/>Supported units are: days, weeks, months, years. <br/><br/>The input is passed to the Actor as plain text (e.g., "+3 weeks"). To parse it, regex like this can be used: `^([+-])\s*(\d+)\s*(day\|week\|month\|year)s?$`.<br/><br/>Set `allowAbsolute` to `false` to allow only relative input, otherwise both formats are supported. Only available with `datepicker` editor. |
238238

239239
:::note Regex escape
240240

0 commit comments

Comments
 (0)