diff --git a/api-ref/source/claims.inc b/api-ref/source/claims.inc index c78e18922..2009946d2 100644 --- a/api-ref/source/claims.inc +++ b/api-ref/source/claims.inc @@ -1,6 +1,8 @@ =============== Claims (claims) =============== +Claim is a mechanism to mark messages so that other workers will not process +the same message. Claim messages ============== diff --git a/api-ref/source/health.inc b/api-ref/source/health.inc index 2964adfd6..fba0ad0fd 100644 --- a/api-ref/source/health.inc +++ b/api-ref/source/health.inc @@ -1,6 +1,9 @@ =============== Health (health) =============== +With health API, user or operator can get a general idea about the status of +Zaqar server. Those information can be used for basic validation, performance +checking, etc. Ping ==== diff --git a/api-ref/source/messages.inc b/api-ref/source/messages.inc index 4fd7dedc5..442d1d8a9 100644 --- a/api-ref/source/messages.inc +++ b/api-ref/source/messages.inc @@ -1,6 +1,12 @@ =================== Messages (messages) =================== +Message is sent through a queue and exists until it is deleted by a recipient +or automatically by the system based on a TTL (time-to-live) value. + +All message-related operations require Client-Id to be included in the headers. +This is to ensure that messages are not echoed back to the client that posted +them unless the client explicitly requests this. Post Message ============ diff --git a/api-ref/source/pools.inc b/api-ref/source/pools.inc index 5f4b6f497..5ecbad489 100644 --- a/api-ref/source/pools.inc +++ b/api-ref/source/pools.inc @@ -1,9 +1,15 @@ =============== Pools (pools) =============== +If pooling is enabled, queuing service uses multiple queues databases in order +to scale horizontally. A pool (queues database) can be added any time without +stopping the service. Each pool has a weight that is assigned during the +creation time but can be changed later. Pooling is done by queue which +indicates that all messages for a particular queue can be found in the same +pool (queues database). List pools -=========== +========== .. rest_method:: GET /v2/pools diff --git a/api-ref/source/queues.inc b/api-ref/source/queues.inc index a2d73192c..5637cc430 100644 --- a/api-ref/source/queues.inc +++ b/api-ref/source/queues.inc @@ -1,6 +1,14 @@ =============== Queues (queues) =============== +Queue is a logical entity that groups messages. Ideally a queue is created per +work type. For example, if you want to compress files, you would create a queue +dedicated for this job. Any application that reads from this queue would only +compress files. + +Nowadays, queue in Zaqar is most like a topic, it's created lazily. User can +post messages to a queue before creating the queue. Zaqar will create the +queue/topic automatically. List queues =========== diff --git a/api-ref/source/subscription.inc b/api-ref/source/subscription.inc index 81285e049..d357521cd 100644 --- a/api-ref/source/subscription.inc +++ b/api-ref/source/subscription.inc @@ -1,6 +1,10 @@ ============================ Subscriptions(subscriptions) ============================ +Subscriptions are relationships between queue/topic and the targeted +subscribers. After created subscriptions for a particular subscriber, like an +email or a webhook, then when new messages posted to the queue, the subscriber +will be notified automatically. List Subscriptions ==================