Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
bf0439e
docs(api): add missing fields to the Actor and schedule request schemas
vdusek Oct 16, 2026
1441f0e
docs(api): define EnvVarRequest as a standalone schema
vdusek Oct 19, 2026
0d16c88
docs(api): drop null from actorPermissionLevel and notifications in c…
vdusek Oct 19, 2026
81998fe
docs(api): drop null from isPublic and versions in CreateActorRequest
vdusek Oct 19, 2026
0ef0363
docs(api): use EnvVarRequest for envVars in CreateOrUpdateVersionRequest
vdusek Oct 19, 2026
e78ea9f
docs(api): use CreateOrUpdateVersionRequest for versions in CreateAct…
vdusek Oct 19, 2026
4afac3d
docs(api): require versionNumber and sourceType on versions in Create…
vdusek Oct 19, 2026
301276f
docs(api): split CreateOrUpdateVersionRequest into create and update …
vdusek Oct 19, 2026
f7f64a3
docs(api): reject SOURCE_CODE in version request schemas
vdusek Oct 19, 2026
401d52a
docs(api): rename VersionSourceTypeRequest to WritableVersionSourceType
vdusek Oct 19, 2026
c1c6c65
docs(api): require at least one version in the Actor request schemas
vdusek Oct 19, 2026
4d0e682
docs(api): drop null from actorPermissionLevel in UpdateActorRequest
vdusek Oct 19, 2026
43e9f1f
docs(api): require the source field matching sourceType in CreateVers…
vdusek Oct 19, 2026
540de31
docs(api): cap versions at 10 in the Actor request schemas
vdusek Oct 19, 2026
2d5dec4
docs(api): drop null from source URLs in UpdateVersionRequest
vdusek Oct 19, 2026
a6b8c72
docs(api): drop null from envVars in the version request schemas
vdusek Oct 19, 2026
5e45e79
docs(api): require the matching source field when UpdateVersionReques…
vdusek Oct 19, 2026
df888c0
docs(api): allow only false for isPublic in CreateActorRequest
vdusek Oct 19, 2026
08f48bc
docs(api): add the API's length and character limits to EnvVarRequest
vdusek Oct 19, 2026
0f1773a
docs(api): add URL patterns to the version source fields
vdusek Oct 19, 2026
2466f0b
docs(api): add the API's buildTag limits to the version request schemas
vdusek Oct 19, 2026
e111935
docs(api): make the tarball and Gist URL patterns case-insensitive
vdusek Oct 19, 2026
f6ca46e
docs(api): allow any boolean for isPublic in CreateActorRequest
vdusek Oct 19, 2026
0cbfe15
docs(api): drop value patterns and length limits from the version and…
vdusek Oct 19, 2026
c1589ee
docs(api): drop the sourceType conditional rules from the version req…
vdusek Oct 19, 2026
395c5f9
docs(api): drop the version count cap from the Actor request schemas
vdusek Oct 19, 2026
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
Expand Up @@ -9,7 +9,7 @@ shared: &shared
content:
application/json:
schema:
$ref: ../../schemas/actors/CreateOrUpdateVersionRequest.yaml
$ref: ../../schemas/actors/UpdateVersionRequest.yaml
example:
versionNumber: "0.0"
sourceType: SOURCE_FILES
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ properties:
Can contain spaces and capital letters. Recommended length is 40-50 characters.
You can change this title without affecting the Actor's URL or SEO.
isPublic:
type: [boolean, "null"]
type: boolean
Comment thread
vdusek marked this conversation as resolved.
examples: [false]
description: Whether the Actor is available to users in Apify Store. If `false`, the Actor is private
and only visible to you.
description: Whether the Actor is available to users in Apify Store. A new Actor is always private.
To publish it, build it first, then update it with `isPublic` set to `true`.
actorPermissionLevel:
$ref: ./ActorPermissionLevel.yaml
seoTitle:
type: [string, "null"]
examples: [Free Instagram scraper]
Expand All @@ -36,11 +38,10 @@ properties:
examples: [false]
deprecated: true # Use defaultRunOptions.restartOnError instead
versions:
anyOf:
- type: array
items:
$ref: ./Version.yaml
- type: "null"
type: array
minItems: 1
Comment thread
vdusek marked this conversation as resolved.
items:
$ref: ./CreateVersionRequest.yaml
Comment thread
vdusek marked this conversation as resolved.
description: "An array of `Version` objects. Each object represents a specific version of the
Actor's source code: its location, builds, and environment configuration."
categories:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
title: CreateOrUpdateVersionRequest
title: CreateVersionRequest
required:
- versionNumber
- sourceType
type: object
properties:
versionNumber:
type: [string, "null"]
type: string
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])$
examples: ["1.6"]
description: The version number of the Actor. Two numbers separated by a dot,
that represent the `MAJOR.MINOR` part of the semantic versioning.
sourceType:
anyOf:
- $ref: ./VersionSourceType.yaml
- type: "null"
$ref: ./WritableVersionSourceType.yaml
description: Where the source code of the version lives.
envVars:
anyOf:
- type: array
items:
$ref: ./EnvVar.yaml
- type: "null"
type: array
items:
$ref: ./EnvVarRequest.yaml
description: Environment variables for the version.
Comment thread
vdusek marked this conversation as resolved.
applyEnvVarsToBuild:
type: [boolean, "null"]
Expand All @@ -32,11 +31,11 @@ properties:
description: Applies when the `sourceType` is `SOURCE_FILES`. Represents the Actor's
file structure as an array of files and folders.
gitRepoUrl:
type: [string, "null"]
type: string
description: URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
tarballUrl:
type: [string, "null"]
type: string
description: URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
gitHubGistUrl:
type: [string, "null"]
type: string
description: URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
21 changes: 17 additions & 4 deletions apify-api/openapi/components/schemas/actors/EnvVarRequest.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
title: EnvVarRequest
allOf:
- $ref: ./EnvVar.yaml
- required:
- value
required:
- name
- value
type: object
properties:
name:
type: string
examples: [MY_ENV_VAR]
description: The name of the environment variable. Can't contain `=`.
value:
type: string
examples: [my-value]
description: The value of the environment variable.
isSecret:
type: [boolean, "null"]
examples: [false]
description: Whether the environment variable is encrypted. Secret values aren't returned by the API.
Comment thread
apify-service-account marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ properties:
description: Whether the Actor is available to users in Apify Store. If `false`, the Actor is private
and only visible to you.
actorPermissionLevel:
anyOf:
- $ref: ./ActorPermissionLevel.yaml
- type: "null"
$ref: ./ActorPermissionLevel.yaml
seoTitle:
type: [string, "null"]
examples: [Free Instagram scraper]
Expand All @@ -41,8 +39,9 @@ properties:
deprecated: true # Use defaultRunOptions.restartOnError instead
versions:
type: array
minItems: 1
Comment thread
vdusek marked this conversation as resolved.
items:
$ref: ./CreateOrUpdateVersionRequest.yaml
$ref: ./CreateVersionRequest.yaml
Comment thread
vdusek marked this conversation as resolved.
description: "An array of `Version` objects. Each object represents a specific version of the
Actor's source code: its location, builds, and environment configuration."
pricingInfos:
Expand Down
Comment thread
vdusek marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
title: UpdateVersionRequest
type: object
properties:
versionNumber:
type: string
pattern: ^([0-9]|[1-9][0-9])\.([0-9]|[1-9][0-9])$
examples: ["1.6"]
description: The version number of the Actor. Two numbers separated by a dot,
that represent the `MAJOR.MINOR` part of the semantic versioning.
sourceType:
$ref: ./WritableVersionSourceType.yaml
Comment thread
vdusek marked this conversation as resolved.
description: Where the source code of the version lives.
envVars:
type: array
items:
$ref: ./EnvVarRequest.yaml
description: Environment variables for the version.
Comment thread
vdusek marked this conversation as resolved.
applyEnvVarsToBuild:
type: [boolean, "null"]
examples: [false]
description: Whether to inject the environment variables at build time.
buildTag:
type: [string, "null"]
examples: [latest]
description: The tag name to apply to a successful build of this version. Can be `null` when the version has no build tag.
Comment thread
vdusek marked this conversation as resolved.
sourceFiles:
$ref: ./VersionSourceFiles.yaml
description: Applies when the `sourceType` is `SOURCE_FILES`. Represents the Actor's
file structure as an array of files and folders.
gitRepoUrl:
type: string
Comment thread
vdusek marked this conversation as resolved.
description: URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`.
tarballUrl:
type: string
description: URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`.
gitHubGistUrl:
type: string
description: URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: WritableVersionSourceType
description: The version source types accepted in request bodies. Same as `VersionSourceType`, without `SOURCE_CODE`.
enum:
- SOURCE_FILES
- GIT_REPO
- TARBALL
- GITHUB_GIST
type: string
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ properties:
examples: [Schedule of actor ...]
title:
type: [string, "null"]
notifications:
$ref: ./ScheduleNotifications.yaml
actions:
type: [array, "null"]
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,7 @@ Schedule:
title:
type: [string, "null"]
notifications:
title: ScheduleNotifications
type: object
description: Notification settings for this schedule.
properties:
email:
type: boolean
examples: [true]
$ref: ./ScheduleNotifications.yaml
actions:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
title: ScheduleNotifications
type: object
description: Notification settings for this schedule.
properties:
email:
type: boolean
examples: [true]
3 changes: 0 additions & 3 deletions apify-api/openapi/paths/actors/acts@{actorId}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,6 @@ put:
value:
name: MyActor
isPublic: false
versions: []
taggedBuilds:
latest:
buildId: z2EryhbfhgSyqj6Hn
Expand All @@ -214,15 +213,13 @@ put:
value:
name: MyActor
isPublic: false
versions: []
taggedBuilds:
latest: null
taggedBuildsMultipleOperations:
summary: Update multiple build tags at once
value:
name: MyActor
isPublic: false
versions: []
taggedBuilds:
latest:
buildId: z2EryhbfhgSyqj6Hn
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ post:
content:
application/json:
schema:
$ref: ../../components/schemas/actors/CreateOrUpdateVersionRequest.yaml
$ref: ../../components/schemas/actors/CreateVersionRequest.yaml
example:
versionNumber: "0.1"
sourceType: GIT_REPO
Expand Down
Loading