From 66bf583fc03367214b1a6047182ca3d9cc12bbc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jind=C5=99ich=20B=C3=A4r?= Date: Mon, 17 Aug 2026 22:28:57 +0200 Subject: [PATCH] refactor: link editor types documentation to specification --- packages/json_schemas/output/actor.ide.json | 6 ++-- packages/json_schemas/output/input.ide.json | 6 ++-- packages/json_schemas/output/input.json | 6 ++-- .../input.description-rules.xml | 34 +------------------ 4 files changed, 10 insertions(+), 42 deletions(-) diff --git a/packages/json_schemas/output/actor.ide.json b/packages/json_schemas/output/actor.ide.json index d0130006f..e15c75740 100644 --- a/packages/json_schemas/output/actor.ide.json +++ b/packages/json_schemas/output/actor.ide.json @@ -885,9 +885,9 @@ "schemaBased", "hidden" ], - "description": "UI editor used for input.", - "x-intellij-html-description": "

UI editor used for input.

\n

Usage of this field is based on the selected editor:

\n\n

Editor type requestListSources supports input in formats defined by the\nsources property of\nRequestListOptions.

\n

Editor type globs maps to the Crawlee's GlobInput used by the\nUrlPatterObject.

\n

Editor type select allows the user to pick items from a select, providing multiple choices. Please check this\nexample of how to define the multiselect field:

\n
{\n\"title\": \"Multiselect field\",\n\"description\": \"My multiselect field\",\n\"type\": \"array\",\n\"editor\": \"select\",\n\"items\": {\n\"type\": \"string\",\n\"enum\": [\"value1\", \"value2\", \"value3\"],\n\"enumTitles\": [\"Label of value1\", \"Label of value2\", \"Label of value3\"]\n}\n}\n
", - "markdownDescription": "UI editor used for input.\n\nUsage of this field is based on the selected editor:\n\n* `requestListSources` - value from this field can be used as input for the\n[RequestList](https://crawlee.dev/api/core/class/RequestList) class from Crawlee.\n* `pseudoUrls` - is intended to be used with a combination of the\n[PseudoUrl](https://crawlee.dev/api/core/class/PseudoUrl) class and the\n[enqueueLinks()](https://crawlee.dev/api/core/function/enqueueLinks) function from Crawlee.\n\nEditor type `requestListSources` supports input in formats defined by the\n[sources](https://crawlee.dev/api/core/interface/RequestListOptions#sources) property of\n[RequestListOptions](https://crawlee.dev/api/core/interface/RequestListOptions).\n\nEditor type `globs` maps to the Crawlee's [GlobInput](https://crawlee.dev/api/core#GlobInput) used by the\n[UrlPatterObject](https://crawlee.dev/api/core#UrlPatternObject).\n\nEditor type `select` allows the user to pick items from a select, providing multiple choices. Please check this\nexample of how to define the multiselect field:\n\n```json\n{\n\"title\": \"Multiselect field\",\n\"description\": \"My multiselect field\",\n\"type\": \"array\",\n\"editor\": \"select\",\n\"items\": {\n\"type\": \"string\",\n\"enum\": [\"value1\", \"value2\", \"value3\"],\n\"enumTitles\": [\"Label of value1\", \"Label of value2\", \"Label of value3\"]\n}\n}\n```" + "description": "UI editor used for input. See Input Schema Specification (https://docs.apify.com/actors/development/actor-definition/input-schema/specification/v1#array) for detailed documentation on available editor types.", + "x-intellij-html-description": "

UI editor used for input. See Input Schema Specification for detailed documentation on available editor types.

", + "markdownDescription": "UI editor used for input. See [Input Schema Specification](https://docs.apify.com/actors/development/actor-definition/input-schema/specification/v1#array) for detailed documentation on available editor types." }, "isSecret": { "type": "boolean" diff --git a/packages/json_schemas/output/input.ide.json b/packages/json_schemas/output/input.ide.json index 27f8d1325..a892601ff 100644 --- a/packages/json_schemas/output/input.ide.json +++ b/packages/json_schemas/output/input.ide.json @@ -585,9 +585,9 @@ "schemaBased", "hidden" ], - "description": "UI editor used for input.", - "x-intellij-html-description": "

UI editor used for input.

\n

Usage of this field is based on the selected editor:

\n\n

Editor type requestListSources supports input in formats defined by the\nsources property of\nRequestListOptions.

\n

Editor type globs maps to the Crawlee's GlobInput used by the\nUrlPatterObject.

\n

Editor type select allows the user to pick items from a select, providing multiple choices. Please check this\nexample of how to define the multiselect field:

\n
{\n\"title\": \"Multiselect field\",\n\"description\": \"My multiselect field\",\n\"type\": \"array\",\n\"editor\": \"select\",\n\"items\": {\n\"type\": \"string\",\n\"enum\": [\"value1\", \"value2\", \"value3\"],\n\"enumTitles\": [\"Label of value1\", \"Label of value2\", \"Label of value3\"]\n}\n}\n
", - "markdownDescription": "UI editor used for input.\n\nUsage of this field is based on the selected editor:\n\n* `requestListSources` - value from this field can be used as input for the\n[RequestList](https://crawlee.dev/api/core/class/RequestList) class from Crawlee.\n* `pseudoUrls` - is intended to be used with a combination of the\n[PseudoUrl](https://crawlee.dev/api/core/class/PseudoUrl) class and the\n[enqueueLinks()](https://crawlee.dev/api/core/function/enqueueLinks) function from Crawlee.\n\nEditor type `requestListSources` supports input in formats defined by the\n[sources](https://crawlee.dev/api/core/interface/RequestListOptions#sources) property of\n[RequestListOptions](https://crawlee.dev/api/core/interface/RequestListOptions).\n\nEditor type `globs` maps to the Crawlee's [GlobInput](https://crawlee.dev/api/core#GlobInput) used by the\n[UrlPatterObject](https://crawlee.dev/api/core#UrlPatternObject).\n\nEditor type `select` allows the user to pick items from a select, providing multiple choices. Please check this\nexample of how to define the multiselect field:\n\n```json\n{\n\"title\": \"Multiselect field\",\n\"description\": \"My multiselect field\",\n\"type\": \"array\",\n\"editor\": \"select\",\n\"items\": {\n\"type\": \"string\",\n\"enum\": [\"value1\", \"value2\", \"value3\"],\n\"enumTitles\": [\"Label of value1\", \"Label of value2\", \"Label of value3\"]\n}\n}\n```" + "description": "UI editor used for input. See Input Schema Specification (https://docs.apify.com/actors/development/actor-definition/input-schema/specification/v1#array) for detailed documentation on available editor types.", + "x-intellij-html-description": "

UI editor used for input. See Input Schema Specification for detailed documentation on available editor types.

", + "markdownDescription": "UI editor used for input. See [Input Schema Specification](https://docs.apify.com/actors/development/actor-definition/input-schema/specification/v1#array) for detailed documentation on available editor types." }, "isSecret": { "type": "boolean" diff --git a/packages/json_schemas/output/input.json b/packages/json_schemas/output/input.json index e462048d2..235408852 100644 --- a/packages/json_schemas/output/input.json +++ b/packages/json_schemas/output/input.json @@ -586,9 +586,9 @@ "schemaBased", "hidden" ], - "description": "UI editor used for input.", - "x-intellij-html-description": "

UI editor used for input.

\n

Usage of this field is based on the selected editor:

\n\n

Editor type requestListSources supports input in formats defined by the\nsources property of\nRequestListOptions.

\n

Editor type globs maps to the Crawlee's GlobInput used by the\nUrlPatterObject.

\n

Editor type select allows the user to pick items from a select, providing multiple choices. Please check this\nexample of how to define the multiselect field:

\n
{\n\"title\": \"Multiselect field\",\n\"description\": \"My multiselect field\",\n\"type\": \"array\",\n\"editor\": \"select\",\n\"items\": {\n\"type\": \"string\",\n\"enum\": [\"value1\", \"value2\", \"value3\"],\n\"enumTitles\": [\"Label of value1\", \"Label of value2\", \"Label of value3\"]\n}\n}\n
", - "markdownDescription": "UI editor used for input.\n\nUsage of this field is based on the selected editor:\n\n* `requestListSources` - value from this field can be used as input for the\n[RequestList](https://crawlee.dev/api/core/class/RequestList) class from Crawlee.\n* `pseudoUrls` - is intended to be used with a combination of the\n[PseudoUrl](https://crawlee.dev/api/core/class/PseudoUrl) class and the\n[enqueueLinks()](https://crawlee.dev/api/core/function/enqueueLinks) function from Crawlee.\n\nEditor type `requestListSources` supports input in formats defined by the\n[sources](https://crawlee.dev/api/core/interface/RequestListOptions#sources) property of\n[RequestListOptions](https://crawlee.dev/api/core/interface/RequestListOptions).\n\nEditor type `globs` maps to the Crawlee's [GlobInput](https://crawlee.dev/api/core#GlobInput) used by the\n[UrlPatterObject](https://crawlee.dev/api/core#UrlPatternObject).\n\nEditor type `select` allows the user to pick items from a select, providing multiple choices. Please check this\nexample of how to define the multiselect field:\n\n```json\n{\n\"title\": \"Multiselect field\",\n\"description\": \"My multiselect field\",\n\"type\": \"array\",\n\"editor\": \"select\",\n\"items\": {\n\"type\": \"string\",\n\"enum\": [\"value1\", \"value2\", \"value3\"],\n\"enumTitles\": [\"Label of value1\", \"Label of value2\", \"Label of value3\"]\n}\n}\n```" + "description": "UI editor used for input. See Input Schema Specification (https://docs.apify.com/actors/development/actor-definition/input-schema/specification/v1#array) for detailed documentation on available editor types.", + "x-intellij-html-description": "

UI editor used for input. See Input Schema Specification for detailed documentation on available editor types.

", + "markdownDescription": "UI editor used for input. See [Input Schema Specification](https://docs.apify.com/actors/development/actor-definition/input-schema/specification/v1#array) for detailed documentation on available editor types." }, "isSecret": { "type": "boolean" diff --git a/packages/json_schemas/rules/add-description/input.description-rules.xml b/packages/json_schemas/rules/add-description/input.description-rules.xml index 9e9e07b0e..cb8308421 100644 --- a/packages/json_schemas/rules/add-description/input.description-rules.xml +++ b/packages/json_schemas/rules/add-description/input.description-rules.xml @@ -270,39 +270,7 @@ Allowed type for the input value. Cannot be mixed. - UI editor used for input. - - Usage of this field is based on the selected editor: - - * `requestListSources` - value from this field can be used as input for the - [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). - - Editor type `globs` maps to the Crawlee's [GlobInput](https://crawlee.dev/api/core#GlobInput) used by the - [UrlPatterObject](https://crawlee.dev/api/core#UrlPatternObject). - - Editor type `select` allows the user to pick items from a select, providing multiple choices. Please check this - example of how to define the multiselect field: - - ```json - { - "title": "Multiselect field", - "description": "My multiselect field", - "type": "array", - "editor": "select", - "items": { - "type": "string", - "enum": ["value1", "value2", "value3"], - "enumTitles": ["Label of value1", "Label of value2", "Label of value3"] - } - } - ``` + UI editor used for input. See [Input Schema Specification](https://docs.apify.com/actors/development/actor-definition/input-schema/specification/v1#array) for detailed documentation on available editor types. Allowed type for the input value. Cannot be mixed.