diff --git a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml index e9d49616e..8c458e33d 100644 --- a/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml +++ b/apify-api/openapi/components/schemas/request-queues/GetHeadAndLockResponse.yaml @@ -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 diff --git a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml index ce6249b05..9e293eb2e 100644 --- a/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml +++ b/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml @@ -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' diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml index 8ec2ae40c..e5ea3ccb8 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@head@lock.yaml @@ -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`). diff --git a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml index 50480fde3..3a533468b 100644 --- a/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml +++ b/apify-api/openapi/paths/request-queues/request-queues@{queueId}@requests@{requestId}@lock.yaml @@ -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: @@ -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: