Skip to content

Commit 39b39c7

Browse files
committed
fix: Fix OpenApi specs
1 parent d98009d commit 39b39c7

File tree

9 files changed

+56
-57
lines changed

9 files changed

+56
-57
lines changed

apify-api/openapi/components/schemas/actor-runs/Run.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ required:
44
- actId
55
- userId
66
- startedAt
7-
- finishedAt
87
- status
98
- meta
109
- stats
@@ -36,6 +35,7 @@ properties:
3635
example: '2019-11-30T07:34:24.202Z'
3736
finishedAt:
3837
type: string
38+
nullable: true
3939
example: '2019-12-12T09:30:12.202Z'
4040
status:
4141
type: string

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ type: object
33
required:
44
- versionNumber
55
- sourceType
6-
- buildTag
76
properties:
87
versionNumber:
98
type: string
@@ -24,7 +23,7 @@ properties:
2423
example: false
2524
buildTag:
2625
type: string
26+
nullable: true
2727
example: latest
2828
sourceFiles:
2929
$ref: ./VersionSourceFiles.yaml
30-

apify-api/openapi/components/schemas/key-value-stores/KeyValueStoreStats.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ required:
44
- writeCount
55
- deleteCount
66
- listCount
7-
- s3StorageBytes
87
type: object
98
properties:
109
readCount:
@@ -21,4 +20,5 @@ properties:
2120
example: 2
2221
s3StorageBytes:
2322
type: number
23+
nullable: true
2424
example: 18
Lines changed: 45 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,49 @@
11
title: ListOfKeysResponse
22
required:
3-
- items
4-
- count
5-
- limit
6-
- isTruncated
3+
- data
74
type: object
85
properties:
9-
items:
10-
type: array
11-
items:
12-
type: object
13-
title: items
14-
required:
15-
- key
16-
- size
17-
- recordPublicUrl
18-
properties:
19-
key:
20-
type: string
21-
example: second-key
22-
size:
23-
type: number
24-
example: 36
25-
recordPublicUrl:
26-
type: string
27-
description: "A public link to access this record directly."
28-
example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123'
29-
description: ''
30-
count:
31-
type: number
32-
example: 2
33-
limit:
34-
type: number
35-
example: 2
36-
exclusiveStartKey:
37-
type: string
38-
example: some-key
39-
isTruncated:
40-
type: boolean
41-
example: true
42-
nextExclusiveStartKey:
43-
type: string
44-
example: third-key
6+
data:
7+
type: object
8+
required:
9+
- items
10+
- count
11+
- limit
12+
- isTruncated
13+
properties:
14+
items:
15+
type: array
16+
items:
17+
type: object
18+
title: items
19+
required:
20+
- key
21+
- size
22+
- recordPublicUrl
23+
properties:
24+
key:
25+
type: string
26+
example: second-key
27+
size:
28+
type: number
29+
example: 36
30+
recordPublicUrl:
31+
type: string
32+
description: "A public link to access this record directly."
33+
example: 'https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123'
34+
description: ''
35+
count:
36+
type: number
37+
example: 2
38+
limit:
39+
type: number
40+
example: 2
41+
exclusiveStartKey:
42+
type: string
43+
example: some-key
44+
isTruncated:
45+
type: boolean
46+
example: true
47+
nextExclusiveStartKey:
48+
type: string
49+
example: third-key

apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,8 @@ properties:
5151
example: '2022-06-14T23:00:00.000Z'
5252
required:
5353
- id
54-
- retryCount
5554
- uniqueKey
5655
- url
57-
- method
5856
- lockExpiresAt
5957
description: ''
6058
required:

apify-api/openapi/components/schemas/request-queues/ListRequestsResponse.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ properties:
1313
description: ''
1414
count:
1515
type: number
16+
nullable: true
1617
example: 2
1718
limit:
1819
type: number
@@ -22,5 +23,4 @@ properties:
2223
example: Ihnsp8YrvJ8102Kj
2324
required:
2425
- items
25-
- count
2626
- limit
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
title: ProcessedRequest
22
required:
3-
- requestId
43
- uniqueKey
5-
- wasAlreadyHandled
6-
- wasAlreadyPresent
74
type: object
85
properties:
96
requestId:
107
type: string
8+
nullable: true
119
example: sbJ7klsdf7ujN9l
1210
uniqueKey:
1311
type: string
1412
example: 'http://example.com'
1513
wasAlreadyPresent:
1614
type: boolean
15+
nullable: true
1716
example: false
1817
wasAlreadyHandled:
1918
type: boolean
19+
nullable: true
2020
example: false

apify-api/openapi/components/schemas/request-queues/RequestQueueItems.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
title: RequestQueueItems
22
required:
33
- id
4-
- retryCount
54
- uniqueKey
65
- url
7-
- method
86
type: object
97
properties:
108
id:
119
type: string
1210
example: dnjkDMKLmdlkmlkmld
1311
retryCount:
1412
type: number
13+
nullable: true
1514
example: 0
1615
uniqueKey:
1716
type: string
@@ -21,6 +20,7 @@ properties:
2120
example: 'http://example.com'
2221
method:
2322
type: string
23+
nullable: true
2424
example: GET
2525
loadedUrl:
2626
type: string

apify-api/openapi/components/schemas/users/UpdateLimitsRequest.yaml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,9 @@ properties:
55
type: number
66
example: 300
77
description: |
8-
If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra.
9-
Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges
8+
If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges.
109
dataRetentionDays:
1110
type: number
1211
example: 90
1312
description: |
14-
Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible.
15-
Unnamed storages and other Actor runs are automatically deleted after the retention period.
16-
If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)
13+
Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention).

0 commit comments

Comments
 (0)