feat: API: request queue unlocking docs #1591
Conversation
github-actions
bot
added
the
t-core-services
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
| A unique identifier of the client accessing the request queue. It must | ||
| be a string between 1 and 32 characters long | ||
| style: form | ||
| explode: true |
There was a problem hiding this comment.
Um, it's just a simple string query parameter, why style: form and explode: true?
There was a problem hiding this comment.
Honestly not sure, I just reused this param from the current rq endpoint see
| in: query | ||
| description: | | ||
| A unique identifier of the client accessing the request queue. It must | ||
| be a string between 1 and 32 characters long |
There was a problem hiding this comment.
I'd use minLength and maxLength instead (https://swagger.io/docs/specification/v3_0/data-models/data-types/#strings)
There was a problem hiding this comment.
Same here, let's move this in separate PR as I need to update it everywhere 😄
There was a problem hiding this comment.
Okay, are you up to it or shall I make an issue? 🙂
| - Storage/Request queues/Requests locks | ||
| summary: Unlock requests | ||
| description: | | ||
| 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. |
There was a problem hiding this comment.
I'm not sure I understand what this actually does. Does it unlock all requests locked from the same run, and (in addition to) all requests locked by the same client key (I assume to account for working with the RQ from a script outside of the platform)?
There was a problem hiding this comment.
Yes, if the client is within the Actor run it will unlock all request locked by this Actor run plus additionally all lock lock by the clientKey. If the client is outside if Actor run it will unlock just request locked by the same clientKey.
There was a problem hiding this comment.
I updated the description.
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
fnesveda
added
the
validated
No description provided.