be666ff985
This patch documents the basic usage of `Client` instances. It does not provide a detailed documentation about the methods exposed but a high level documentation of what the recommended way to access these resources is. The current version refers to sections like 'core API', 'config' and others that haven't been documented yet. Once they will be, proper links to those sections will be added here. Change-Id: I705498b8e4c19c75c9697419d1fd90c9a9ae40b9
53 lines
1.9 KiB
ReStructuredText
53 lines
1.9 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
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|