From 99fc4f1da4bffbab98c3d56772d977d51c527455 Mon Sep 17 00:00:00 2001 From: Michael Novak Date: Thu, 13 Nov 2025 14:49:20 +0100 Subject: [PATCH 1/3] fix: Update maxItems and maxTotalChargeUsd desc --- ...torTaskId}@run-sync-get-dataset-items.yaml | 20 ++++++++-------- .../actor-tasks@{actorTaskId}@run-sync.yaml | 20 ++++++++-------- .../actor-tasks@{actorTaskId}@runs.yaml | 7 +++--- ...@{actorId}@run-sync-get-dataset-items.yaml | 14 +++++------ .../paths/actors/acts@{actorId}@run-sync.yaml | 24 +++++++++---------- .../paths/actors/acts@{actorId}@runs.yaml | 7 +++--- 6 files changed, 43 insertions(+), 49 deletions(-) diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml index eee73ffa9..148c56f50 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml @@ -58,11 +58,11 @@ get: - name: maxItems in: query description: | - 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 - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: @@ -451,11 +451,11 @@ post: - name: maxItems in: query description: | - 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 - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml index 9782b7b5c..c9c76e756 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml @@ -55,11 +55,11 @@ get: - name: maxItems in: query description: | - 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 - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: @@ -198,11 +198,11 @@ post: - name: maxItems in: query description: | - 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 - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml index 1e9cc1237..8639b27c2 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml @@ -205,10 +205,9 @@ post: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml index 3e9bbfdca..e213b5093 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml @@ -78,10 +78,9 @@ post: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: @@ -489,10 +488,9 @@ get: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml index 209320c11..0d10bb87c 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -84,10 +84,9 @@ post: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: @@ -239,11 +238,11 @@ get: - name: maxItems in: query description: | - 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 - `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + This does NOT guarantee that the Actor will return only this many items. + It only ensures you won't be charged for more than this number of items. + Only works for pay-per-result actors. + Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true schema: @@ -254,10 +253,9 @@ get: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml index e2df1ce35..17ba993b9 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml @@ -220,10 +220,9 @@ post: in: query description: | Specifies the maximum cost of the Actor run. This parameter is - useful for pay-per-event Actors, as it allows you to limit the amount - charged to your subscription. You can access the - maximum cost in your Actor by using the - `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + used only for pay-per-event Actors. It allows you to limit the amount + charged to your subscription. You can access the maximum cost in your + Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. style: form explode: true schema: From b95fc58dcbaaf3dfaf09fba279cab02efa23ade2 Mon Sep 17 00:00:00 2001 From: Michael Novak Date: Tue, 18 Nov 2025 11:33:55 +0100 Subject: [PATCH 2/3] capitalize Actors --- ...or-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml | 8 ++++---- .../actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml | 8 ++++---- .../openapi/paths/actors/acts@{actorId}@run-sync.yaml | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml index 148c56f50..db47faac8 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml @@ -58,10 +58,10 @@ get: - name: maxItems in: query description: | - Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. This does NOT guarantee that the Actor will return only this many items. It only ensures you won't be charged for more than this number of items. - Only works for pay-per-result actors. + Only works for pay-per-result Actors. Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true @@ -451,10 +451,10 @@ post: - name: maxItems in: query description: | - Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. This does NOT guarantee that the Actor will return only this many items. It only ensures you won't be charged for more than this number of items. - Only works for pay-per-result actors. + Only works for pay-per-result Actors. Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true diff --git a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml index c9c76e756..98c9db939 100644 --- a/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml +++ b/apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml @@ -55,10 +55,10 @@ get: - name: maxItems in: query description: | - Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. This does NOT guarantee that the Actor will return only this many items. It only ensures you won't be charged for more than this number of items. - Only works for pay-per-result actors. + Only works for pay-per-result Actors. Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true @@ -198,10 +198,10 @@ post: - name: maxItems in: query description: | - Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. This does NOT guarantee that the Actor will return only this many items. It only ensures you won't be charged for more than this number of items. - Only works for pay-per-result actors. + Only works for pay-per-result Actors. Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true diff --git a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml index 0d10bb87c..ac0b651f1 100644 --- a/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml +++ b/apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml @@ -238,10 +238,10 @@ get: - name: maxItems in: query description: | - Specifies the maximum number of dataset items that will be charged for pay-per-result actors. + Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. This does NOT guarantee that the Actor will return only this many items. It only ensures you won't be charged for more than this number of items. - Only works for pay-per-result actors. + Only works for pay-per-result Actors. Value can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. style: form explode: true From 12542cf19bd592c9521744edca3f8b3b87dd8900 Mon Sep 17 00:00:00 2001 From: Michael Novak Date: Tue, 18 Nov 2025 11:42:06 +0100 Subject: [PATCH 3/3] add them to run options as well --- .../openapi/components/schemas/actor-runs/RunOptions.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml b/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml index 9bf33a4b1..1edfb5b99 100644 --- a/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml +++ b/apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml @@ -4,6 +4,8 @@ required: - timeoutSecs - memoryMbytes - diskMbytes + - maxItems + - maxTotalChargeUsd type: object properties: build: @@ -18,3 +20,9 @@ properties: diskMbytes: type: number example: 2048 + maxItems: + type: number + example: 1000 + maxTotalChargeUsd: + type: number + example: 5