Skip to content

feat: Add ActorJob and ActorJobResponse schemas to OpenAPI spec #2284

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vdusek wants to merge 1 commit into from
Closed

feat: Add ActorJob and ActorJobResponse schemas to OpenAPI spec #2284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions apify-api/openapi/components/schemas/common/ActorJob.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
title: ActorJob
description: Minimal model for an Actor job (run or build) with status. Used for validation during polling operations.
required:
- status
type: object
properties:
status:
description: Current status of the Actor job.
$ref: ./ActorJobStatus.yaml
8 changes: 8 additions & 0 deletions apify-api/openapi/components/schemas/common/ActorJobResponse.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: ActorJobResponse
description: Response wrapper for an Actor job (run or build). Used for minimal validation during polling operations.
required:
- data
type: object
properties:
data:
$ref: ./ActorJob.yaml
5 changes: 5 additions & 0 deletions apify-api/openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,6 +624,11 @@
/v2/users/me/limits:
$ref: paths/users/users@me@limits.yaml
components:
schemas:
ActorJob:
$ref: components/schemas/common/ActorJob.yaml

Check warning on line 629 in apify-api/openapi/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint specification

oas3-unused-component 

Potentially unused component has been detected.
ActorJobResponse:
$ref: components/schemas/common/ActorJobResponse.yaml

Check warning on line 631 in apify-api/openapi/openapi.yaml

View workflow job for this annotation

GitHub Actions / Lint specification

oas3-unused-component 

Potentially unused component has been detected.
securitySchemes:
httpBearer:
$ref: components/securitySchemes/httpBearer.yaml
Expand Down
Loading