Files
python-zaqarclient/doc/source/index.rst
Flavio Percoco f0de7d6039 Relese notes for zaqarclient 0.1.1
6707d41 Drop incubating theme from docs
24aeae5 Deleted unuseful line
f81c36d Drop use of 'oslo' namespace package
0047c54 Fix handling of 1.1 API
2bd784e Gets 'flavor' data if the resource exists
f5f35d4 Gets 'pool' data if the resource exists
ff13b7a Handling exception on 504 Error
e4af424 Updated from global requirements
99f0b35 Added i18n support
2cb7e90 Makes health return True or False
19ec61d Remove unused openstack/common modules
369ac1e Adds encapsulation control to the client
f96c739 Updated from global requirements
4d957e6 Extend some docstrings with useful information
632c893 Add reference docs for latest recommended client
be666ff Add docs for `Client` instances
d8a5061 Setup developer docs for zaqarclient
a411bf0 Fix the client name typo
4e60be5 Updated from global requirements
ad673c5 fix KeystoneAuth doc string
0c6c0d7 Updated from global requirements
d721b75 Updates API name
ebb8d56 Add a read-only property for Queues

Change-Id: I38d88788a3753da888211055de91e3aa1a9d7bbb
2015-05-28 09:46:04 +02:00

69 lines
2.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
Release Notes
=============
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`