99 lines
3.2 KiB
ReStructuredText
99 lines
3.2 KiB
ReStructuredText
..
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
====================================================
|
|
Welcome to the Zaqar-client developer documentation!
|
|
====================================================
|
|
|
|
`Zaqar`_ is a multi-tenant cloud messaging and notification service for web
|
|
and mobile developers.
|
|
|
|
The service features a ReST API, which developers can use to send messages
|
|
between various components of their SaaS and mobile applications, by using a
|
|
variety of communication patterns. Underlying this API is an efficient
|
|
messaging engine designed with scalability and security in mind.
|
|
|
|
Other OpenStack components can integrate with Zaqar to surface events to
|
|
end users and to communicate with guest agents that run in the
|
|
"over-cloud" layer.
|
|
|
|
.. note:: This documentation is generated by the Sphinx toolkit and lives in the Zaqar project source
|
|
tree. Additional draft and project documentation regarding Zaqar and other components of OpenStack can
|
|
be found on the `OpenStack Wiki`_, as well as in the user guides found on `docs.openstack.org`_.
|
|
|
|
.. _`Zaqar`: https://wiki.openstack.org/wiki/Zaqar
|
|
.. _`OpenStack Wiki`: http://wiki.openstack.org
|
|
.. _`docs.openstack.org`: http://docs.openstack.org
|
|
|
|
|
|
Contents
|
|
========
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
client
|
|
command-line
|
|
|
|
Release Notes
|
|
=============
|
|
|
|
New Release Note
|
|
----------------
|
|
|
|
We use reno to publish the release note now. Please see `Release Page`_ for
|
|
more detail.
|
|
|
|
0.2.0
|
|
-----
|
|
|
|
* 1934a98 Updated from global requirements
|
|
* 863371b Allow for authentication in functional tests
|
|
* b35689d Don't pass `options` to pool creation
|
|
* 8104ff4 Don't reuse request and transport instances
|
|
* bf841b5 Pass `group` in pool's functional tests
|
|
* 2490ed4 Send claims `limit` as a query param
|
|
* baf6fa7 v1.1 and v2 claims return document not list
|
|
* 0d80728 Make sure the API version is passed down
|
|
* 407925c Make v1.1 the default CLI version
|
|
* 895aad2 Updated from global requirements
|
|
* 8a81c44 Updated from global requirements
|
|
* 705ee75 Implement CLI support for flavor
|
|
* 32a847e Implements CLI for pool
|
|
* 964443d Raises an error if the queue name is empty
|
|
* e9a8d01 Added support to pools and flavors
|
|
* f46979b Removed deprecated 'shard' methods
|
|
* 1a85f83 Update README to work with release tools
|
|
|
|
0.1.1
|
|
-----
|
|
|
|
* Fix handling of 1.1 API
|
|
* Gets 'flavor' data if the resource exists
|
|
* Gets 'pool' data if the resource exists
|
|
* Handling exception on 504 Error
|
|
* Added i18n support
|
|
* Makes health return True or False
|
|
* Add reference docs for latest recommended client
|
|
* Add docs for `Client` instances
|
|
* Add a read-only property for Queues
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
.. _`Release Page`: https://docs.openstack.org/releasenotes/python-zaqarclient
|