Skip to content
Draft
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
5 changes: 5 additions & 0 deletions apify-api/openapi/components/examples/actor-not-found.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
summary: Actor was not found
value:
error:
type: actor-not-found
message: Actor was not found.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
summary: Actor run was not found
value:
error:
type: record-not-found
message: Actor run was not found
29 changes: 29 additions & 0 deletions apify-api/openapi/components/examples/build-response.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
value:
data:
id: HG7ML7M8z78YcAPEB
actId: janedoe~my-actor
userId: klmdEpoiojmdEMlk3
startedAt: "2019-11-30T07:34:24.202Z"
finishedAt: "2019-12-12T09:30:12.202Z"
status: SUCCEEDED
meta:
origin: WEB
clientIp: 172.234.12.34
userAgent: Mozilla/5.0 (iPad)
stats:
durationMillis: 1000
runTimeSecs: 45.718
computeUnits: 0.012699444444444444
options:
useCache: false
betaPackages: false
memoryMbytes: 1024
diskMbytes: 2048
usage:
ACTOR_COMPUTE_UNITS: 0.08
usageTotalUsd: 0.02
usageUsd:
ACTOR_COMPUTE_UNITS: 0.02
inputSchema: '{\n \"title\": \"Schema for ... }'
readme: '# Magic Actor\nThis Actor is magic.'
buildNumber: 0.1.1
36 changes: 36 additions & 0 deletions apify-api/openapi/components/examples/run-list-response.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
value:
data:
total: 2
offset: 0
limit: 1000
desc: false
count: 2
items:
- id: HG7ML7M8z78YcAPEB
actId: HDSasDasz78YcAPEB
actorTaskId: KJHSKHausidyaJKHs
status: SUCCEEDED
startedAt: "2019-11-30T07:34:24.202Z"
finishedAt: "2019-12-12T09:30:12.202Z"
buildId: HG7ML7M8z78YcAPEB
buildNumber: 0.0.2
meta:
origin: WEB
usageTotalUsd: 0.2
defaultKeyValueStoreId: sfAjeR4QmeJCQzTfe
defaultDatasetId: 3ZojQDdFTsyE7Moy4
defaultRequestQueueId: so93g2shcDzK3pA85
- id: HG7ML7M8z78YcAPEB
actId: HDSasDasz78YcAPEB
actorTaskId: KJHSKHausidyaJKHs
status: FAILED
startedAt: "2019-12-12T07:34:14.202Z"
finishedAt: "2019-12-13T08:36:13.202Z"
buildId: u78dML7M8z78YcAPEB
buildNumber: 0.2.2
meta:
origin: DEVELOPMENT
usageTotalUsd: 0.6
defaultKeyValueStoreId: sffsouqlseJCQzTfe
defaultDatasetId: CFGggdjQDsyE7Moyw
defaultRequestQueueId: soowucklrmDzKpA8x
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
value:
data:
id: HG7ML7M8z78YcAPEB
actId: janedoe~my-actor
userId: PNWZBd7Z9c746JAnF
startedAt: "2019-11-30T07:34:24.202Z"
finishedAt: null
status: RUNNING
statusMessage: Actor is running
isStatusMessageTerminal: false
meta:
origin: WEB
clientIp: 172.234.12.34
userAgent: Mozilla/5.0 (iPad)
stats:
inputBodyLen: 240
migrationCount: 0
restartCount: 0
resurrectCount: 1
memAvgBytes: 35914228.4
memMaxBytes: 38244352
memCurrentBytes: 0
cpuAvgUsage: 0.00955965
cpuMaxUsage: 3.1546
cpuCurrentUsage: 0
netRxBytes: 2652
netTxBytes: 1338
durationMillis: 26239
runTimeSecs: 26.239
metamorph: 0
computeUnits: 0.0072886
options:
build: latest
timeoutSecs: 300
memoryMbytes: 1024
diskMbytes: 2048
buildId: HG7ML7M8z78YcAPEB
exitCode: 0
generalAccess: RESTRICTED
defaultKeyValueStoreId: eJNzqsbPiopwJcgGQ
defaultDatasetId: wmKPijuyDnPZAPRMk
defaultRequestQueueId: FL35cSF7jrxr3BY39
metamorphs:
- createdAt: "2019-11-30T07:39:24.202Z"
actorId: nspoEjklmnsF2oosD
buildId: ME6oKecqy5kXDS4KQ
inputKey: INPUT-METAMORPH-1
buildNumber: 0.1.10
containerUrl: "https://hfewsyknno9o.runs.apify.com"
isContainerServerReady: false
gitBranchName: master
usage:
ACTOR_COMPUTE_UNITS: 3
DATASET_READS: 4
DATASET_WRITES: 4
KEY_VALUE_STORE_READS: 5
KEY_VALUE_STORE_WRITES: 3
KEY_VALUE_STORE_LISTS: 5
REQUEST_QUEUE_READS: 2
REQUEST_QUEUE_WRITES: 1
DATA_TRANSFER_INTERNAL_GBYTES: 1
DATA_TRANSFER_EXTERNAL_GBYTES: 3
PROXY_RESIDENTIAL_TRANSFER_GBYTES: 34
PROXY_SERPS: 3
usageTotalUsd: 0.2654
usageUsd:
ACTOR_COMPUTE_UNITS: 0.072
DATASET_READS: 0.0004
DATASET_WRITES: 0.0002
KEY_VALUE_STORE_READS: 0.0006
KEY_VALUE_STORE_WRITES: 0.002
KEY_VALUE_STORE_LISTS: 0.004
REQUEST_QUEUE_READS: 0.005
REQUEST_QUEUE_WRITES: 0.02
DATA_TRANSFER_INTERNAL_GBYTES: 0.0004
DATA_TRANSFER_EXTERNAL_GBYTES: 0.0002
PROXY_RESIDENTIAL_TRANSFER_GBYTES: 0.16
PROXY_SERPS: 0.0006
74 changes: 74 additions & 0 deletions apify-api/openapi/components/examples/run-response.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
value:
data:
id: HG7ML7M8z78YcAPEB
actId: HDSasDasz78YcAPEB
userId: 7sT5jcggjjA9fNcxF
actorTaskId: KJHSKHausidyaJKHs
startedAt: "2019-11-30T07:34:24.202Z"
finishedAt: "2019-12-12T09:30:12.202Z"
status: RUNNING
statusMessage: Actor is running
isStatusMessageTerminal: false
meta:
origin: WEB
clientIp: 172.234.12.34
userAgent: Mozilla/5.0 (iPad)
stats:
inputBodyLen: 240
migrationCount: 0
restartCount: 0
resurrectCount: 2
memAvgBytes: 267874071.9
memMaxBytes: 404713472
memCurrentBytes: 0
cpuAvgUsage: 33.75321011075384
cpuMaxUsage: 169.65073553494125
cpuCurrentUsage: 0
netRxBytes: 103508042
netTxBytes: 4854600
durationMillis: 248472
runTimeSecs: 248.472
metamorph: 0
computeUnits: 0.13804
options:
build: latest
timeoutSecs: 300
memoryMbytes: 1024
diskMbytes: 2048
buildId: 7sT5jcggjjA9fNcxF
exitCode: 0
generalAccess: RESTRICTED
defaultKeyValueStoreId: eJNzqsbPiopwJcgGQ
defaultDatasetId: wmKPijuyDnPZAPRMk
defaultRequestQueueId: FL35cSF7jrxr3BY39
buildNumber: 0.0.36
containerUrl: "https://g8kd8kbc5ge8.runs.apify.net"
isContainerServerReady: true
gitBranchName: master
usage:
ACTOR_COMPUTE_UNITS: 3
DATASET_READS: 4
DATASET_WRITES: 4
KEY_VALUE_STORE_READS: 5
KEY_VALUE_STORE_WRITES: 3
KEY_VALUE_STORE_LISTS: 5
REQUEST_QUEUE_READS: 2
REQUEST_QUEUE_WRITES: 1
DATA_TRANSFER_INTERNAL_GBYTES: 1
DATA_TRANSFER_EXTERNAL_GBYTES: 3
PROXY_RESIDENTIAL_TRANSFER_GBYTES: 34
PROXY_SERPS: 3
usageTotalUsd: 0.2654
usageUsd:
ACTOR_COMPUTE_UNITS: 0.072
DATASET_READS: 0.0004
DATASET_WRITES: 0.0002
KEY_VALUE_STORE_READS: 0.0006
KEY_VALUE_STORE_WRITES: 0.002
KEY_VALUE_STORE_LISTS: 0.004
REQUEST_QUEUE_READS: 0.005
REQUEST_QUEUE_WRITES: 0.02
DATA_TRANSFER_INTERNAL_GBYTES: 0.0004
DATA_TRANSFER_EXTERNAL_GBYTES: 0.0002
PROXY_RESIDENTIAL_TRANSFER_GBYTES: 0.16
PROXY_SERPS: 0.0006
8 changes: 8 additions & 0 deletions apify-api/openapi/components/parameters/actorId.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: actorId
in: path
description: Actor ID or a tilde-separated owner's username and Actor name.
required: true
style: simple
schema:
type: string
example: janedoe~my-actor
8 changes: 8 additions & 0 deletions apify-api/openapi/components/parameters/actorTaskId.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: actorTaskId
in: path
description: Task ID or a tilde-separated owner's username and Actor task name.
required: true
style: simple
schema:
type: string
example: janedoe~my-task
11 changes: 11 additions & 0 deletions apify-api/openapi/components/parameters/gracefully.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: gracefully
in: query
description: |
If true passed, the Actor run will abort gracefully.
It will send `aborting` and `persistState` event into run and force-stop the run after 30 seconds.
It is helpful in cases where you plan to resurrect the run later.
style: form
explode: true
schema:
type: boolean
example: true
13 changes: 13 additions & 0 deletions apify-api/openapi/components/parameters/metamorph/build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: build
in: query
description: |
Optional build of the target Actor.

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 target
Actor (typically `latest`).
style: form
explode: true
schema:
type: string
example: beta
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: targetActorId
in: query
description: ID of a target Actor that the run should be transformed into.
required: true
style: form
explode: true
schema:
type: string
example: HDSasDasz78YcAPEB
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: status
in: query
description: Filter for the run status. Only the most recent run with this status is used.
style: form
explode: true
schema:
type: string
example: SUCCEEDED
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: waitForFinish
in: query
description: |
The maximum number of seconds the server waits for the run to finish. By
default it is `0`, the maximum value is `60`. <!--
MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->
If the run finishes in time then the returned run object will have a terminal status (e.g. `SUCCEEDED`),
otherwise it will have a transitional status (e.g. `RUNNING`).
style: form
explode: true
schema:
type: number
format: double
18 changes: 18 additions & 0 deletions apify-api/openapi/components/responses/ActorNotFound.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
description: Not found - the requested resource was not found.
content:
application/json:
schema:
$ref: ../schemas/common/ErrorResponse.yaml
examples:
actor-not-found:
summary: Actor was not found
value:
error:
type: actor-not-found
message: Actor was not found.
record-not-found:
summary: Actor run was not found
value:
error:
type: record-not-found
message: Actor run was not found
Loading
Loading