Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: maxItems
in: query
required: false
description: |
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:
type: number
format: double
example: 1000
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: maxTotalChargeUsd
in: query
required: false
description: |
Specifies the maximum cost of the 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.
style: form
explode: true
schema:
type: number
format: double
example: 5
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,9 @@ properties:
diskMbytes:
type: number
example: 2048
maxItems:
type: number
example: 1000
maxTotalChargeUsd:
type: number
example: 5
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,8 @@ post:
schema:
type: number
example: 256
- name: maxItems
in: query
required: false
schema:
type: number
example: 1000
description: |
Optional number of items that the run should return. Used for pay-per-result Actors. The value can only be increased beyond the value specified when the Actor run was started.
- name: maxTotalChargeUsd
in: query
required: false
schema:
type: number
example: 10
description: |
Optional maximum cost of the run, in USD. Used for pay-per-event Actors. The value can only be increased beyond the value specified when the Actor run was started.
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
- $ref: "../../components/parameters/actor-run-options/maxTotalChargeUsd.yaml"
- name: restartOnError
in: query
required: false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,8 @@ get:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
# XXX: do we support maxTotalChargeUsd for task runs?
- name: build
in: query
description: |
Expand Down Expand Up @@ -448,34 +436,8 @@ post:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- name: maxTotalChargeUsd
in: query
description: |
Specifies the maximum cost of the task run. This is
useful for pay-per-event tasks, 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.
style: form
explode: true
schema:
type: number
format: double
example: 5
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
- $ref: "../../components/parameters/actor-run-options/maxTotalChargeUsd.yaml"
- name: restartOnError
in: query
description: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,20 +52,8 @@ get:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
# XXX: do we support maxTotalChargeUsd for task runs?
- name: build
in: query
description: |
Expand Down Expand Up @@ -195,34 +183,8 @@ post:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- name: maxTotalChargeUsd
in: query
description: |
Specifies the maximum cost of the task run. This parameter is
useful for pay-per-event tasks, 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.
style: form
explode: true
schema:
type: number
format: double
example: 5
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
- $ref: "../../components/parameters/actor-run-options/maxTotalChargeUsd.yaml"
- name: restartOnError
in: query
description: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -187,34 +187,8 @@ post:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- name: maxTotalChargeUsd
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.
style: form
explode: true
schema:
type: number
format: double
example: 5
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
- $ref: "../../components/parameters/actor-run-options/maxTotalChargeUsd.yaml"
- name: restartOnError
in: query
description: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,34 +60,8 @@ post:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- name: maxTotalChargeUsd
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.
style: form
explode: true
schema:
type: number
format: double
example: 5
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
- $ref: "../../components/parameters/actor-run-options/maxTotalChargeUsd.yaml"
- name: restartOnError
in: query
description: |
Expand Down Expand Up @@ -471,34 +445,8 @@ get:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- name: maxTotalChargeUsd
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.
style: form
explode: true
schema:
type: number
format: double
example: 5
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
- $ref: "../../components/parameters/actor-run-options/maxTotalChargeUsd.yaml"
- name: restartOnError
in: query
description: |
Expand Down
60 changes: 4 additions & 56 deletions apify-api/openapi/paths/actors/acts@{actorId}@run-sync.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,34 +66,8 @@ post:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- name: maxTotalChargeUsd
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.
style: form
explode: true
schema:
type: number
format: double
example: 5
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
- $ref: "../../components/parameters/actor-run-options/maxTotalChargeUsd.yaml"
- name: restartOnError
in: query
description: |
Expand Down Expand Up @@ -236,34 +210,8 @@ get:
type: number
format: double
example: 256
- 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.
style: form
explode: true
schema:
type: number
format: double
example: 1000
- name: maxTotalChargeUsd
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.
style: form
explode: true
schema:
type: number
format: double
example: 5
- $ref: "../../components/parameters/actor-run-options/maxItems.yaml"
- $ref: "../../components/parameters/actor-run-options/maxTotalChargeUsd.yaml"
- name: restartOnError
in: query
description: |
Expand Down
Loading