Skip to content

Commit c0177f8

Browse files
committed
feat(request-queue): Update RQ listAndLock API with latest API changes
1 parent 6873e01 commit c0177f8

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,15 @@ properties:
1111
example: 1000
1212
queueModifiedAt:
1313
type: string
14+
description: The modifiedAt the queue is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue.
1415
example: '2018-03-14T23:00:00.000Z'
16+
queueHasLockedRequests:
17+
type: boolean
18+
description: Whether the queue has locked requests by the same or another client.
19+
example: true
20+
clientKey:
21+
type: string
22+
example: client-one
1523
hadMultipleClients:
1624
type: boolean
1725
example: true

apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ properties:
2525
example: '2019-12-12T07:34:14.202Z'
2626
modifiedAt:
2727
type: string
28-
example: '2019-12-13T08:36:13.202Z'
28+
description: The modifiedAt the queue is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue.
29+
example: '2030-12-13T08:36:13.202Z'
2930
accessedAt:
3031
type: string
3132
example: '2019-12-14T08:36:13.202Z'

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ post:
66
Returns the given number of first requests from the queue and locks them for
77
the given time.
88
9-
If this endpoint locks the request, no other client will be able to get and
9+
If this endpoint locks the request, no other client or run will be able to get and
1010
lock these requests.
1111
12-
1312
The response contains the `hadMultipleClients` boolean field which indicates
1413
that the queue was accessed by more than one client (with unique or empty
1514
`clientKey`).

0 commit comments

Comments
 (0)