Skip to content

Commit 6b28a65

Browse files
authored
fix: make action descriptions shorter (#42)
* fix: descriptions * fix: fix typo * fix: fix typo
1 parent 65b9eca commit 6b28a65

File tree

6 files changed

+6
-8
lines changed

6 files changed

+6
-8
lines changed

nodes/Apify/resources/actor-runs/get-run/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const rawOption: INodePropertyOptions = {
1010
value: name,
1111
action: name,
1212
description:
13-
'This is not a single endpoint but an entire group of endpoints that lets you retrieve the run or any of its default storages. The endpoints accept the same HTTP methods and query parameters as the respective storage endpoints.',
13+
'Gets the details of a specific Actor run by its ID. This endpoint is useful for retrieving information about a run, such as its status, storages, and other metadata.',
1414
};
1515

1616
const { properties, option } = runHooks(rawOption, rawProperties);

nodes/Apify/resources/actor-runs/get-user-runs-list/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const rawOption: INodePropertyOptions = {
1010
value: 'Get user runs list',
1111
action: 'Get user runs list',
1212
description:
13-
'Gets a list of all runs for a user The response is a list of objects where each object contains basic information about a single actor run The endpoint supports pagination using the limit and offset parameters and it will not return more than 1000 array elements By default the records are sorted by the startedAt field in ascending order Therefore you can use pagination to incrementally fetch all records while new ones are still being created To sort the records in descending order use desc 1 parameter You can also filter runs by status available statuses',
13+
'Gets a list of Actor runs for the user. This endpoint is useful for retrieving a history of runs, their statuses, and other data.',
1414
};
1515

1616
const { properties, option } = runHooks(rawOption, rawProperties);

nodes/Apify/resources/actor-tasks/run-task/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const rawOption: INodePropertyOptions = {
1010
value: 'Run task',
1111
action: 'Run task',
1212
description:
13-
"Runs an Actor task and immediately returns without waiting for the run to complete. You can optionally override the Actor's input configuration by passing a JSON object as the POST payload and setting the Content-Type HTTP header to application/JSON. If the object in the POST payload doesn't define a particular input property, the Actor run will use the default value defined by the task or by the Actor's input schema if not specified in the task. The response is the Actor run object, as returned by the Get run endpoint. If you want to wait for the run to finish and receive the actual output of the Actor run as the response, use one of the \"run task synchronously\" API endpoints instead. To fetch the Actor run results, which are typically stored in the default dataset, use the ID from the defaultDatasetId field in the response JSON and pass it to the Get items API endpoint",
13+
'Runs an Actor task and immediately returns its details without waiting for the run to complete. You can optionally override the Actors input configuration by providing a custom body.',
1414
};
1515

1616
const { properties, option } = runHooks(rawOption, rawProperties);

nodes/Apify/resources/actors/get-last-run/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const rawOption: INodePropertyOptions = {
1010
value: 'Get last run',
1111
action: 'Get last run',
1212
description:
13-
'This is not a single endpoint but an entire group of endpoints that lets you to retrieve and manage the last run of given Actor or any of its default storages',
13+
'Retrieves the most recent run of an Actor. This endpoint is useful for quickly accessing the latest run details, including its status and storages, without needing to specify a run ID.',
1414
};
1515

1616
const { properties, option } = runHooks(rawOption, rawProperties);

nodes/Apify/resources/actors/run-actor/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ const rawOption: INodePropertyOptions = {
99
name: 'Run an Actor',
1010
value: 'Run actor',
1111
action: 'Run an Actor',
12-
description:
13-
'Runs an Actor and immediately returns without waiting for the run to finish. The POST payload including its Content Type header is passed as INPUT to the Actor usually application JSON The Actor is started with the default options you can override them using various URL query parameters The response is the Run object as returned by the Get run API endpoint If you want to wait for the run to finish and receive the actual output of the Actor as the response please use one of the Run Actor synchronously API endpoints instead To fetch the Actor run results that are typically stored in the default dataset you ll need to pass the ID received in the defaultDatasetId field received in the response JSON to the Get items API endpoint.',
12+
description: 'Runs an Actor and immediately returns without waiting for the run to finish',
1413
};
1514

1615
const { properties, option } = runHooks(rawOption, rawProperties);

nodes/Apify/resources/datasets/get-items/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ const rawOption: INodePropertyOptions = {
99
name: 'Get Items',
1010
value: 'Get items',
1111
action: 'Get items',
12-
description:
13-
'Returns data stored in the dataset in a desired format Response format The format of the response depends on format query parameter The format parameter can have one of the following values JSON jsonl xml html csv xlsx and rss The following table describes how each format is treated Note that CSV XLSX and HTML tables are limited to 500 columns and the column names cannot be longer than 200 characters JSON XML and RSS formats do not have such restrictions Hidden fields The top level fields starting with the character are considered hidden These are useful to store debugging information and can be omitted from the output by providing the skipHidden 1 or clean 1 query parameters For example if you store the following object to the dataset productName iPhone Xs description Welcome to the big screens debug URL https www apple com lae iphone xs crawledAt 2019 01 21T16 06 03 683Z The debug field will be considered as hidden and can be omitted from the results This is useful to provide nice cleaned data to end users while keeping debugging info available if needed The Dataset object returned by the API contains the number of such clean items in thedataset cleanItemCount property XML format extension When exporting results to XML or RSS formats the names of object properties become XML tags and the corresponding values become tag s children For example the following JavaScript object name Paul Newman address type home street 21st city Chicago type office street null city null will be transformed to the following XML snippet name Paul Newman name address type home type street 21st street city Chicago city address address type office type street city address If the JavaScript object contains a property named then its sub properties are exported as attributes of the parent XML element If the parent XML element does not have any child elements then its value is taken from a JavaScript object property named For example the following JavaScript object address type home street 21st city Chicago type office unknown will be transformed to the following XML snippet address type home street 21st street city Chicago city address address type office unknown address This feature is also useful to customize your RSS feeds generated for various websites By default the whole result is wrapped in a items element and each page object is wrapped in a item element You can change this using xmlRoot and xmlRow URL parameters Pagination The generated response supports pagination The pagination is always performed with the granularity of a single item regardless whether unwind parameter was provided By default the Items in the response are sorted by the time they were stored to the database therefore you can use pagination to incrementally fetch the items as they are being added The maximum number of items that will be returned in a single API call is limited to 250 000 If you specify desc 1 query parameter the results are returned in the reverse order than they were stored i e from newest to oldest items Note that only the order of Items is reversed but not the order of the unwind array elements',
12+
description: 'Retrieves items from a dataset',
1413
};
1514

1615
const { properties, option } = runHooks(rawOption, rawProperties);

0 commit comments

Comments
 (0)