zaqar-specs/specs/ussuri/query-queues-with-count.rst

Query Queues With Count

https://blueprints.launchpad.net/zaqar/+spec/query-queues-with-count

This will support query queues with 'with_count=true' filter, Zaqar will return the amount of queues in backend storage. This feature will be very convenient to users to know how many resources they own.

Problem description

Currently, Zaqar can't return the amount of queues when querying the queue. It depends on users themselves to calculate the number one by one. For other clients or applications also need to do it after invoking Zaqar's API. Its quite inconvenient for users or developers.

Proposed change

Add a new query filter item named with_count, default value is False. When querying queues with "with_count=true" in url, Zaqar will add the function to calculate total number of queus in backend storage and return the amount of queues in response body like "count=100".

API Impact

Query queue list:

GET: /v2/queues?with_count=true

  RESPONSE CODE: 200
  RESPONSE BODY:
  {
    "count": 100,
    "queues": [...]
  }

Drawbacks

None

Alternatives

None

Implementation

Assignee(s)

Primary assignee:

wanghao <sxmatch1986@gmail.com>

Secondary assignee:

None

Milestones

Target Milestone for completion:

ussuri RC2

Work Items

1. Modify transport code.
2. Add release note for this feature.
3. Update API reference.
4. Change unit, functional and tempest tests accordingly.
5. Add client support.

Dependencies

None

References

None