Skip to content

Commit 1abdc06

Browse files
authored
feat: Add api doc for maxItems param (#560)
This adds description for `maxItems` param into API doc.
1 parent c57bedc commit 1abdc06

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

sources/platform/api_v2/api_v2_reference.apib

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -953,6 +953,7 @@ received in the response JSON to the [Get items](#reference/datasets/item-collec
953953
+ token: `soSkq9ekdmfOslopH` (string, optional) - API authentication token. Public actors that are configured to be anonymously runnable do not require the token.
954954
+ timeout: 60 (number, optional) - Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the actor.
955955
+ memory: 256 (number, optional) - Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the actor.
956+
+ maxItems: 1000 (number, optional) - The maximum number of items that the actor run should return. This is useful for pay-per-result actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your actor by using the `APIFY_ACTOR_MAX_ITEMS` environment variable.
956957
+ build: `0.1.234` (string, optional) - Specifies the actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the default run configuration for the actor (typically `latest`).
957958
+ waitForFinish: 60 (number, optional) - The maximum number of seconds the server waits for the run to finish. By default, it is `0`, the maximum value is `300`. <!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS -->
958959
If the build finishes in time then the returned run object will have a terminal status (e.g. `SUCCEEDED`),
@@ -989,6 +990,7 @@ received in the response JSON to the [Get items](#reference/datasets/item-collec
989990
in the response. By default, it is `OUTPUT`.
990991
+ timeout: 60 (number, optional) - Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the actor.
991992
+ memory: 256 (number, optional) - Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the actor.
993+
+ maxItems: 1000 (number, optional) - The maximum number of items that the actor run should return. This is useful for pay-per-result actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your actor by using the `APIFY_ACTOR_MAX_ITEMS` environment variable.
992994
+ build: `0.1.234` (string, optional) - Specifies the actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the default run configuration for the actor (typically `latest`).
993995
+ webhooks: `dGhpcyBpcyBqdXN0IGV4YW1wbGUK...` (string, optional) - Specifies optional webhooks associated with the actor run, which can be used to receive a notification
994996
e.g. when the actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see
@@ -1106,6 +1108,7 @@ To run the actor asynchronously, use the [Run actor](#reference/actors/run-colle
11061108
+ token: `soSkq9ekdmfOslopH` (string, optional) - API authentication token. Public actors that are configured to be anonymously runnable do not require token parameter.
11071109
+ timeout: 60 (number, optional) - Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the actor.
11081110
+ memory: 256 (number, optional) - Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the actor.
1111+
+ maxItems: 1000 (number, optional) - The maximum number of items that the actor run should return. This is useful for pay-per-result actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your actor by using the `APIFY_ACTOR_MAX_ITEMS` environment variable.
11091112
+ build: `0.1.234` (string, optional) - Specifies the actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the default run configuration for the actor (typically `latest`).
11101113
+ webhooks: `dGhpcyBpcyBqdXN0IGV4YW1wbGUK...` (string, optional) - Specifies optional webhooks associated with the actor run, which can be used to receive a notification
11111114
e.g. when the actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see
@@ -1699,6 +1702,7 @@ received in the response JSON to the [Get items](#reference/datasets/item-collec
16991702
+ token: `soSkq9ekdmfOslopH` (string, optional) - API authentication token.
17001703
+ timeout: 60 (number, optional) - Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the task settings.
17011704
+ memory: 256 (number, optional) - Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the task settings.
1705+
+ maxItems: 1000 (number, optional) - The maximum number of items that the actor run should return. This is useful for pay-per-result actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your actor by using the `APIFY_ACTOR_MAX_ITEMS` environment variable.
17021706
+ build: `0.1.234` (string, optional) - Specifies the actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically `latest`).
17031707
+ waitForFinish: 60 (number, optional) - The maximum number of seconds the server waits for the run to finish. By default, it is `0`, the maximum value is `300`. <!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS -->
17041708
If the build finishes in time then the returned run object will have a terminal status (e.g. `SUCCEEDED`),
@@ -1735,6 +1739,7 @@ received in the response JSON to the [Get items](#reference/datasets/item-collec
17351739
+ token: `soSkq9ekdmfOslopH` (string, optional) - API authentication token.
17361740
+ timeout: 60 (number, optional) - Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the task settings.
17371741
+ memory: 256 (number, optional) - Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the task settings.
1742+
+ maxItems: 1000 (number, optional) - The maximum number of items that the task run should return. This is useful for pay-per-result tasks, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your actor by using the `APIFY_ACTOR_MAX_ITEMS` environment variable.
17381743
+ build: `0.1.234` (string, optional) - Specifies the actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically `latest`).
17391744
+ outputRecordKey: `OUTPUT` (string, optional) - Key of the record from run's default key-value store to be returned
17401745
in the response. By default, it is `OUTPUT`.
@@ -1842,6 +1847,7 @@ To run the Task asynchronously, use the [Run task asynchronously](#reference/act
18421847
+ token: `soSkq9ekdmfOslopH` (string, optional) - API authentication token.
18431848
+ timeout: 60 (number, optional) - Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the task settings.
18441849
+ memory: 256 (number, optional) - Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the task settings.
1850+
+ maxItems: 1000 (number, optional) - The maximum number of items that the task run should return. This is useful for pay-per-result tasks, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your actor by using the `APIFY_ACTOR_MAX_ITEMS` environment variable.
18451851
+ build: `0.1.234` (string, optional) - Specifies the actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically `latest`).
18461852
+ webhooks: `dGhpcyBpcyBqdXN0IGV4YW1wbGUK...` (string, optional) - Specifies optional webhooks associated with the actor run, which can be used to receive a notification
18471853
e.g. when the actor finished or failed. The value is a Base64-encoded JSON array of objects defining the webhooks. For more information, see

0 commit comments

Comments
 (0)