Skip to content

fix(openapi): Deduplicate error schemas and fix titles for codegen compatibility #2398

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

Merged
vdusek merged 7 commits into from
Apr 9, 2026
Merged

fix(openapi): Deduplicate error schemas and fix titles for codegen compatibility #2398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5ce05a6
fix(openapi): Deduplicate error schemas and fix titles for codegen co…
vdusek Apr 7, 2026
f5288da
update
vdusek Apr 8, 2026
6fa7ee2
Merge branch 'master' into fix/openapi-schema-titles-and-error-dedup
vdusek Apr 8, 2026
04c0e0b
Merge branch 'master' into fix/openapi-schema-titles-and-error-dedup
vdusek Apr 8, 2026
b051706
fix(openapi): Rename OptionalRunOptions schema to TaskOptions
vdusek Apr 8, 2026
9bc575f
add ErrorType enum type
vdusek Apr 8, 2026
3b28c7a
better error types definition
vdusek Apr 9, 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
4 changes: 2 additions & 2 deletions .github/workflows/openapi-ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
PR_NUMBER: ${{ github.event.pull_request.number }}
run: |
gh workflow run regenerate_models.yaml \
gh workflow run manual_regenerate_models.yaml \
--repo apify/apify-client-python \
--field docs_pr_number="$PR_NUMBER" \
--field docs_workflow_run_id="${{ github.run_id }}"
Expand All @@ -169,7 +169,7 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
PR_NUMBER: ${{ github.event.pull_request.number }}
# Branch name convention must match what regenerate_models.yaml creates.
# Branch name convention must match what manual_regenerate_models.yaml creates.
run: |
BRANCH="update-models-docs-pr-${PR_NUMBER}"
EXISTING_PR=$(gh pr list \
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/components/schemas/actor-tasks/CreateTaskRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ properties:
examples: [my-task]
options:
anyOf:
- $ref: ../common/OptionalRunOptions.yaml
- $ref: ../common/TaskOptions.yaml
- type: "null"
input:
anyOf:
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/components/schemas/actor-tasks/Task.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ properties:
- type: "null"
options:
anyOf:
- $ref: ../common/OptionalRunOptions.yaml
- $ref: ../common/TaskOptions.yaml
- type: "null"
input:
anyOf:
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/components/schemas/actor-tasks/UpdateTaskRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ properties:
examples: [my-task]
options:
anyOf:
- $ref: ../common/OptionalRunOptions.yaml
- $ref: ../common/TaskOptions.yaml
- type: "null"
input:
anyOf:
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: defaultRunOptions
title: DefaultRunOptions
type: object
properties:
build:
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/components/schemas/actors/EnvVarResponse.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: CreateEnvironmentVariableResponse
title: EnvVarResponse
required:
- data
type: object
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/components/schemas/actors/ExampleRunInput.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: exampleRunInput
title: ExampleRunInput
type: object
properties:
body:
Expand Down
2 changes: 1 addition & 1 deletion apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: ActUpdate
title: UpdateActorRequest
type: object
properties:
name:
Expand Down
8 changes: 8 additions & 0 deletions apify-api/openapi/components/schemas/common/ErrorDetail.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: ErrorDetail
type: object
properties:
type:
$ref: ErrorType.yaml
message:
type: string
description: Human-readable error message describing what went wrong.
27 changes: 21 additions & 6 deletions apify-api/openapi/components/schemas/common/ErrorResponse.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,30 @@ required:
type: object
properties:
error:
title: ErrorDetail
type: object
required:
- type
- message
properties:
type:
title: ErrorType
type: string
examples: [run-failed]
description: Machine-processable error type identifier.
enum:
- actor-memory-limit-exceeded
- actor-not-found
- invalid-input
- method-not-allowed
- permission-denied
- rate-limit-exceeded
- record-not-found
- record-not-unique
- record-or-token-not-found
- request-id-invalid
- request-too-large
- run-failed
- run-timeout-exceeded
- token-not-valid
- unknown-build-tag
- unsupported-content-encoding
message:
type: string
examples:
- "Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)"
description: Human-readable error message describing what went wrong.
20 changes: 20 additions & 0 deletions apify-api/openapi/components/schemas/common/ErrorType.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
title: ErrorType
type: string
description: Machine-processable error type identifier.
enum:
- actor-memory-limit-exceeded
- actor-not-found
- invalid-input
- method-not-allowed
- permission-denied
- rate-limit-exceeded
- record-not-found
- record-not-unique
- record-or-token-not-found
- request-id-invalid
- request-too-large
- run-failed
- run-timeout-exceeded
- token-not-valid
- unknown-build-tag
- unsupported-content-encoding
2 changes: 1 addition & 1 deletion ...ts/schemas/common/OptionalRunOptions.yaml → ...omponents/schemas/common/TaskOptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: OptionalRunOptions
title: TaskOptions
type: object
properties:
build:
Expand Down
131 changes: 75 additions & 56 deletions apify-api/openapi/components/schemas/common/errors/ActorErrors.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,90 +1,109 @@
ActorNotFoundErrorDetail:
allOf:
- $ref: ../ErrorDetail.yaml
- type: object
properties:
type:
const: actor-not-found

RecordNotFoundErrorDetail:
allOf:
- $ref: ../ErrorDetail.yaml
- type: object
properties:
type:
const: record-not-found

RecordOrTokenNotFoundErrorDetail:
allOf:
- $ref: ../ErrorDetail.yaml
- type: object
properties:
type:
const: record-or-token-not-found

RunFailedErrorDetail:
allOf:
- $ref: ../ErrorDetail.yaml
- type: object
properties:
type:
const: run-failed

RunTimeoutExceededErrorDetail:
allOf:
- $ref: ../ErrorDetail.yaml
- type: object
properties:
type:
const: run-timeout-exceeded

ActorNotFoundError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [actor-not-found]
message:
type: string
example: Actor was not found
$ref: "#/ActorNotFoundErrorDetail"
example:
error:
type: actor-not-found
message: Actor was not found

ActorBuildNotFoundError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [record-not-found]
message:
type: string
example: Actor build was not found
$ref: "#/RecordNotFoundErrorDetail"
example:
error:
type: record-not-found
message: Actor build was not found

RecordOrTokenNotFoundError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [record-or-token-not-found]
message:
type: string
example: Actor was not found or access denied
$ref: "#/RecordOrTokenNotFoundErrorDetail"
example:
error:
type: record-or-token-not-found
message: Actor was not found or access denied

ActorRunNotFoundError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [record-not-found]
message:
type: string
example: Actor run was not found
$ref: "#/RecordNotFoundErrorDetail"
example:
error:
type: record-not-found
message: Actor run was not found

ActorRunTimeoutExceededError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [run-timeout-exceeded]
message:
type: string
example: Actor run exceeded the timeout of 300 seconds for this API endpoint
$ref: "#/RunTimeoutExceededErrorDetail"
example:
error:
type: run-timeout-exceeded
message: Actor run exceeded the timeout of 300 seconds for this API endpoint

ActorRunFailedError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [run-failed]
message:
type: string
example: "Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)"
$ref: "#/RunFailedErrorDetail"
example:
error:
type: run-failed
message: "Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)"

ActorVersionNotFoundError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [record-not-found]
message:
type: string
example: Actor version was not found
$ref: "#/RecordNotFoundErrorDetail"
example:
error:
type: record-not-found
message: Actor version was not found
21 changes: 13 additions & 8 deletions apify-api/openapi/components/schemas/common/errors/BuildErrors.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
UnknownBuildTagErrorDetail:
allOf:
- $ref: ../ErrorDetail.yaml
- type: object
properties:
type:
const: unknown-build-tag

UnknownBuildTagError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [unknown-build-tag]
message:
type: string
example: 'Build with tag "latest" was not found. Has the Actor been built already?'
$ref: "#/UnknownBuildTagErrorDetail"
example:
error:
type: unknown-build-tag
message: Build with tag "latest" was not found. Has the Actor been built already?
13 changes: 5 additions & 8 deletions apify-api/openapi/components/schemas/common/errors/EnvVariableErrors.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@ EnvironmentVariableNotFoundError:
type: object
properties:
error:
type: object
properties:
type:
type: string
enum: [record-not-found]
message:
type: string
example: Environment variable was not found
$ref: "./ActorErrors.yaml#/RecordNotFoundErrorDetail"
example:
error:
type: record-not-found
message: Environment variable was not found
Loading