Skip to content

Commit 7f28477

Browse files
authored
feat: API: request queue unlocking docs (#1591)
1 parent 62bb4e7 commit 7f28477

File tree

2 files changed

+60
-0
lines changed

2 files changed

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

0 commit comments

Comments
 (0)