Skip to content
24 changes: 24 additions & 0 deletions apify-api/openapi/components/schemas/actor-builds/Build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,31 @@ properties:
examples: ['# Magic Actor\nThis Actor is magic.']
buildNumber:
type: string
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])(\.[1-9][0-9]{0,4})$
examples: [0.1.1]
actVersion:
title: BuildActVersion
type: object
description: Snapshot of the Actor version that this build was created from.
properties:
sourceType:
$ref: ../actors/VersionSourceType.yaml
buildTag:
type: string
examples: [experimental]
versionNumber:
type: string
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])$
examples: ["0.0"]
gitRepoUrl:
type: string
description: URL of the git repository, present when sourceType is GIT_REPO.
examples: ["https://github.com/apifytech/actor-crawler.git#experimental:web-scraper"]
sourceFiles:
type: array
description: Inline source files, present when sourceType is SOURCE_FILES.
items:
$ref: ../actors/SourceCodeFile.yaml
actorDefinition:
anyOf:
- $ref: ../actors/ActorDefinition.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ required:
- status
- startedAt
- usageTotalUsd
- buildNumber
type: object
properties:
id:
Expand All @@ -12,6 +13,9 @@ properties:
actId:
type: string
examples: [janedoe~my-actor]
userId:
type: string
examples: [klmdEpoiojmdEMlk3]
status:
$ref: ../common/ActorJobStatus.yaml
startedAt:
Expand All @@ -25,5 +29,12 @@ properties:
usageTotalUsd:
type: number
examples: [0.02]
buildNumber:
type: string
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])(\.[1-9][0-9]{0,4})$
examples: [0.1.1]
Comment thread
vdusek marked this conversation as resolved.
buildNumberInt:
type: integer
examples: [10000]
meta:
$ref: ./BuildsMeta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ properties:
computeUnits:
type: number
examples: [0.0126994444444444]
imageSizeBytes:
type: integer
examples: [975770223]
5 changes: 5 additions & 0 deletions apify-api/openapi/components/schemas/actor-runs/Run.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ properties:
type: string
buildNumber:
type: [string, "null"]
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])(\.[1-9][0-9]{0,4})$
examples: [0.0.36]
description: Build number of the Actor build used for this run.
containerUrl:
Expand Down Expand Up @@ -177,3 +178,7 @@ properties:
items:
$ref: ./Metamorph.yaml
- type: "null"
platformUsageBillingModel:
type: string
description: Indicates which party covers platform usage costs for this run.
examples: [USER]
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ properties:
actId:
type: string
examples: [HDSasDasz78YcAPEB]
userId:
type: string
examples: [7sT5jcggjjA9fNcxF]
actorTaskId:
type: [string, "null"]
examples: [KJHSKHausidyaJKHs]
Expand All @@ -36,7 +39,11 @@ properties:
examples: [HG7ML7M8z78YcAPEB]
buildNumber:
type: string
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])(\.[1-9][0-9]{0,4})$
examples: [0.0.2]
buildNumberInt:
type: integer
examples: [10000]
meta:
$ref: ./RunMeta.yaml
usageTotalUsd:
Expand Down
32 changes: 32 additions & 0 deletions apify-api/openapi/components/schemas/actors/Actor.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,35 @@ properties:
readmeSummary:
type: string
description: A brief, LLM-generated readme summary
seoTitle:
type: [string, "null"]
examples: [Web Scraper]
seoDescription:
type: [string, "null"]
examples: ["Crawls websites using Chrome and extracts data from pages using JavaScript."]
pictureUrl:
type: [string, "null"]
examples: ["https://apify-image-uploads-prod.s3.amazonaws.com/.../actor-picture.png"]
standbyUrl:
type: [string, "null"]
examples: ["https://my-actor.apify.actor"]
notice:
type: string
examples: [NONE]
categories:
type: array
items:
type: string
examples: [["DEVELOPER_TOOLS", "OPEN_SOURCE"]]
isCritical:
type: boolean
examples: [false]
isGeneric:
type: boolean
examples: [false]
isSourceCodeHidden:
type: boolean
examples: [false]
hasNoDataset:
type: boolean
examples: [false]
28 changes: 28 additions & 0 deletions apify-api/openapi/components/schemas/actors/ActorStats.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,31 @@ properties:
type: string
format: date-time
examples: ["2019-07-08T14:01:05.546Z"]
actorReviewCount:
type: integer
examples: [69]
actorReviewRating:
type: number
examples: [4.7]
bookmarkCount:
type: integer
examples: [1269]
publicActorRunStats30Days:
type: object
description: Run status counts over the past 30 days.
properties:
ABORTED:
type: integer
examples: [2542]
FAILED:
type: integer
examples: [1234]
SUCCEEDED:
type: integer
examples: [732805]
"TIMED-OUT":
type: integer
examples: [12556]
TOTAL:
type: integer
examples: [749137]
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ type: object
properties:
versionNumber:
type: [string, "null"]
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])$
examples: ["0.0"]
sourceType:
anyOf:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,13 @@ properties:
examples: [z2EryhbfhgSyqj6Hn]
buildNumber:
type: string
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])(\.[1-9][0-9]{0,4})$
description: The build number/version string.
examples: [0.0.2]
buildNumberInt:
type: integer
description: The build number encoded as a single integer.
examples: [42]
finishedAt:
type: [string, "null"]
format: date-time
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ example:
finishedAt: "2019-06-10T11:15:49.286Z"
beta:
buildId: abc123def456
buildNumber: 1.0.0-beta
buildNumber: 1.0.5
finishedAt: "2019-07-15T14:30:00.000Z"
1 change: 1 addition & 0 deletions apify-api/openapi/components/schemas/actors/Version.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ required:
properties:
versionNumber:
type: string
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])$
examples: ["0.0"]
sourceType:
anyOf:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ enum:
- GIT_REPO
- TARBALL
- GITHUB_GIST
- SOURCE_CODE
type: string
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,13 @@ properties:
actRunId:
type: [string, "null"]
examples: [HG7ML7M8z78YcAPEB]
title:
type: [string, "null"]
examples: [My Dataset]
username:
type: string
examples: [janedoe]
generalAccess:
$ref: ../common/GeneralAccess.yaml
stats:
$ref: ./DatasetStats.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
title: DatasetStats
required:
- readCount
- writeCount
- storageBytes
type: object
properties:
readCount:
Expand All @@ -13,4 +9,9 @@ properties:
examples: [3]
storageBytes:
type: integer
description: Total storage size in bytes. Only returned by the single-dataset endpoint.
examples: [783]
inflatedBytes:
type: integer
description: Uncompressed size in bytes. Only returned by the dataset list endpoint.
examples: [0]
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ allOf:
required:
- items
properties:
unnamed:
type: boolean
description: Whether the listing was filtered to only unnamed datasets.
examples: [false]
items:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ properties:
format: uri
description: A public link to access keys of the key-value store directly.
examples: [https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123]
recordsPublicUrl:
type: string
format: uri
description: A public link to access records of the key-value store directly.
examples: [https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records]
schema:
type: [object, "null"]
description: Optional JSON schema describing the keys stored in the key-value store.
urlSigningSecretKey:
type: [string, "null"]
description: A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,6 @@ properties:
s3StorageBytes:
type: integer
examples: [18]
storageBytes:
type: integer
examples: [457225]
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ allOf:
required:
- items
properties:
unnamed:
type: boolean
description: Whether the listing was filtered to only unnamed key-value stores.
examples: [false]
items:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ allOf:
required:
- items
properties:
unnamed:
type: boolean
description: Whether the listing was filtered to only unnamed request queues.
examples: [false]
items:
type: array
description: The array of request queues.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ properties:
examples: [some-name]
userId:
$ref: ./SharedProperties.yaml#/QueueUserId
actId:
type: [string, "null"]
description: The ID of the Actor that created this request queue.
actRunId:
type: [string, "null"]
description: The ID of the Actor run that created this request queue.
createdAt:
$ref: ./SharedProperties.yaml#/QueueCreatedAt
modifiedAt:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,7 @@ properties:
description: The ID of the Actor run that created this request queue.
hadMultipleClients:
$ref: ./SharedProperties.yaml#/HadMultipleClients
generalAccess:
$ref: ../common/GeneralAccess.yaml
stats:
$ref: ./RequestQueueStats.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ Schedule:
examples: [Schedule of actor ...]
title:
type: [string, "null"]
notifications:
title: ScheduleNotifications
type: object
description: Notification settings for this schedule.
properties:
email:
type: boolean
examples: [true]
actions:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,50 @@ properties:
pricingModel:
type: string
examples: [FREE]
apifyMarginPercentage:
type: number
examples: [0.2]
createdAt:
type: string
format: date-time
examples: ["2023-01-01T00:00:00.000Z"]
startedAt:
type: string
format: date-time
examples: ["2023-01-01T00:00:00.000Z"]
notifiedAboutChangeAt:
type: [string, "null"]
format: date-time
examples: [null]
notifiedAboutFutureChangeAt:
type: [string, "null"]
format: date-time
examples: [null]
isPriceChangeNotificationSuppressed:
type: boolean
examples: [false]
forceContainsSignificantPriceChange:
type: boolean
examples: [false]
isPPEPlatformUsagePaidByUser:
type: boolean
examples: [false]
reasonForChange:
type: [string, "null"]
examples: [null]
trialMinutes:
type: [integer, "null"]
examples: [null]
unitName:
type: [string, "null"]
examples: [null]
pricePerUnitUsd:
type: [number, "null"]
examples: [null]
minimalMaxTotalChargeUsd:
type: [number, "null"]
examples: [0.5]
pricingPerEvent:
type: [object, "null"]
description: Per-event pricing configuration for pay-per-event Actors.
additionalProperties: true
Loading
Loading