Skip to content

Commit c49d6b8

Browse files
vdusekclaude
andauthored
fix(openapi): Update OpenAPI schemas to match API behaviour (#2291)
## Summary - Adds missing `ActorStandby` schema, missing fields (`actorStandby`, `exampleRunInput`, `isDeprecated`, `title`, `maxItems`, `forcePermissionLevel`), and removes incorrect `required` constraints from request schemas. - Cleans up `UpdateTaskRequest` to only contain mutable fields (removes read-only fields like `id`, `userId`, `createdAt`, etc.). ## Related PRs - apify/apify-client-python#650 Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d87430d commit c49d6b8

File tree

13 files changed

+73
-53
lines changed

13 files changed

+73
-53
lines changed

apify-api/openapi/components/schemas/actor-tasks/CreateTaskRequest.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,9 @@ properties:
1818
anyOf:
1919
- $ref: ./TaskInput.yaml
2020
- type: "null"
21+
title:
22+
type: [string, "null"]
23+
actorStandby:
24+
anyOf:
25+
- $ref: ../actors/ActorStandby.yaml
26+
- type: "null"

apify-api/openapi/components/schemas/actor-tasks/Task.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ properties:
4646
anyOf:
4747
- $ref: ./TaskInput.yaml
4848
- type: "null"
49+
title:
50+
type: [string, "null"]
51+
actorStandby:
52+
anyOf:
53+
- $ref: ../actors/ActorStandby.yaml
54+
- type: "null"
4955
standbyUrl:
5056
type: [string, "null"]
5157
format: uri

apify-api/openapi/components/schemas/actor-tasks/TaskOptions.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ properties:
1313
restartOnError:
1414
type: [boolean, "null"]
1515
examples: [false]
16+
maxItems:
17+
type: [integer, "null"]
Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,9 @@
11
title: UpdateTaskRequest
2-
required:
3-
- id
4-
- userId
5-
- actId
6-
- name
7-
- createdAt
8-
- modifiedAt
92
type: object
103
properties:
11-
id:
12-
type: string
13-
examples: [ZxLNxrRaZrSjuhT9y]
14-
userId:
15-
type: string
16-
examples: [BPWZBd7Z9c746JAnF]
17-
actId:
18-
type: string
19-
examples: [asADASadYvn4mBZmm]
204
name:
215
type: string
226
examples: [my-task]
23-
username:
24-
type: [string, "null"]
25-
examples: [janedoe]
26-
createdAt:
27-
type: string
28-
format: date-time
29-
examples: ["2018-10-26T07:23:14.855Z"]
30-
modifiedAt:
31-
type: string
32-
format: date-time
33-
examples: ["2018-10-26T13:30:49.578Z"]
34-
removedAt:
35-
type: [string, "null"]
36-
format: date-time
37-
stats:
38-
anyOf:
39-
- $ref: ./TaskStats.yaml
40-
- type: "null"
417
options:
428
anyOf:
439
- $ref: ./TaskOptions.yaml
@@ -46,3 +12,9 @@ properties:
4612
anyOf:
4713
- $ref: ./TaskInput.yaml
4814
- type: "null"
15+
title:
16+
type: [string, "null"]
17+
actorStandby:
18+
anyOf:
19+
- $ref: ../actors/ActorStandby.yaml
20+
- type: "null"

apify-api/openapi/components/schemas/actors/Actor.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ properties:
7474
anyOf:
7575
- $ref: ./TaggedBuilds.yaml
7676
- type: "null"
77+
actorStandby:
78+
anyOf:
79+
- $ref: ./ActorStandby.yaml
80+
- type: "null"
7781
readmeSummary:
7882
type: string
7983
description: A brief, LLM-generated readme summary
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
title: ActorStandby
2+
type: object
3+
properties:
4+
isEnabled:
5+
type: [boolean, "null"]
6+
desiredRequestsPerActorRun:
7+
type: [integer, "null"]
8+
maxRequestsPerActorRun:
9+
type: [integer, "null"]
10+
idleTimeoutSecs:
11+
type: [integer, "null"]
12+
build:
13+
type: [string, "null"]
14+
memoryMbytes:
15+
type: [integer, "null"]
16+
disableStandbyFieldsOverride:
17+
type: [boolean, "null"]
18+
shouldPassActorInput:
19+
type: [boolean, "null"]

apify-api/openapi/components/schemas/actors/CreateActorRequest.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,13 @@ properties:
3939
description: ""
4040
defaultRunOptions:
4141
$ref: ./DefaultRunOptions.yaml
42+
actorStandby:
43+
anyOf:
44+
- $ref: ./ActorStandby.yaml
45+
- type: "null"
46+
exampleRunInput:
47+
anyOf:
48+
- $ref: ./ExampleRunInput.yaml
49+
- type: "null"
50+
isDeprecated:
51+
type: [boolean, "null"]

apify-api/openapi/components/schemas/actors/DefaultRunOptions.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
title: defaultRunOptions
2-
required:
3-
- build
4-
- memoryMbytes
52
type: object
63
properties:
74
build:
@@ -16,3 +13,9 @@ properties:
1613
restartOnError:
1714
type: boolean
1815
examples: [false]
16+
maxItems:
17+
type: [integer, "null"]
18+
forcePermissionLevel:
19+
anyOf:
20+
- $ref: ./ActorPermissionLevel.yaml
21+
- type: "null"

apify-api/openapi/components/schemas/actors/ExampleRunInput.yaml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
title: exampleRunInput
2-
required:
3-
- body
4-
- contentType
52
type: object
63
properties:
74
body:

apify-api/openapi/components/schemas/actors/UpdateActorRequest.yaml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,13 @@ properties:
9292
latest:
9393
buildId: z2EryhbfhgSyqj6Hn
9494
beta: null
95-
required:
96-
- name
97-
- isPublic
98-
- versions
95+
actorStandby:
96+
anyOf:
97+
- $ref: ./ActorStandby.yaml
98+
- type: "null"
99+
exampleRunInput:
100+
anyOf:
101+
- $ref: ./ExampleRunInput.yaml
102+
- type: "null"
103+
isDeprecated:
104+
type: [boolean, "null"]

0 commit comments

Comments
 (0)