Skip to content

Commit 31130a1

Browse files
PijukatelPijukatel
committed
Extract most parameters
1 parent 556443b commit 31130a1

File tree

57 files changed

+656
-2023
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+656
-2023
lines changed

‎apify-api/openapi/components/parameters/DatasetItemsParameters.yaml‎

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
Format:
2+
name: format
3+
in: query
4+
description: |
5+
Format of the results, possible values are: `json`, `jsonl`, `csv`, `html`, `xlsx`, `xml` and `rss`. The default value is `json`.
6+
style: form
7+
explode: true
8+
schema:
9+
type: string
10+
example: json
11+
12+
Clean:
13+
name: clean
14+
in: query
15+
description: |
16+
If `true` or `1` then the API endpoint returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).
17+
The `clean` parameter is just a shortcut for `skipHidden=true` and `skipEmpty=true` parameters.
18+
Note that since some objects might be skipped from the output, that the result might contain less items than the `limit` value.
19+
style: form
20+
explode: true
21+
schema:
22+
type: boolean
23+
example: false
24+
25+
Limit:
26+
name: limit
27+
in: query
28+
description: Maximum number of items to return. By default there is no limit.
29+
style: form
30+
explode: true
31+
schema:
32+
type: number
33+
format: double
34+
35+
Fields:
36+
name: fields
37+
in: query
38+
description: |
39+
A comma-separated list of fields which should be picked from the items, only these fields will remain in the resulting record objects.
40+
Note that the fields in the outputted items are sorted the same way as they are specified in the `fields` query parameter.
41+
You can use this feature to effectively fix the output format.
42+
style: form
43+
explode: true
44+
schema:
45+
type: string
46+
example: "myValue,myOtherValue"
47+
48+
Omit:
49+
name: omit
50+
in: query
51+
description: A comma-separated list of fields which should be omitted from the items.
52+
style: form
53+
explode: true
54+
schema:
55+
type: string
56+
example: "myValue,myOtherValue"
57+
58+
Unwind:
59+
name: unwind
60+
in: query
61+
description: |
62+
A comma-separated list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object.
63+
If the field is an array then every element of the array will become a separate record and merged with parent object.
64+
If the unwound field is an object then it is merged with the parent object.
65+
If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object then the item gets preserved as it is.
66+
Note that the unwound items ignore the `desc` parameter.
67+
style: form
68+
explode: true
69+
schema:
70+
type: string
71+
example: "myValue,myOtherValue"
72+
73+
Flatten:
74+
name: flatten
75+
in: query
76+
description: |
77+
A comma-separated list of fields which should transform nested objects into flat structures.
78+
79+
For example, with `flatten="foo"` the object `{"foo":{"bar": "hello"}}` is turned into `{"foo.bar": "hello"}`.
80+
81+
The original object with properties is replaced with the flattened object.
82+
style: form
83+
explode: true
84+
schema:
85+
type: string
86+
example: myValue
87+
88+
Attachment:
89+
name: attachment
90+
in: query
91+
description: |
92+
If `true` or `1` then the response will define the `Content-Disposition:
93+
attachment` header, forcing a web browser to download the file rather
94+
than to display it. By default this header is not present.
95+
style: form
96+
explode: true
97+
schema:
98+
type: boolean
99+
example: true
100+
101+
Delimiter:
102+
name: delimiter
103+
in: query
104+
description: |
105+
A delimiter character for CSV files, only used if `format=csv`. You
106+
might need to URL-encode the character (e.g. use `%09` for tab or `%3B`
107+
for semicolon). The default delimiter is a simple comma (`,`).
108+
style: form
109+
explode: true
110+
schema:
111+
type: string
112+
example: ;
113+
114+
Bom:
115+
name: bom
116+
in: query
117+
description: |
118+
All text responses are encoded in UTF-8 encoding. By default, the
119+
`format=csv` files are prefixed with the UTF-8 Byte Order Mark (BOM), while `json`, `jsonl`, `xml`, `html` and `rss` files are not.
120+
121+
If you want to override this default behavior, specify `bom=1` query parameter to include the BOM or `bom=0` to skip it.
122+
style: form
123+
explode: true
124+
schema:
125+
type: boolean
126+
example: false
127+
128+
XmlRoot:
129+
name: xmlRoot
130+
in: query
131+
description: |
132+
Overrides default root element name of `xml` output. By default the root element is `items`.
133+
style: form
134+
explode: true
135+
schema:
136+
type: string
137+
example: items
138+
139+
XmlRow:
140+
name: xmlRow
141+
in: query
142+
description: |
143+
Overrides default element name that wraps each page or page function result object in `xml` output. By default the element name is `item`.
144+
style: form
145+
explode: true
146+
schema:
147+
type: string
148+
example: item
149+
150+
SkipHeaderRow:
151+
name: skipHeaderRow
152+
in: query
153+
description: If `true` or `1` then header row in the `csv` format is skipped.
154+
style: form
155+
explode: true
156+
schema:
157+
type: boolean
158+
example: true
159+
160+
SkipHidden:
161+
name: skipHidden
162+
in: query
163+
description: |
164+
If `true` or `1` then hidden fields are skipped from the output, i.e. fields starting with the `#` character.
165+
style: form
166+
explode: true
167+
schema:
168+
type: boolean
169+
example: false
170+
171+
SkipEmpty:
172+
name: skipEmpty
173+
in: query
174+
description: |
175+
If `true` or `1` then empty items are skipped from the output.
176+
177+
Note that if used, the results might contain less items than the limit value.
178+
style: form
179+
explode: true
180+
schema:
181+
type: boolean
182+
example: false
183+
184+
Simplified:
185+
name: simplified
186+
in: query
187+
description: |
188+
If `true` or `1` then, the endpoint applies the `fields=url,pageFunctionResult,errorInfo`
189+
and `unwind=pageFunctionResult` query parameters. This feature is used to emulate simplified results provided by the
190+
legacy Apify Crawler product and it's not recommended to use it in new integrations.
191+
style: form
192+
explode: true
193+
schema:
194+
type: boolean
195+
example: false
196+
197+
Desc:
198+
name: desc
199+
in: query
200+
description: |
201+
By default, results are returned in the same order as they were stored.
202+
To reverse the order, set this parameter to `true` or `1`.
203+
style: form
204+
explode: true
205+
schema:
206+
type: boolean
207+
example: true
208+
209+
SkipFailedPages:
210+
name: skipFailedPages
211+
in: query
212+
description: |
213+
If `true` or `1` then, the all the items with errorInfo property will be skipped from the output.
214+
215+
This feature is here to emulate functionality of API version 1 used for the legacy Apify Crawler product and it's not recommended to use it in new integrations.
216+
style: form
217+
explode: true
218+
schema:
219+
type: boolean
220+
example: false

‎apify-api/openapi/components/parameters/PaginationParameters.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,30 @@ Desc:
3434
type: boolean
3535
example: true
3636

37+
DescStartedAt:
38+
name: desc
39+
in: query
40+
description: |
41+
If `true` or `1` then the objects are sorted by the `startedAt` field in
42+
descending order. By default, they are sorted in ascending order.
43+
style: form
44+
explode: true
45+
schema:
46+
type: boolean
47+
example: true
48+
49+
DescCreatedAt:
50+
name: desc
51+
in: query
52+
description: |
53+
If `true` or `1` then the objects are sorted by the `createdAt` field in
54+
descending order. By default, they are sorted in ascending order.
55+
style: form
56+
explode: true
57+
schema:
58+
type: boolean
59+
example: true
60+
3761
Unnamed:
3862
name: unnamed
3963
in: query

‎apify-api/openapi/components/parameters/logOptions.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ stream:
33
in: query
44
description: |
55
If `true` or `1` then the logs will be streamed as long as the run or build is running.
6-
required: false
6+
required: true
77
style: form
88
explode: true
99
schema:
@@ -15,7 +15,7 @@ download:
1515
in: query
1616
description: |
1717
If `true` or `1` then the web browser will download the log file rather than open it in a tab.
18-
required: false
18+
required: true
1919
style: form
2020
explode: true
2121
schema:

‎apify-api/openapi/components/parameters/runAndBuildOptions.yaml‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ webhookId:
3131
runId:
3232
name: runId
3333
in: path
34-
description: Run ID.
34+
description: Actor run ID.
3535
required: true
3636
style: simple
3737
schema:
@@ -41,7 +41,7 @@ runId:
4141
buildId:
4242
name: buildId
4343
in: path
44-
description: Build ID.
44+
description: ID of the build, found in the build's Info tab.
4545
required: true
4646
style: simple
4747
schema:
@@ -62,7 +62,7 @@ targetActorId:
6262
versionNumber:
6363
name: versionNumber
6464
in: path
65-
description: Actor major and minor version of the Actor.
65+
description: Actor version.
6666
required: true
6767
style: simple
6868
schema:
@@ -254,3 +254,25 @@ startedBefore:
254254
type: string
255255
format: date-time
256256
example: "2025-09-17T23:59:59.000Z"
257+
258+
scheduleId:
259+
name: scheduleId
260+
in: path
261+
description: Schedule ID.
262+
required: true
263+
style: simple
264+
schema:
265+
type: string
266+
example: asdLZtadYvn4mBZmm
267+
268+
outputRecordKey:
269+
name: outputRecordKey
270+
in: query
271+
description: |
272+
Key of the record from run's default key-value store to be returned
273+
in the response. By default, it is `OUTPUT`.
274+
style: form
275+
explode: true
276+
schema:
277+
type: string
278+
example: OUTPUT

‎apify-api/openapi/components/schemas/actor-tasks/TaskResponse.yaml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,21 @@ type: object
66
properties:
77
data:
88
$ref: ./Task.yaml
9+
example:
10+
data:
11+
id: zdc3Pyhyz3m8vjDeM
12+
userId: wRsJZtadYvn4mBZmm
13+
actId: asADASadYvn4mBZmm
14+
name: my-task
15+
username: janedoe
16+
createdAt: "2018-10-26T07:23:14.855Z"
17+
modifiedAt: "2018-10-26T13:30:49.578Z"
18+
removedAt: null
19+
stats:
20+
totalRuns: 15
21+
options:
22+
build: latest
23+
timeoutSecs: 300
24+
memoryMbytes: 128
25+
input:
26+
hello: world

0 commit comments

Comments
 (0)