Skip to content

Commit 11ded32

Browse files
committed
split request queues into 3 sub categories
split request queues into 3 sub-categories change descriptions for introductory pages to reflect new division reorganize sidebar further add missin request queues redirects to ngninx.conf
1 parent 20eba7e commit 11ded32

11 files changed

+74
-18
lines changed

apify-api/openapi/components/tags.yaml

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -236,20 +236,61 @@
236236
- '#tag/Request-queuesQueue-collection'
237237
- '#/reference/request-queues/queue'
238238
- '#tag/Request-queuesQueue'
239+
- '#/reference/request-queues/batch-request-operations'
240+
- '#tag/Request-queuesBatch-request-operations'
241+
description: |
242+
This section describes API endpoints to create, manage, and delete request queues.
243+
244+
Request queue is a storage for a queue of HTTP URLs to crawl, which is typically
245+
used for deep crawling of websites where you
246+
start with several URLs and then recursively follow links to other pages.
247+
The storage supports both breadth-first and depth-first crawling orders.
248+
249+
For more information, see the [Request queue documentation](https://docs.apify.com/platform/storage/request-queue).
250+
251+
:::note
252+
253+
Some of the endpoints do not require the authentication token, the calls
254+
are authenticated using the hard-to-guess ID of the queue.
255+
256+
:::
257+
- name: Storage/Request queues/Requests
258+
x-displayName: Requests- Introduction
259+
x-parent-tag-name: Storage
260+
x-legacy-doc-urls:
239261
- '#/reference/request-queues/request-collection'
240262
- '#tag/Request-queuesRequest-collection'
241263
- '#/reference/request-queues/request'
242264
- '#tag/Request-queuesRequest'
265+
description: |
266+
This section describes API endpoints to create, manage, and delete requests within request queues.
267+
268+
Request queue is a storage for a queue of HTTP URLs to crawl, which is typically
269+
used for deep crawling of websites where you
270+
start with several URLs and then recursively follow links to other pages.
271+
The storage supports both breadth-first and depth-first crawling orders.
272+
273+
For more information, see the [Request queue documentation](https://docs.apify.com/platform/storage/request-queue).
274+
275+
:::note
276+
277+
Some of the endpoints do not require the authentication token, the calls
278+
are authenticated using the hard-to-guess ID of the queue.
279+
280+
:::
281+
- name: Storage/Request queues/Requests locks
282+
x-displayName: Requests locks - Introduction
283+
x-parent-tag-name: Storage
284+
x-legacy-doc-urls:
285+
243286
- '#/reference/request-queues/request-lock'
244287
- '#tag/Request-queuesRequest-lock'
245288
- '#/reference/request-queues/queue-head'
246289
- '#tag/Request-queuesQueue-head'
247290
- '#/reference/request-queues/queue-head-with-locks'
248291
- '#tag/Request-queuesQueue-head-with-locks'
249-
- '#/reference/request-queues/batch-request-operations'
250-
- '#tag/Request-queuesBatch-request-operations'
251292
description: |
252-
This section describes API endpoints to create, manage, and delete request queues.
293+
This section describes API endpoints to create, manage, and delete request locks within request queues.
253294
254295
Request queue is a storage for a queue of HTTP URLs to crawl, which is typically
255296
used for deep crawling of websites where you

apify-api/openapi/components/x-tag-groups.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
- Storage/Datasets
2121
- Storage/Key-value stores
2222
- Storage/Request queues
23+
- Storage/Request queues/Requests
24+
- Storage/Request queues/Requests locks
2325
- name: Webhooks
2426
tags:
2527
- Webhooks/Webhooks

apify-api/openapi/openapi.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -581,18 +581,18 @@ paths:
581581
$ref: paths/request-queues/request-queues.yaml
582582
'/v2/request-queues/{queueId}':
583583
$ref: 'paths/request-queues/request-queues@{queueId}.yaml'
584+
'/v2/request-queues/{queueId}/requests/batch':
585+
$ref: 'paths/request-queues/request-queues@{queueId}@[email protected]'
584586
'/v2/request-queues/{queueId}/requests':
585587
$ref: 'paths/request-queues/request-queues@{queueId}@requests.yaml'
586588
'/v2/request-queues/{queueId}/requests/{requestId}':
587589
$ref: 'paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml'
588-
'/v2/request-queues/{queueId}/requests/{requestId}/lock':
589-
$ref: 'paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml'
590590
'/v2/request-queues/{queueId}/head':
591591
$ref: 'paths/request-queues/request-queues@{queueId}@head.yaml'
592592
'/v2/request-queues/{queueId}/head/lock':
593593
$ref: 'paths/request-queues/request-queues@{queueId}@[email protected]'
594-
'/v2/request-queues/{queueId}/requests/batch':
595-
$ref: 'paths/request-queues/request-queues@{queueId}@requests@batch.yaml'
594+
'/v2/request-queues/{queueId}/requests/{requestId}/lock':
595+
$ref: 'paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml'
596596
/v2/webhooks:
597597
$ref: paths/webhooks/webhooks.yaml
598598
'/v2/webhooks/{webhookId}':

apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ get:
433433
post:
434434
tags:
435435
- Storage/Datasets
436-
summary: Put items
436+
summary: Store items
437437
description: |
438438
Appends an item or an array of items to the end of the dataset.
439439
The POST payload is a JSON object or a JSON array of objects to save into the dataset.

apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ get:
7373
put:
7474
tags:
7575
- Storage/Key-value stores
76-
summary: Put record
76+
summary: Store record
7777
description: |
7878
Stores a value under a specific key to the key-value store.
7979

apify-api/openapi/paths/request-queues/request-queues@{queueId}@head.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
get:
22
tags:
3-
- Storage/Request queues
3+
- Storage/Request queues/Requests locks
44
summary: Get head
55
description: |
66
Returns given number of first requests from the queue.

apify-api/openapi/paths/request-queues/request-queues@{queueId}@[email protected]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
post:
22
tags:
3-
- Storage/Request queues
3+
- Storage/Request queues/Requests locks
44
summary: Get head and lock
55
description: |
66
Returns the given number of first requests from the queue and locks them for

apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
get:
22
tags:
3-
- Storage/Request queues
3+
- Storage/Request queues/Requests
44
summary: List requests
55
description: |
66
Returns a list of requests. This endpoint is paginated using
@@ -137,7 +137,7 @@ get:
137137
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_requests
138138
post:
139139
tags:
140-
- Storage/Request queues
140+
- Storage/Request queues/Requests
141141
summary: Add request
142142
description: |
143143
Adds request to the queue. Response contains ID of the request and info if

apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
get:
22
tags:
3-
- Storage/Request queues
3+
- Storage/Request queues/Requests
44
summary: Get request
55
description: Returns request from queue.
66
operationId: requestQueue_request_get
@@ -78,7 +78,7 @@ get:
7878
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#get
7979
put:
8080
tags:
81-
- Storage/Request queues
81+
- Storage/Request queues/Requests
8282
summary: Update request
8383
description: |
8484
Updates a request in a queue. Mark request as handled by setting
@@ -197,7 +197,7 @@ put:
197197
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#update
198198
delete:
199199
tags:
200-
- Storage/Request queues
200+
- Storage/Request queues/Requests
201201
summary: Delete request
202202
description: Deletes given request from queue.
203203
operationId: requestQueue_request_delete

apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
put:
22
tags:
3-
- Storage/Request queues
3+
- Storage/Request queues/Requests locks
44
summary: Prolong request lock
55
description: |
66
Prolongs request lock. The request lock can be prolonged only by the client
@@ -84,7 +84,7 @@ put:
8484
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#prolong_request_lock
8585
delete:
8686
tags:
87-
- Storage/Request queues
87+
- Storage/Request queues/Requests locks
8888
summary: Delete request lock
8989
description: |
9090
Deletes a request lock. The request lock can be deleted only by the client

0 commit comments

Comments
 (0)