Skip to content

Commit 3ff2d8c

Browse files
committed
fix(openapi): Add format URI for URI field types
1 parent 4538b38 commit 3ff2d8c

26 files changed

Lines changed: 74 additions & 6 deletions

apify-api/openapi/components/schemas/actor-builds/BuildsMeta.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ properties:
99
example: WEB
1010
clientIp:
1111
type: string
12+
format: ipv4
1213
example: 172.234.12.34
1314
userAgent:
1415
type: string

apify-api/openapi/components/schemas/actor-builds/GetOpenApiResponse.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ properties:
2121
items:
2222
type: object
2323
properties:
24-
url:
24+
url:
2525
type: string
26+
format: uri
2627
example: https://api.apify.com/v2
2728
paths:
2829
type: object

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ properties:
107107
description: Build number of the Actor build used for this run.
108108
containerUrl:
109109
type: string
110+
format: uri
110111
example: 'https://g8kd8kbc5ge8.runs.apify.net'
111112
description: URL of the container running the Actor.
112113
isContainerServerReady:

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,22 @@ properties:
1111
example: latest
1212
timeoutSecs:
1313
type: integer
14+
minimum: 0
1415
example: 300
1516
memoryMbytes:
1617
type: integer
18+
minimum: 128
19+
maximum: 32768
1720
example: 1024
1821
diskMbytes:
1922
type: integer
23+
minimum: 0
2024
example: 2048
2125
maxItems:
2226
type: integer
27+
minimum: 1
2328
example: 1000
2429
maxTotalChargeUsd:
2530
type: number
31+
minimum: 0
2632
example: 5

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,35 @@ type: object
77
properties:
88
inputBodyLen:
99
type: integer
10+
minimum: 0
1011
example: 240
1112
migrationCount:
1213
type: integer
14+
minimum: 0
1315
example: 0
1416
rebootCount:
1517
type: integer
18+
minimum: 0
1619
example: 0
1720
restartCount:
1821
type: integer
22+
minimum: 0
1923
example: 0
2024
resurrectCount:
2125
type: integer
26+
minimum: 0
2227
example: 2
2328
memAvgBytes:
2429
type: number
30+
minimum: 0
2531
example: 267874071.9
2632
memMaxBytes:
2733
type: integer
34+
minimum: 0
2835
example: 404713472
2936
memCurrentBytes:
3037
type: integer
38+
minimum: 0
3139
example: 0
3240
cpuAvgUsage:
3341
type: number
@@ -40,19 +48,25 @@ properties:
4048
example: 0
4149
netRxBytes:
4250
type: integer
51+
minimum: 0
4352
example: 103508042
4453
netTxBytes:
4554
type: integer
55+
minimum: 0
4656
example: 4854600
4757
durationMillis:
4858
type: integer
59+
minimum: 0
4960
example: 248472
5061
runTimeSecs:
5162
type: number
63+
minimum: 0
5264
example: 248.472
5365
metamorph:
5466
type: integer
67+
minimum: 0
5568
example: 0
5669
computeUnits:
5770
type: number
71+
minimum: 0
5872
example: 0.13804

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,5 @@ properties:
5050
- $ref: ./TaskInput.yaml
5151
standbyUrl:
5252
type: string
53+
format: uri
5354
nullable: true

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@ required:
66
- name
77
properties:
88
format:
9-
type: string
10-
enum:
11-
- BASE64
12-
- TEXT
13-
example: TEXT
9+
$ref: ../common/SourceCodeFileFormat.yaml
1410
content:
1511
type: string
1612
example: "console.log('This is the main.js file');"
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
type: string
2+
enum:
3+
- GET
4+
- HEAD
5+
- POST
6+
- PUT
7+
- DELETE
8+
- CONNECT
9+
- OPTIONS
10+
- TRACE
11+
- PATCH
12+
example: GET

apify-api/openapi/components/schemas/common/PaginationResponse.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,17 @@ properties:
1111
total:
1212
type: integer
1313
description: The total number of items available across all pages.
14+
minimum: 0
1415
example: 2
1516
offset:
1617
type: integer
1718
description: The starting position for this page of results.
19+
minimum: 0
1820
example: 0
1921
limit:
2022
type: integer
2123
description: The maximum number of items returned per page.
24+
minimum: 1
2225
example: 1000
2326
desc:
2427
type: boolean
@@ -27,4 +30,5 @@ properties:
2730
count:
2831
type: integer
2932
description: The number of items returned in this response.
33+
minimum: 0
3034
example: 2
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type: string
2+
enum:
3+
- BASE64
4+
- TEXT
5+
example: TEXT

0 commit comments

Comments
 (0)