Skip to content

fix: Update maxItems and maxTotalChargeUsd desc #2088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fix: Update maxItems and maxTotalChargeUsd desc #2088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99fc4f1
fix: Update maxItems and maxTotalChargeUsd desc
michael-apify Nov 13, 2025
b95fc58
capitalize Actors
michael-apify Nov 18, 2025
12542cf
add them to run options as well
michael-apify Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions apify-api/openapi/components/schemas/actor-runs/RunOptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ required:
- timeoutSecs
- memoryMbytes
- diskMbytes
- maxItems
- maxTotalChargeUsd
Comment on lines +7 to +8
Copy link
Contributor

@janbuchar janbuchar Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these actually required?

type: object
properties:
build:
Expand All @@ -18,3 +20,9 @@ properties:
diskMbytes:
type: number
example: 2048
maxItems:
type: number
example: 1000
maxTotalChargeUsd:
type: number
example: 5
20 changes: 10 additions & 10 deletions ...y-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
20 changes: 10 additions & 10 deletions apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

@janbuchar janbuchar Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see quite a bit of repetition here - could you make some reusable parameter objects and reference them in the relevant endpoints? See https://swagger.io/specification/#components-object

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:
Expand Down Expand Up @@ -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:
Expand Down
7 changes: 3 additions & 4 deletions apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
14 changes: 6 additions & 8 deletions apify-api/openapi/paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
24 changes: 11 additions & 13 deletions apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down
7 changes: 3 additions & 4 deletions apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down