Skip to content

Commit 9d2926d

Browse files
committed
feat(docs): Hide dateType property
1 parent 91c3ad8 commit 9d2926d

File tree

1 file changed

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

1 file changed

+0
-43
lines changed

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

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -181,48 +181,6 @@ Rendered input:
181181

182182
![Apify Actor input schema - country input](./images/input-schema-country.png)
183183

184-
Example of date selection using absolute and relative `datepicker` editor:
185-
186-
```json
187-
{
188-
"absoluteDate": {
189-
"title": "Date",
190-
"type": "string",
191-
"description": "Select absolute date in format YYYY-MM-DD",
192-
"editor": "datepicker",
193-
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
194-
},
195-
"relativeDate": {
196-
"title": "Relative date",
197-
"type": "string",
198-
"description": "Select relative date in format +/- {number} {unit}",
199-
"editor": "datepicker",
200-
"dateType": "relative",
201-
"pattern": "^([+-])\\s*(\\d+)\\s*(day|week|month|year)s?$"
202-
},
203-
"anyDate": {
204-
"title": "Any date",
205-
"type": "string",
206-
"description": "Select date in format YYYY-MM-DD or +/- {number} {unit}",
207-
"editor": "datepicker",
208-
"dateType": "absoluteOrRelative",
209-
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^([+-])\\s*(\\d+)\\s*(day|week|month|year)s?$"
210-
}
211-
}
212-
```
213-
214-
The `absoluteDate` property renders a date picker that allows selection of a specific date and returns string value in `YYYY-MM-DD` format. Validation is ensured thanks to `pattern` field. In this case the `dateType` property is omitted, as it defaults to `"absolute"`.
215-
216-
![Apify Actor input schema - country input](./images/input-schema-date-absolute.png)
217-
218-
The `relativeDate` property renders an input field that enables the user to choose the relative date and returns the value in `+/- {number} {unit}` format, for example `"+ 2 days"`. The `dateType` parameter is set to `"relative"` to restrict input to relative dates only.
219-
220-
![Apify Actor input schema - country input](./images/input-schema-date-relative.png)
221-
222-
The `anyDate` 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.
223-
224-
![Apify Actor input schema - country input](./images/input-schema-date-both.png)
225-
226184
Properties:
227185

228186
| Property | Value | Required | Description |
@@ -235,7 +193,6 @@ Properties:
235193
| `enumTitles` | [String] | No | Titles for the `enum` keys described. |
236194
| `nullable` | Boolean | No | Specifies whether `null` <br/>is an allowed value. |
237195
| `isSecret` | Boolean | No | Specifies whether the input field<br />will be stored encrypted.<br />Only available <br />with `textfield` and `textarea` editors. |
238-
| `dateType` | One of <ul><li>`absolute`</li><li>`relative`</li><li>`absoluteOrRelative`</li></ul> | 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.).<br/><br/><ul><li>`absolute` value enables date input in `YYYY-MM-DD` format. To parse returned string regex like this can be used: `^(\d{4})-(0[1-9]\|1[0-2])-(0[1-9]\|[12]\d\|3[01])$`.</li><br/><li>`relative` value 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?$`.</li><br/><li>`absoluteOrRelative` value enables both absolute and relative formats and user can switch between them. It's up to Actor author to parse a determine actual used format - regexes above can be used to check whether the returned string match one of them.</li></ul><br/>Defaults to `absolute`. |
239196

240197
:::note Regex escape
241198

0 commit comments

Comments
 (0)