Skip to content

Commit 57b7af4

Browse files
drobnikjjanbuchar
andauthored
feat(request-queue): Update RQ listAndLock API with latest API changes (#1323)
Update API reference based on latest changes in API. --------- Co-authored-by: Jan Buchar <[email protected]>
1 parent 5252893 commit 57b7af4

File tree

4 files changed

+19
-13
lines changed

4 files changed

+19
-13
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 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 contains requests locked by any client (either the one calling the endpoint or a different one).
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 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`).

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,10 @@ put:
3737
- name: clientKey
3838
in: query
3939
description: |
40-
A unique identifier of the client accessing the request queue. It must
41-
be a string between 1 and 32 characters long. This identifier is used to
42-
ensure one client is not to able delete or prolong
43-
44-
a request from another client.
40+
A unique identifier of the client accessing the request queue. It must
41+
be a string between 1 and 32 characters long. This identifier is used to for locking
42+
and unlocking requests. You can delete or prolong lock only for requests that were locked by by same
43+
client key or from the same Actor run.
4544
style: form
4645
explode: true
4746
schema:
@@ -121,11 +120,10 @@ delete:
121120
- name: clientKey
122121
in: query
123122
description: |
124-
A unique identifier of the client accessing the request queue. It must
125-
be a string between 1 and 32 characters long. This identifier is used to
126-
ensure one client is not to able delete or prolong
127-
128-
a request from another client.
123+
A unique identifier of the client accessing the request queue. It must
124+
be a string between 1 and 32 characters long. This identifier is used to for locking
125+
and unlocking requests. You can delete or prolong lock only for requests that were locked by by same
126+
client key or from the same Actor run.
129127
style: form
130128
explode: true
131129
schema:

0 commit comments

Comments
 (0)