Skip to content

Commit 5d28248

Browse files
committed
streamline descriptions, fix formatting & add redirects
add redirects to group sections in nginx.conf streamline descriptions by moving shared parts to grouping introductions fix formatting remove HTML when possible
1 parent 91b1c14 commit 5d28248

14 files changed

+228
-270
lines changed

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@charge.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ post:
99
1010
:::note
1111
12-
Note that pay per events Actors are still in alpha. Please, reach out to us with any questions or feedback.
12+
Pay per events Actors are still in alpha. Please, reach out to us with any questions or feedback.
1313
1414
:::
1515
operationId: PostChargeRun

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@metamorph.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ post:
1818
All the default storages are preserved and the new input is stored under the
1919
`INPUT-METAMORPH-1` key in the same default key-value store.
2020
21-
For more information, see the [Actor
22-
docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph).
21+
For more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph).
2322
operationId: actorRun_metamorph_post
2423
parameters:
2524
- name: runId

apify-api/openapi/paths/actor-runs/actor-runs@{runId}@resurrect.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ post:
88
Run status will be updated to RUNNING and its container will be restarted with the same storages
99
(the same behaviour as when the run gets migrated to the new server).
1010
11-
For more information,
12-
see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run).
11+
For more information, see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run).
1312
operationId: PostResurrectRun
1413
parameters:
1514
- name: runId

apify-api/openapi/paths/actor-tasks/actor-tasks.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ get:
33
- Actor tasks
44
summary: Get list of tasks
55
description: |
6-
Gets the complete list of tasks that a user has created or used. The
7-
response is a list of objects in which each object contains essential
6+
Gets the complete list of tasks that a user has created or used.
7+
8+
The response is a list of objects in which each object contains essential
89
information about a single task.
910
1011
The endpoint supports pagination using the `limit` and `offset` parameters,

apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@run-sync-get-dataset-items.yaml

Lines changed: 68 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
1-
post:
1+
get:
22
tags:
33
- Actor tasks
4-
summary: Run task synchronously and get dataset items (POST)
4+
summary: Run task synchronously and get dataset items
55
description: |
6-
Runs an Actor task and synchronously returns its dataset items.
6+
Run a specific task and return its dataset items.
77
88
The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
99
otherwise the HTTP request fails with a timeout error (this won't abort
1010
the run itself).
1111
12-
Optionally, you can override the Actor input configuration by passing a JSON
13-
object as the POST payload and setting the `Content-Type: application/json` HTTP header.
14-
15-
Note that if the object in the POST payload does not define a particular
16-
input property, the Actor run uses the default value defined by the task (or the Actor's
17-
input schema if not defined by the task).
18-
1912
You can send all the same options in parameters as the [Get Dataset
2013
Items](#/reference/datasets/item-collection/get-items) API endpoint.
2114
@@ -26,15 +19,10 @@ post:
2619
If the connection breaks, you will not receive any information about the run
2720
and its status.
2821
29-
Input fields from Actor task configuration can be overloaded with values
30-
passed as the POST payload.
31-
32-
Just make sure to specify the `Content-Type` header as `application/json`
33-
and that the input is an object.
34-
35-
To run the task asynchronously, use the [Run
36-
task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
37-
operationId: actorTask_runSyncGetDatasetItems_post
22+
To run the Task asynchronously, use the [Run task
23+
asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint
24+
instead.
25+
operationId: actorTask_runSyncGetDatasetItems_get
3826
parameters:
3927
- name: actorTaskId
4028
in: path
@@ -96,11 +84,9 @@ post:
9684
in: query
9785
description: |
9886
Specifies optional webhooks associated with the Actor run, which can be
99-
used to receive a notification
100-
e.g. when the Actor finished or failed. The value is a Base64-encoded
87+
used to receive a notification e.g. when the Actor finished or failed. The value is a Base64-encoded
10188
JSON array of objects defining the webhooks. For more information, see
102-
[Webhooks
103-
documentation](https://docs.apify.com/platform/integrations/webhooks).
89+
[Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
10490
style: form
10591
explode: true
10692
schema:
@@ -121,9 +107,12 @@ post:
121107
description: |
122108
If `true` or `1` then the API endpoint returns only non-empty items and
123109
skips hidden fields
110+
124111
(i.e. fields starting with the # character).
112+
125113
The `clean` parameter is just a shortcut for `skipHidden=true` and
126114
`skipEmpty=true` parameters.
115+
127116
Note that since some objects might be skipped from the output, that the
128117
result might contain less items than the `limit` value.
129118
style: form
@@ -155,9 +144,12 @@ post:
155144
in: query
156145
description: |
157146
A comma-separated list of fields which should be picked from the items,
147+
158148
only these fields will remain in the resulting record objects.
149+
159150
Note that the fields in the outputted items are sorted the same way as
160151
they are specified in the `fields` query parameter.
152+
161153
You can use this feature to effectively fix the output format.
162154
style: form
163155
explode: true
@@ -177,13 +169,18 @@ post:
177169
description: |
178170
A comma-separated list of fields which should be unwound, in order which
179171
they should be processed. Each field should be either an array or an object.
172+
180173
If the field is an array then every element of
174+
181175
the array will become a separate record and merged with parent object.
176+
182177
If the unwound field is an object then it is merged with the parent
183178
object
179+
184180
If the unwound field is missing or its value is neither an array nor an
185181
object and therefore cannot be merged with a parent object then the item
186182
gets preserved as it is.
183+
187184
Note that the unwound items ignore the `desc` parameter.
188185
style: form
189186
explode: true
@@ -195,8 +192,10 @@ post:
195192
description: |
196193
A comma-separated list of fields which should transform nested objects
197194
into flat structures.
195+
198196
For example, with `flatten="foo"` the object `{"foo":{"bar": "hello"}}`
199197
is turned into `{"foo.bar": "hello"}`.
198+
200199
The original object with properties is replaced with the flattened
201200
object.
202201
style: form
@@ -241,8 +240,10 @@ post:
241240
description: |
242241
All text responses are encoded in UTF-8 encoding. By default, the
243242
`format=csv` files are prefixed with
243+
244244
the UTF-8 Byte Order Mark (BOM), while `json`, `jsonl`, `xml`, `html`
245245
and `rss` files are not.
246+
246247
If you want to override this default behavior, specify `bom=1` query
247248
parameter to include the BOM or `bom=0` to skip it.
248249
style: form
@@ -305,10 +306,8 @@ post:
305306
description: |
306307
If `true` or `1` then, the endpoint applies the
307308
`fields=url,pageFunctionResult,errorInfo`
308-
309309
and `unwind=pageFunctionResult` query parameters. This feature is used
310310
to emulate simplified results provided by the
311-
312311
legacy Apify Crawler product and it's not recommended to use it in new
313312
integrations.
314313
style: form
@@ -321,7 +320,6 @@ post:
321320
description: |
322321
If `true` or `1` then, the all the items with errorInfo property will be
323322
skipped from the output.
324-
325323
This feature is here to emulate functionality of API version 1 used for
326324
the legacy Apify Crawler product and it's not recommended to use it in
327325
new integrations.
@@ -330,15 +328,6 @@ post:
330328
schema:
331329
type: boolean
332330
example: false
333-
requestBody:
334-
description: ''
335-
content:
336-
application/json:
337-
schema:
338-
type: object
339-
example:
340-
foo: bar
341-
required: true
342331
responses:
343332
'201':
344333
description: ''
@@ -378,22 +367,36 @@ post:
378367
application/json:
379368
schema:
380369
$ref: "../../components/schemas/common/ErrorResponse.yaml"
370+
'408':
371+
description: 'Request Timeout: the HTTP request exceeded the 300 second limit'
372+
headers: {}
373+
content:
374+
application/json:
375+
schema:
376+
$ref: "../../components/schemas/common/ErrorResponse.yaml"
381377
deprecated: false
382378
x-legacy-doc-urls:
383-
- https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-post
384-
- https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-post
385-
- https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_post
386-
get:
379+
- https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-get
380+
- https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-get
381+
- https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_get
382+
post:
387383
tags:
388384
- Actor tasks
389-
summary: Run task synchronously and get dataset items (GET)
385+
summary: Run task synchronously and get dataset items
390386
description: |
391-
Run a specific task and return its dataset items.
387+
Runs an Actor task and synchronously returns its dataset items.
392388
393389
The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds
394390
otherwise the HTTP request fails with a timeout error (this won't abort
395391
the run itself).
396392
393+
Optionally, you can override the Actor input configuration by passing a JSON
394+
object as the POST payload and setting the `Content-Type: application/json` HTTP header.
395+
396+
Note that if the object in the POST payload does not define a particular
397+
input property, the Actor run uses the default value defined by the task (or the Actor's
398+
input schema if not defined by the task).
399+
397400
You can send all the same options in parameters as the [Get Dataset
398401
Items](#/reference/datasets/item-collection/get-items) API endpoint.
399402
@@ -404,10 +407,15 @@ get:
404407
If the connection breaks, you will not receive any information about the run
405408
and its status.
406409
407-
To run the Task asynchronously, use the [Run task
408-
asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint
409-
instead.
410-
operationId: actorTask_runSyncGetDatasetItems_get
410+
Input fields from Actor task configuration can be overloaded with values
411+
passed as the POST payload.
412+
413+
Just make sure to specify the `Content-Type` header as `application/json`
414+
and that the input is an object.
415+
416+
To run the task asynchronously, use the [Run
417+
task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
418+
operationId: actorTask_runSyncGetDatasetItems_post
411419
parameters:
412420
- name: actorTaskId
413421
in: path
@@ -470,10 +478,8 @@ get:
470478
description: |
471479
Specifies optional webhooks associated with the Actor run, which can be
472480
used to receive a notification
473-
474481
e.g. when the Actor finished or failed. The value is a Base64-encoded
475482
JSON array of objects defining the webhooks. For more information, see
476-
477483
[Webhooks
478484
documentation](https://docs.apify.com/platform/integrations/webhooks).
479485
style: form
@@ -496,12 +502,9 @@ get:
496502
description: |
497503
If `true` or `1` then the API endpoint returns only non-empty items and
498504
skips hidden fields
499-
500505
(i.e. fields starting with the # character).
501-
502506
The `clean` parameter is just a shortcut for `skipHidden=true` and
503507
`skipEmpty=true` parameters.
504-
505508
Note that since some objects might be skipped from the output, that the
506509
result might contain less items than the `limit` value.
507510
style: form
@@ -533,12 +536,9 @@ get:
533536
in: query
534537
description: |
535538
A comma-separated list of fields which should be picked from the items,
536-
537539
only these fields will remain in the resulting record objects.
538-
539540
Note that the fields in the outputted items are sorted the same way as
540541
they are specified in the `fields` query parameter.
541-
542542
You can use this feature to effectively fix the output format.
543543
style: form
544544
explode: true
@@ -558,18 +558,13 @@ get:
558558
description: |
559559
A comma-separated list of fields which should be unwound, in order which
560560
they should be processed. Each field should be either an array or an object.
561-
562561
If the field is an array then every element of
563-
564562
the array will become a separate record and merged with parent object.
565-
566563
If the unwound field is an object then it is merged with the parent
567564
object
568-
569565
If the unwound field is missing or its value is neither an array nor an
570566
object and therefore cannot be merged with a parent object then the item
571567
gets preserved as it is.
572-
573568
Note that the unwound items ignore the `desc` parameter.
574569
style: form
575570
explode: true
@@ -581,10 +576,8 @@ get:
581576
description: |
582577
A comma-separated list of fields which should transform nested objects
583578
into flat structures.
584-
585579
For example, with `flatten="foo"` the object `{"foo":{"bar": "hello"}}`
586580
is turned into `{"foo.bar": "hello"}`.
587-
588581
The original object with properties is replaced with the flattened
589582
object.
590583
style: form
@@ -629,10 +622,8 @@ get:
629622
description: |
630623
All text responses are encoded in UTF-8 encoding. By default, the
631624
`format=csv` files are prefixed with
632-
633625
the UTF-8 Byte Order Mark (BOM), while `json`, `jsonl`, `xml`, `html`
634626
and `rss` files are not.
635-
636627
If you want to override this default behavior, specify `bom=1` query
637628
parameter to include the BOM or `bom=0` to skip it.
638629
style: form
@@ -695,8 +686,10 @@ get:
695686
description: |
696687
If `true` or `1` then, the endpoint applies the
697688
`fields=url,pageFunctionResult,errorInfo`
689+
698690
and `unwind=pageFunctionResult` query parameters. This feature is used
699691
to emulate simplified results provided by the
692+
700693
legacy Apify Crawler product and it's not recommended to use it in new
701694
integrations.
702695
style: form
@@ -709,6 +702,7 @@ get:
709702
description: |
710703
If `true` or `1` then, the all the items with errorInfo property will be
711704
skipped from the output.
705+
712706
This feature is here to emulate functionality of API version 1 used for
713707
the legacy Apify Crawler product and it's not recommended to use it in
714708
new integrations.
@@ -717,6 +711,15 @@ get:
717711
schema:
718712
type: boolean
719713
example: false
714+
requestBody:
715+
description: ''
716+
content:
717+
application/json:
718+
schema:
719+
type: object
720+
example:
721+
foo: bar
722+
required: true
720723
responses:
721724
'201':
722725
description: ''
@@ -756,15 +759,8 @@ get:
756759
application/json:
757760
schema:
758761
$ref: "../../components/schemas/common/ErrorResponse.yaml"
759-
'408':
760-
description: 'Request Timeout: the HTTP request exceeded the 300 second limit'
761-
headers: {}
762-
content:
763-
application/json:
764-
schema:
765-
$ref: "../../components/schemas/common/ErrorResponse.yaml"
766762
deprecated: false
767763
x-legacy-doc-urls:
768-
- https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-get
769-
- https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-get
770-
- https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_get
764+
- https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-post
765+
- https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-post
766+
- https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_post

0 commit comments

Comments
 (0)