Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(request-queue): Update RQ listAndLock API with latest API changes #1323

Merged
merged 5 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,15 @@ properties:
example: 1000
queueModifiedAt:
type: string
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.
example: '2018-03-14T23:00:00.000Z'
queueHasLockedRequests:
type: boolean
description: Whether the queue contains requests locked by any client (either the one calling the endpoint or a different one).
example: true
clientKey:
type: string
example: client-one
hadMultipleClients:
type: boolean
example: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ properties:
example: '2019-12-12T07:34:14.202Z'
modifiedAt:
type: string
example: '2019-12-13T08:36:13.202Z'
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.
example: '2030-12-13T08:36:13.202Z'
accessedAt:
type: string
example: '2019-12-14T08:36:13.202Z'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ post:
Returns the given number of first requests from the queue and locks them for
the given time.

If this endpoint locks the request, no other client will be able to get and
If this endpoint locks the request, no other client or run will be able to get and
lock these requests.


The response contains the `hadMultipleClients` boolean field which indicates
that the queue was accessed by more than one client (with unique or empty
`clientKey`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,10 @@ put:
- name: clientKey
in: query
description: |
A unique identifier of the client accessing the request queue. It must
be a string between 1 and 32 characters long. This identifier is used to
ensure one client is not to able delete or prolong

a request from another client.
A unique identifier of the client accessing the request queue. It must
be a string between 1 and 32 characters long. This identifier is used to for locking
and unlocking requests. You can delete or prolong lock only for requests that were locked by by same
client key or from the same Actor run.
style: form
explode: true
schema:
Expand Down Expand Up @@ -121,11 +120,10 @@ delete:
- name: clientKey
in: query
description: |
A unique identifier of the client accessing the request queue. It must
be a string between 1 and 32 characters long. This identifier is used to
ensure one client is not to able delete or prolong

a request from another client.
A unique identifier of the client accessing the request queue. It must
be a string between 1 and 32 characters long. This identifier is used to for locking
and unlocking requests. You can delete or prolong lock only for requests that were locked by by same
client key or from the same Actor run.
style: form
explode: true
schema:
Expand Down
Loading