Skip to content

Commit 20eba7e

Browse files
committed
add introduction to name of introductory page
1 parent 5d28248 commit 20eba7e

File tree

1 file changed

+16
-76
lines changed

1 file changed

+16
-76
lines changed

apify-api/openapi/components/tags.yaml

Lines changed: 16 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
- A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`).
1616
1717
- name: Actors/Actor versions
18-
x-displayName: Actor versions
18+
x-displayName: Actor versions - Introduction
1919
x-parent-tag-name: Actors
2020
x-legacy-doc-urls:
2121
- '#/reference/actors/version-collection'
@@ -44,7 +44,7 @@
4444
For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)
4545
in Actors documentation.
4646
- name: Actors/Actor builds
47-
x-displayName: Actor builds
47+
x-displayName: Actor builds - Introduction
4848
x-parent-tag-name: Actors
4949
x-legacy-doc-urls:
5050
- '#/reference/actors/build-collection'
@@ -56,7 +56,7 @@
5656
description: |
5757
The API endpoints in this section allow you to manage your Apify Actors builds.
5858
- name: Actors/Actor runs
59-
x-displayName: Actor runs
59+
x-displayName: Actor runs - Introduction
6060
x-parent-tag-name: Actors
6161
x-legacy-doc-urls:
6262
- '#/reference/actors/run-collection'
@@ -70,6 +70,8 @@
7070
- '#tag/ActorsRun-actor-synchronously'
7171
- '#/reference/actors/run-actor-synchronously-and-get-dataset-items'
7272
- '#tag/ActorsRun-Actor-synchronously-and-get-dataset-items'
73+
- '#/reference/actors/last-run-object-and-its-storages'
74+
- '#tag/ActorsLast-run-object-and-its-storages'
7375
description: |
7476
The API endpoints in this section allow you to manage your Apify Actors runs.
7577
@@ -78,76 +80,14 @@
7880
For more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage).
7981
x-trait: 'true'
8082
- name: Actors/Webhook collection
81-
x-displayName: Webhook collection
83+
x-displayName: Webhook collection - Introduction
8284
x-parent-tag-name: Actors
8385
x-legacy-doc-urls:
8486
- '#/reference/actors/webhook-collection'
8587
- '#tag/ActorsWebhook-collection'
8688
description: |
8789
The API endpoint in this section allows you to get a list of webhooks of a specific Actor.
8890
x-trait: 'true'
89-
- name: Actors/Last run object and its storages
90-
x-displayName: Last run object and its storages
91-
x-parent-tag-name: Actors
92-
x-legacy-doc-urls:
93-
- '#/reference/actors/last-run-object-and-its-storages'
94-
- '#tag/ActorsLast-run-object-and-its-storages'
95-
x-trait: 'true'
96-
description: |
97-
This is not a single endpoint, but an entire group of endpoints that lets you to
98-
retrieve and manage the last run of given Actor or any of its default storages.
99-
All the endpoints require an authentication token.
100-
101-
The endpoints accept the same HTTP methods and query parameters as
102-
the respective storage endpoints.
103-
The base path represents the last Actor run object is:
104-
105-
`/v2/acts/{actorId}/runs/last{?token,status}`
106-
107-
Using the `status` query parameter you can ensure to only get a run with a certain status
108-
(e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters
109-
are the same as in the [Run object](#/reference/actors/run-object) endpoint.
110-
111-
In order to access the default storages of the last Actor run, i.e. log, key-value
112-
store, dataset and request queue, use the following endpoints:
113-
114-
* `/v2/acts/{actorId}/runs/last/log{?token,status}`
115-
* `/v2/acts/{actorId}/runs/last/key-value-store{?token,status}`
116-
* `/v2/acts/{actorId}/runs/last/dataset{?token,status}`
117-
* `/v2/acts/{actorId}/runs/last/request-queue{?token,status}`
118-
119-
These API endpoints have the same usage as the equivalent storage endpoints.
120-
For example, `/v2/acts/{actorId}/runs/last/key-value-store` has the same HTTP method and parameters
121-
as the [Key-value store object](#/reference/key-value-stores/store-object) endpoint.
122-
123-
Additionally, each of the above API endpoints supports all sub-endpoints
124-
of the original one:
125-
126-
#### Key-value store
127-
128-
* `/v2/acts/{actorId}/runs/last/key-value-store/keys{?token,status}` [Key collection](#/reference/key-value-stores/key-collection)
129-
* `/v2/acts/{actorId}/runs/last/key-value-store/records/{recordKey}{?token,status}` [Record](#/reference/key-value-stores/record)
130-
131-
#### Dataset
132-
133-
* `/v2/acts/{actorId}/runs/last/dataset/items{?token,status}` [Item collection](#/reference/datasets/item-collection)
134-
135-
#### Request queue
136-
137-
* `/v2/acts/{actorId}/runs/last/request-queue/requests{?token,status}` [Request
138-
collection](#/reference/request-queues/request-collection)
139-
* `/v2/acts/{actorId}/runs/last/request-queue/requests/{requestId}{?token,status}`
140-
[Request collection](#/reference/request-queues/request)
141-
* `/v2/acts/{actorId}/runs/last/request-queue/head{?token,status}` [Queue head](#/reference/request-queues/queue-head)
142-
143-
For example, to download data from a dataset of the last succeeded Actor run in XML format,
144-
send HTTP GET request to the following URL:
145-
146-
```
147-
https://api.apify.com/v2/acts/{actorId}/runs/last/dataset/items?token={yourApiToken}&format=xml&status=SUCCEEDED
148-
```
149-
150-
In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL.
15191
- name: Actor builds
15292
x-displayName: Actor builds - Introduction
15393
x-legacy-doc-urls:
@@ -186,7 +126,7 @@
186126
187127
You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage).
188128
- name: Actor tasks
189-
x-displayName: Actor tasks
129+
x-displayName: Actor tasks - Introduction
190130
x-legacy-doc-urls:
191131
- '#/reference/actor-tasks'
192132
- '#tag/Actor-tasks'
@@ -227,7 +167,7 @@
227167
- name: Storage
228168
x-displayName:
229169
- name: Storage/Datasets
230-
x-displayName: Datasets
170+
x-displayName: Datasets - Introduction
231171
x-parent-tag-name: Storage
232172
x-legacy-doc-urls:
233173
- '#/reference/datasets'
@@ -257,7 +197,7 @@
257197
:::
258198
x-trait: 'true'
259199
- name: Storage/Key-value stores
260-
x-displayName: Key-value stores
200+
x-displayName: Key-value stores - Introduction
261201
x-parent-tag-name: Storage
262202
x-legacy-doc-urls:
263203
- '#/reference/key-value-stores/key-collection'
@@ -287,7 +227,7 @@
287227
:::
288228
x-trait: 'true'
289229
- name: Storage/Request queues
290-
x-displayName: Request queues
230+
x-displayName: Request queues - Introduction
291231
x-parent-tag-name: Storage
292232
x-legacy-doc-urls:
293233
- '#/reference/request-queues'
@@ -327,7 +267,7 @@
327267
- name: Webhooks
328268
x-displayName:
329269
- name: Webhooks/Webhooks
330-
x-displayName: Webhooks
270+
x-displayName: Webhooks - Introduction
331271
x-parent-tag-name: Webhooks
332272
x-legacy-doc-urls:
333273
- '#/reference/webhooks'
@@ -351,7 +291,7 @@
351291
352292
For more information see [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
353293
- name: Webhooks/Webhook dispatches
354-
x-displayName: Webhook dispatches
294+
x-displayName: Webhook dispatches - Introduction
355295
x-parent-tag-name: Webhooks
356296
x-legacy-doc-urls:
357297
- '#/reference/webhook-dispatches'
@@ -362,7 +302,7 @@
362302
- '#tag/Webhook-dispatchesWebhook-dispatch-object'
363303
description: This section describes API endpoints to get webhook dispatches.
364304
- name: Schedules
365-
x-displayName: Schedules
305+
x-displayName: Schedules - Introduction
366306
x-legacy-doc-urls:
367307
- '#/reference/schedules'
368308
- '#tag/Schedules'
@@ -388,7 +328,7 @@
388328
For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint.
389329
x-trait: 'true'
390330
- name: Store
391-
x-displayName: Store
331+
x-displayName: Store - Introduction
392332
x-legacy-doc-urls:
393333
- '#/reference/store'
394334
- '#tag/Store'
@@ -406,7 +346,7 @@
406346
:::
407347
x-trait: true
408348
- name: Logs
409-
x-displayName: Logs
349+
x-displayName: Logs - Introduction
410350
x-legacy-doc-urls:
411351
- '#/reference/logs'
412352
- '#tag/Logs'
@@ -425,7 +365,7 @@
425365
:::
426366
x-trait: true
427367
- name: Users
428-
x-displayName: Users
368+
x-displayName: Users - Introduction
429369
x-legacy-doc-urls:
430370
- '#/reference/users'
431371
- '#tag/Users'

0 commit comments

Comments
 (0)