Skip to content

Commit 9c82b44

Browse files
committed
feat: API: request queue unlocking docs
1 parent fd45ee7 commit 9c82b44

File tree

3 files changed

+58
-1
lines changed

3 files changed

+58
-1
lines changed

apify-api/openapi/openapi.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -581,6 +581,8 @@ paths:
581581
$ref: 'paths/request-queues/request-queues@{queueId}.yaml'
582582
'/v2/request-queues/{queueId}/requests/batch':
583583
$ref: 'paths/request-queues/request-queues@{queueId}@[email protected]'
584+
'/v2/request-queues/{queueId}/requests/unlock':
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}':
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
post:
2+
tags:
3+
- Storage/Request queues/Requests locks
4+
summary: Unlock requests
5+
description: |
6+
Unlocks requests in the queue for the client. The requests are unlocked if were locked by the same client key or if locked from the same Actor run.
7+
operationId: requestQueue_requests_unlock_post
8+
parameters:
9+
- name: queueId
10+
in: path
11+
description: Queue ID or `username~queue-name`.
12+
required: true
13+
style: simple
14+
schema:
15+
type: string
16+
example: WkzbQMuFYuamGv3YF
17+
- name: clientKey
18+
in: query
19+
description: |
20+
A unique identifier of the client accessing the request queue. It must
21+
be a string between 1 and 32 characters long
22+
style: form
23+
explode: true
24+
schema:
25+
type: string
26+
example: client-abc
27+
responses:
28+
'200':
29+
description: 'Number of requests that were unlocked'
30+
content:
31+
application/json:
32+
schema:
33+
type: object
34+
required:
35+
- data
36+
properties:
37+
data:
38+
type: object
39+
required:
40+
- unlockedCount
41+
properties:
42+
unlockedCount:
43+
type: integer
44+
description: 'Number of requests that were successfully unlocked'
45+
example:
46+
data:
47+
unlockedCount: 10
48+
49+
deprecated: false
50+
x-js-parent: RequestQueueClient
51+
x-js-name: unlockRequests
52+
x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#unlockRequests
53+
x-py-parent: RequestQueueClientAsync
54+
x-py-name: unlock_requests
55+
x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#unlock_requests

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)