diff --git a/doc/source/api/autoindex.rst b/doc/source/api/autoindex.rst new file mode 100644 index 000000000..eb10fcb18 --- /dev/null +++ b/doc/source/api/autoindex.rst @@ -0,0 +1,97 @@ +.. toctree:: + :maxdepth: 1 + + zaqar.cmd.gc.rst + zaqar.cmd.server.rst + zaqar.common.access.rst + zaqar.common.api.rst + zaqar.common.cli.rst + zaqar.common.decorators.rst + zaqar.common.errors.rst + zaqar.common.pipeline.rst + zaqar.common.request.rst + zaqar.common.response.rst + zaqar.common.schemas.flavors.rst + zaqar.common.schemas.pools.rst + zaqar.common.storage.select.rst + zaqar.common.transport.wsgi.helpers.rst + zaqar.common.utils.rst + zaqar.i18n.rst + zaqar.openstack.common.cache._backends.memory.rst + zaqar.openstack.common.cache.backends.rst + zaqar.openstack.common.cache.cache.rst + zaqar.openstack.common.config.generator.rst + zaqar.openstack.common.excutils.rst + zaqar.openstack.common.fileutils.rst + zaqar.openstack.common.gettextutils.rst + zaqar.openstack.common.importutils.rst + zaqar.openstack.common.jsonutils.rst + zaqar.openstack.common.local.rst + zaqar.openstack.common.lockutils.rst + zaqar.openstack.common.log.rst + zaqar.openstack.common.strutils.rst + zaqar.openstack.common.timeutils.rst + zaqar.queues.api.v1_1.request.rst + zaqar.queues.api.v1_1.response.rst + zaqar.queues.api.v1.request.rst + zaqar.queues.api.v1.response.rst + zaqar.queues.bootstrap.rst + zaqar.queues.storage.base.rst + zaqar.queues.storage.errors.rst + zaqar.queues.storage.mongodb.catalogue.rst + zaqar.queues.storage.mongodb.claims.rst + zaqar.queues.storage.mongodb.controllers.rst + zaqar.queues.storage.mongodb.driver.rst + zaqar.queues.storage.mongodb.flavors.rst + zaqar.queues.storage.mongodb.messages.rst + zaqar.queues.storage.mongodb.options.rst + zaqar.queues.storage.mongodb.pools.rst + zaqar.queues.storage.mongodb.queues.rst + zaqar.queues.storage.mongodb.utils.rst + zaqar.queues.storage.pipeline.rst + zaqar.queues.storage.pooling.rst + zaqar.queues.storage.redis.claims.rst + zaqar.queues.storage.redis.controllers.rst + zaqar.queues.storage.redis.driver.rst + zaqar.queues.storage.redis.messages.rst + zaqar.queues.storage.redis.models.rst + zaqar.queues.storage.redis.options.rst + zaqar.queues.storage.redis.queues.rst + zaqar.queues.storage.redis.utils.rst + zaqar.queues.storage.sqlalchemy.catalogue.rst + zaqar.queues.storage.sqlalchemy.claims.rst + zaqar.queues.storage.sqlalchemy.controllers.rst + zaqar.queues.storage.sqlalchemy.driver.rst + zaqar.queues.storage.sqlalchemy.messages.rst + zaqar.queues.storage.sqlalchemy.options.rst + zaqar.queues.storage.sqlalchemy.pools.rst + zaqar.queues.storage.sqlalchemy.queues.rst + zaqar.queues.storage.sqlalchemy.tables.rst + zaqar.queues.storage.sqlalchemy.utils.rst + zaqar.queues.storage.utils.rst + zaqar.queues.transport.auth.rst + zaqar.queues.transport.base.rst + zaqar.queues.transport.utils.rst + zaqar.queues.transport.validation.rst + zaqar.queues.transport.wsgi.app.rst + zaqar.queues.transport.wsgi.driver.rst + zaqar.queues.transport.wsgi.errors.rst + zaqar.queues.transport.wsgi.utils.rst + zaqar.queues.transport.wsgi.v1_0.claims.rst + zaqar.queues.transport.wsgi.v1_0.health.rst + zaqar.queues.transport.wsgi.v1_0.homedoc.rst + zaqar.queues.transport.wsgi.v1_0.messages.rst + zaqar.queues.transport.wsgi.v1_0.metadata.rst + zaqar.queues.transport.wsgi.v1_0.pools.rst + zaqar.queues.transport.wsgi.v1_0.queues.rst + zaqar.queues.transport.wsgi.v1_0.stats.rst + zaqar.queues.transport.wsgi.v1_1.claims.rst + zaqar.queues.transport.wsgi.v1_1.flavors.rst + zaqar.queues.transport.wsgi.v1_1.health.rst + zaqar.queues.transport.wsgi.v1_1.homedoc.rst + zaqar.queues.transport.wsgi.v1_1.messages.rst + zaqar.queues.transport.wsgi.v1_1.ping.rst + zaqar.queues.transport.wsgi.v1_1.pools.rst + zaqar.queues.transport.wsgi.v1_1.queues.rst + zaqar.queues.transport.wsgi.v1_1.stats.rst + zaqar.version.rst diff --git a/doc/source/api/zaqar.cmd.gc.rst b/doc/source/api/zaqar.cmd.gc.rst new file mode 100644 index 000000000..3612a8a74 --- /dev/null +++ b/doc/source/api/zaqar.cmd.gc.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.cmd.gc` module +=============================== + +.. automodule:: zaqar.cmd.gc + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.cmd.server.rst b/doc/source/api/zaqar.cmd.server.rst new file mode 100644 index 000000000..30b71b9c5 --- /dev/null +++ b/doc/source/api/zaqar.cmd.server.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.cmd.server` module +=================================== + +.. automodule:: zaqar.cmd.server + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.access.rst b/doc/source/api/zaqar.common.access.rst new file mode 100644 index 000000000..9a663364a --- /dev/null +++ b/doc/source/api/zaqar.common.access.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.access` module +====================================== + +.. automodule:: zaqar.common.access + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.api.rst b/doc/source/api/zaqar.common.api.rst new file mode 100644 index 000000000..d37a79d57 --- /dev/null +++ b/doc/source/api/zaqar.common.api.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.api` module +=================================== + +.. automodule:: zaqar.common.api + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.cli.rst b/doc/source/api/zaqar.common.cli.rst new file mode 100644 index 000000000..5cc1d8875 --- /dev/null +++ b/doc/source/api/zaqar.common.cli.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.cli` module +=================================== + +.. automodule:: zaqar.common.cli + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.decorators.rst b/doc/source/api/zaqar.common.decorators.rst new file mode 100644 index 000000000..38ba1b7e0 --- /dev/null +++ b/doc/source/api/zaqar.common.decorators.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.decorators` module +========================================== + +.. automodule:: zaqar.common.decorators + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.errors.rst b/doc/source/api/zaqar.common.errors.rst new file mode 100644 index 000000000..8a1e7349b --- /dev/null +++ b/doc/source/api/zaqar.common.errors.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.errors` module +====================================== + +.. automodule:: zaqar.common.errors + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.pipeline.rst b/doc/source/api/zaqar.common.pipeline.rst new file mode 100644 index 000000000..b2913de25 --- /dev/null +++ b/doc/source/api/zaqar.common.pipeline.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.pipeline` module +======================================== + +.. automodule:: zaqar.common.pipeline + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.request.rst b/doc/source/api/zaqar.common.request.rst new file mode 100644 index 000000000..2604c6c4b --- /dev/null +++ b/doc/source/api/zaqar.common.request.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.request` module +======================================= + +.. automodule:: zaqar.common.request + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.response.rst b/doc/source/api/zaqar.common.response.rst new file mode 100644 index 000000000..2a6300f70 --- /dev/null +++ b/doc/source/api/zaqar.common.response.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.response` module +======================================== + +.. automodule:: zaqar.common.response + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.schemas.flavors.rst b/doc/source/api/zaqar.common.schemas.flavors.rst new file mode 100644 index 000000000..3ce30658e --- /dev/null +++ b/doc/source/api/zaqar.common.schemas.flavors.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.schemas.flavors` module +=============================================== + +.. automodule:: zaqar.common.schemas.flavors + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.schemas.pools.rst b/doc/source/api/zaqar.common.schemas.pools.rst new file mode 100644 index 000000000..62c3487f2 --- /dev/null +++ b/doc/source/api/zaqar.common.schemas.pools.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.schemas.pools` module +============================================= + +.. automodule:: zaqar.common.schemas.pools + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.storage.select.rst b/doc/source/api/zaqar.common.storage.select.rst new file mode 100644 index 000000000..d12712e41 --- /dev/null +++ b/doc/source/api/zaqar.common.storage.select.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.storage.select` module +============================================== + +.. automodule:: zaqar.common.storage.select + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.transport.wsgi.helpers.rst b/doc/source/api/zaqar.common.transport.wsgi.helpers.rst new file mode 100644 index 000000000..bf4ae0ebf --- /dev/null +++ b/doc/source/api/zaqar.common.transport.wsgi.helpers.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.transport.wsgi.helpers` module +====================================================== + +.. automodule:: zaqar.common.transport.wsgi.helpers + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.common.utils.rst b/doc/source/api/zaqar.common.utils.rst new file mode 100644 index 000000000..af9fc3da8 --- /dev/null +++ b/doc/source/api/zaqar.common.utils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.common.utils` module +===================================== + +.. automodule:: zaqar.common.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.i18n.rst b/doc/source/api/zaqar.i18n.rst new file mode 100644 index 000000000..190d5be81 --- /dev/null +++ b/doc/source/api/zaqar.i18n.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.i18n` module +============================= + +.. automodule:: zaqar.i18n + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.cache._backends.memory.rst b/doc/source/api/zaqar.openstack.common.cache._backends.memory.rst new file mode 100644 index 000000000..e5eb47dfe --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.cache._backends.memory.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.cache._backends.memory` module +================================================================ + +.. automodule:: zaqar.openstack.common.cache._backends.memory + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.cache.backends.rst b/doc/source/api/zaqar.openstack.common.cache.backends.rst new file mode 100644 index 000000000..7ed517808 --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.cache.backends.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.cache.backends` module +======================================================== + +.. automodule:: zaqar.openstack.common.cache.backends + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.cache.cache.rst b/doc/source/api/zaqar.openstack.common.cache.cache.rst new file mode 100644 index 000000000..6a659d182 --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.cache.cache.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.cache.cache` module +===================================================== + +.. automodule:: zaqar.openstack.common.cache.cache + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.config.generator.rst b/doc/source/api/zaqar.openstack.common.config.generator.rst new file mode 100644 index 000000000..69c98cd46 --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.config.generator.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.config.generator` module +========================================================== + +.. automodule:: zaqar.openstack.common.config.generator + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.excutils.rst b/doc/source/api/zaqar.openstack.common.excutils.rst new file mode 100644 index 000000000..c3f2fc29d --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.excutils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.excutils` module +================================================== + +.. automodule:: zaqar.openstack.common.excutils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.fileutils.rst b/doc/source/api/zaqar.openstack.common.fileutils.rst new file mode 100644 index 000000000..55837db4d --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.fileutils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.fileutils` module +=================================================== + +.. automodule:: zaqar.openstack.common.fileutils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.gettextutils.rst b/doc/source/api/zaqar.openstack.common.gettextutils.rst new file mode 100644 index 000000000..efdc50b2b --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.gettextutils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.gettextutils` module +====================================================== + +.. automodule:: zaqar.openstack.common.gettextutils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.importutils.rst b/doc/source/api/zaqar.openstack.common.importutils.rst new file mode 100644 index 000000000..a8755f83a --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.importutils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.importutils` module +===================================================== + +.. automodule:: zaqar.openstack.common.importutils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.jsonutils.rst b/doc/source/api/zaqar.openstack.common.jsonutils.rst new file mode 100644 index 000000000..6d6d5a123 --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.jsonutils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.jsonutils` module +=================================================== + +.. automodule:: zaqar.openstack.common.jsonutils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.local.rst b/doc/source/api/zaqar.openstack.common.local.rst new file mode 100644 index 000000000..9f526ed78 --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.local.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.local` module +=============================================== + +.. automodule:: zaqar.openstack.common.local + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.lockutils.rst b/doc/source/api/zaqar.openstack.common.lockutils.rst new file mode 100644 index 000000000..6ad4f9d30 --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.lockutils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.lockutils` module +=================================================== + +.. automodule:: zaqar.openstack.common.lockutils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.log.rst b/doc/source/api/zaqar.openstack.common.log.rst new file mode 100644 index 000000000..0c5c091fb --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.log.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.log` module +============================================= + +.. automodule:: zaqar.openstack.common.log + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.strutils.rst b/doc/source/api/zaqar.openstack.common.strutils.rst new file mode 100644 index 000000000..c8d2c3eb4 --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.strutils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.strutils` module +================================================== + +.. automodule:: zaqar.openstack.common.strutils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.openstack.common.timeutils.rst b/doc/source/api/zaqar.openstack.common.timeutils.rst new file mode 100644 index 000000000..46db714c7 --- /dev/null +++ b/doc/source/api/zaqar.openstack.common.timeutils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.openstack.common.timeutils` module +=================================================== + +.. automodule:: zaqar.openstack.common.timeutils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.api.v1.request.rst b/doc/source/api/zaqar.queues.api.v1.request.rst new file mode 100644 index 000000000..2469c9e20 --- /dev/null +++ b/doc/source/api/zaqar.queues.api.v1.request.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.api.v1.request` module +============================================== + +.. automodule:: zaqar.queues.api.v1.request + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.api.v1.response.rst b/doc/source/api/zaqar.queues.api.v1.response.rst new file mode 100644 index 000000000..dd1631ab6 --- /dev/null +++ b/doc/source/api/zaqar.queues.api.v1.response.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.api.v1.response` module +=============================================== + +.. automodule:: zaqar.queues.api.v1.response + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.api.v1_1.request.rst b/doc/source/api/zaqar.queues.api.v1_1.request.rst new file mode 100644 index 000000000..b4c339351 --- /dev/null +++ b/doc/source/api/zaqar.queues.api.v1_1.request.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.api.v1_1.request` module +================================================ + +.. automodule:: zaqar.queues.api.v1_1.request + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.api.v1_1.response.rst b/doc/source/api/zaqar.queues.api.v1_1.response.rst new file mode 100644 index 000000000..db3ccda8c --- /dev/null +++ b/doc/source/api/zaqar.queues.api.v1_1.response.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.api.v1_1.response` module +================================================= + +.. automodule:: zaqar.queues.api.v1_1.response + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.bootstrap.rst b/doc/source/api/zaqar.queues.bootstrap.rst new file mode 100644 index 000000000..6eb983b38 --- /dev/null +++ b/doc/source/api/zaqar.queues.bootstrap.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.bootstrap` module +========================================= + +.. automodule:: zaqar.queues.bootstrap + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.base.rst b/doc/source/api/zaqar.queues.storage.base.rst new file mode 100644 index 000000000..d94596b74 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.base.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.base` module +============================================ + +.. automodule:: zaqar.queues.storage.base + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.errors.rst b/doc/source/api/zaqar.queues.storage.errors.rst new file mode 100644 index 000000000..4c21077ae --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.errors.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.errors` module +============================================== + +.. automodule:: zaqar.queues.storage.errors + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.catalogue.rst b/doc/source/api/zaqar.queues.storage.mongodb.catalogue.rst new file mode 100644 index 000000000..3bb2989b0 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.catalogue.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.catalogue` module +========================================================= + +.. automodule:: zaqar.queues.storage.mongodb.catalogue + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.claims.rst b/doc/source/api/zaqar.queues.storage.mongodb.claims.rst new file mode 100644 index 000000000..49bf173c7 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.claims.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.claims` module +====================================================== + +.. automodule:: zaqar.queues.storage.mongodb.claims + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.controllers.rst b/doc/source/api/zaqar.queues.storage.mongodb.controllers.rst new file mode 100644 index 000000000..58a554dd5 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.controllers.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.controllers` module +=========================================================== + +.. automodule:: zaqar.queues.storage.mongodb.controllers + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.driver.rst b/doc/source/api/zaqar.queues.storage.mongodb.driver.rst new file mode 100644 index 000000000..e35b10839 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.driver.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.driver` module +====================================================== + +.. automodule:: zaqar.queues.storage.mongodb.driver + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.flavors.rst b/doc/source/api/zaqar.queues.storage.mongodb.flavors.rst new file mode 100644 index 000000000..1dc7b758f --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.flavors.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.flavors` module +======================================================= + +.. automodule:: zaqar.queues.storage.mongodb.flavors + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.messages.rst b/doc/source/api/zaqar.queues.storage.mongodb.messages.rst new file mode 100644 index 000000000..39840a4ae --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.messages.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.messages` module +======================================================== + +.. automodule:: zaqar.queues.storage.mongodb.messages + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.options.rst b/doc/source/api/zaqar.queues.storage.mongodb.options.rst new file mode 100644 index 000000000..4fcdc6dcc --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.options.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.options` module +======================================================= + +.. automodule:: zaqar.queues.storage.mongodb.options + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.pools.rst b/doc/source/api/zaqar.queues.storage.mongodb.pools.rst new file mode 100644 index 000000000..5dac61008 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.pools.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.pools` module +===================================================== + +.. automodule:: zaqar.queues.storage.mongodb.pools + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.queues.rst b/doc/source/api/zaqar.queues.storage.mongodb.queues.rst new file mode 100644 index 000000000..df7e5a193 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.queues.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.queues` module +====================================================== + +.. automodule:: zaqar.queues.storage.mongodb.queues + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.mongodb.utils.rst b/doc/source/api/zaqar.queues.storage.mongodb.utils.rst new file mode 100644 index 000000000..33579a7d1 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.mongodb.utils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.mongodb.utils` module +===================================================== + +.. automodule:: zaqar.queues.storage.mongodb.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.pipeline.rst b/doc/source/api/zaqar.queues.storage.pipeline.rst new file mode 100644 index 000000000..ba84a8cbf --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.pipeline.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.pipeline` module +================================================ + +.. automodule:: zaqar.queues.storage.pipeline + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.pooling.rst b/doc/source/api/zaqar.queues.storage.pooling.rst new file mode 100644 index 000000000..d398541c0 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.pooling.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.pooling` module +=============================================== + +.. automodule:: zaqar.queues.storage.pooling + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.redis.claims.rst b/doc/source/api/zaqar.queues.storage.redis.claims.rst new file mode 100644 index 000000000..0ee675c4a --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.redis.claims.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.redis.claims` module +==================================================== + +.. automodule:: zaqar.queues.storage.redis.claims + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.redis.controllers.rst b/doc/source/api/zaqar.queues.storage.redis.controllers.rst new file mode 100644 index 000000000..5a7487fcb --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.redis.controllers.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.redis.controllers` module +========================================================= + +.. automodule:: zaqar.queues.storage.redis.controllers + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.redis.driver.rst b/doc/source/api/zaqar.queues.storage.redis.driver.rst new file mode 100644 index 000000000..1e1ca39d5 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.redis.driver.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.redis.driver` module +==================================================== + +.. automodule:: zaqar.queues.storage.redis.driver + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.redis.messages.rst b/doc/source/api/zaqar.queues.storage.redis.messages.rst new file mode 100644 index 000000000..e67d5f335 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.redis.messages.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.redis.messages` module +====================================================== + +.. automodule:: zaqar.queues.storage.redis.messages + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.redis.models.rst b/doc/source/api/zaqar.queues.storage.redis.models.rst new file mode 100644 index 000000000..74b65bbe5 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.redis.models.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.redis.models` module +==================================================== + +.. automodule:: zaqar.queues.storage.redis.models + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.redis.options.rst b/doc/source/api/zaqar.queues.storage.redis.options.rst new file mode 100644 index 000000000..3d43fb8b8 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.redis.options.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.redis.options` module +===================================================== + +.. automodule:: zaqar.queues.storage.redis.options + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.redis.queues.rst b/doc/source/api/zaqar.queues.storage.redis.queues.rst new file mode 100644 index 000000000..fc1366a3c --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.redis.queues.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.redis.queues` module +==================================================== + +.. automodule:: zaqar.queues.storage.redis.queues + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.redis.utils.rst b/doc/source/api/zaqar.queues.storage.redis.utils.rst new file mode 100644 index 000000000..c3652a60a --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.redis.utils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.redis.utils` module +=================================================== + +.. automodule:: zaqar.queues.storage.redis.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.catalogue.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.catalogue.rst new file mode 100644 index 000000000..096e2bf3d --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.catalogue.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.catalogue` module +============================================================ + +.. automodule:: zaqar.queues.storage.sqlalchemy.catalogue + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.claims.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.claims.rst new file mode 100644 index 000000000..d23c02f20 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.claims.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.claims` module +========================================================= + +.. automodule:: zaqar.queues.storage.sqlalchemy.claims + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.controllers.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.controllers.rst new file mode 100644 index 000000000..e55a32f4e --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.controllers.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.controllers` module +============================================================== + +.. automodule:: zaqar.queues.storage.sqlalchemy.controllers + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.driver.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.driver.rst new file mode 100644 index 000000000..cc1c9a62c --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.driver.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.driver` module +========================================================= + +.. automodule:: zaqar.queues.storage.sqlalchemy.driver + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.messages.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.messages.rst new file mode 100644 index 000000000..7b2951bb2 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.messages.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.messages` module +=========================================================== + +.. automodule:: zaqar.queues.storage.sqlalchemy.messages + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.options.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.options.rst new file mode 100644 index 000000000..aeb68c96c --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.options.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.options` module +========================================================== + +.. automodule:: zaqar.queues.storage.sqlalchemy.options + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.pools.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.pools.rst new file mode 100644 index 000000000..de94c23a2 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.pools.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.pools` module +======================================================== + +.. automodule:: zaqar.queues.storage.sqlalchemy.pools + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.queues.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.queues.rst new file mode 100644 index 000000000..e5edcab95 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.queues.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.queues` module +========================================================= + +.. automodule:: zaqar.queues.storage.sqlalchemy.queues + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.tables.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.tables.rst new file mode 100644 index 000000000..128b670ed --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.tables.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.tables` module +========================================================= + +.. automodule:: zaqar.queues.storage.sqlalchemy.tables + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.sqlalchemy.utils.rst b/doc/source/api/zaqar.queues.storage.sqlalchemy.utils.rst new file mode 100644 index 000000000..310cfc972 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.sqlalchemy.utils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.sqlalchemy.utils` module +======================================================== + +.. automodule:: zaqar.queues.storage.sqlalchemy.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.storage.utils.rst b/doc/source/api/zaqar.queues.storage.utils.rst new file mode 100644 index 000000000..e61819c65 --- /dev/null +++ b/doc/source/api/zaqar.queues.storage.utils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.storage.utils` module +============================================= + +.. automodule:: zaqar.queues.storage.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.auth.rst b/doc/source/api/zaqar.queues.transport.auth.rst new file mode 100644 index 000000000..2f607610e --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.auth.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.auth` module +============================================== + +.. automodule:: zaqar.queues.transport.auth + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.base.rst b/doc/source/api/zaqar.queues.transport.base.rst new file mode 100644 index 000000000..c31f33c32 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.base.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.base` module +============================================== + +.. automodule:: zaqar.queues.transport.base + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.utils.rst b/doc/source/api/zaqar.queues.transport.utils.rst new file mode 100644 index 000000000..b74433ef4 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.utils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.utils` module +=============================================== + +.. automodule:: zaqar.queues.transport.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.validation.rst b/doc/source/api/zaqar.queues.transport.validation.rst new file mode 100644 index 000000000..c961328e6 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.validation.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.validation` module +==================================================== + +.. automodule:: zaqar.queues.transport.validation + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.app.rst b/doc/source/api/zaqar.queues.transport.wsgi.app.rst new file mode 100644 index 000000000..9505d66ab --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.app.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.app` module +================================================== + +.. automodule:: zaqar.queues.transport.wsgi.app + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.driver.rst b/doc/source/api/zaqar.queues.transport.wsgi.driver.rst new file mode 100644 index 000000000..8e2923e07 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.driver.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.driver` module +===================================================== + +.. automodule:: zaqar.queues.transport.wsgi.driver + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.errors.rst b/doc/source/api/zaqar.queues.transport.wsgi.errors.rst new file mode 100644 index 000000000..7d5d4887a --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.errors.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.errors` module +===================================================== + +.. automodule:: zaqar.queues.transport.wsgi.errors + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.utils.rst b/doc/source/api/zaqar.queues.transport.wsgi.utils.rst new file mode 100644 index 000000000..f94927439 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.utils.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.utils` module +==================================================== + +.. automodule:: zaqar.queues.transport.wsgi.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_0.claims.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.claims.rst new file mode 100644 index 000000000..ee2d13e8b --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.claims.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_0.claims` module +========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_0.claims + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_0.health.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.health.rst new file mode 100644 index 000000000..1e4ad162e --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.health.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_0.health` module +========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_0.health + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_0.homedoc.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.homedoc.rst new file mode 100644 index 000000000..adaf98524 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.homedoc.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_0.homedoc` module +=========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_0.homedoc + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_0.messages.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.messages.rst new file mode 100644 index 000000000..c22219012 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.messages.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_0.messages` module +============================================================ + +.. automodule:: zaqar.queues.transport.wsgi.v1_0.messages + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_0.metadata.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.metadata.rst new file mode 100644 index 000000000..09006fbdd --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.metadata.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_0.metadata` module +============================================================ + +.. automodule:: zaqar.queues.transport.wsgi.v1_0.metadata + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_0.pools.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.pools.rst new file mode 100644 index 000000000..cd398cecb --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.pools.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_0.pools` module +========================================================= + +.. automodule:: zaqar.queues.transport.wsgi.v1_0.pools + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_0.queues.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.queues.rst new file mode 100644 index 000000000..cbc208302 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.queues.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_0.queues` module +========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_0.queues + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_0.stats.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.stats.rst new file mode 100644 index 000000000..ab6806a95 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_0.stats.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_0.stats` module +========================================================= + +.. automodule:: zaqar.queues.transport.wsgi.v1_0.stats + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.claims.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.claims.rst new file mode 100644 index 000000000..bc841b719 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.claims.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.claims` module +========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.claims + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.flavors.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.flavors.rst new file mode 100644 index 000000000..4601aaab5 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.flavors.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.flavors` module +=========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.flavors + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.health.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.health.rst new file mode 100644 index 000000000..bd8da6331 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.health.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.health` module +========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.health + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.homedoc.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.homedoc.rst new file mode 100644 index 000000000..076d26415 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.homedoc.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.homedoc` module +=========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.homedoc + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.messages.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.messages.rst new file mode 100644 index 000000000..198ab397c --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.messages.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.messages` module +============================================================ + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.messages + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.ping.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.ping.rst new file mode 100644 index 000000000..0df07ae7e --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.ping.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.ping` module +======================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.ping + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.pools.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.pools.rst new file mode 100644 index 000000000..90c3a6a56 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.pools.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.pools` module +========================================================= + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.pools + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.queues.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.queues.rst new file mode 100644 index 000000000..c1ac4a690 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.queues.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.queues` module +========================================================== + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.queues + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.queues.transport.wsgi.v1_1.stats.rst b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.stats.rst new file mode 100644 index 000000000..4a0888273 --- /dev/null +++ b/doc/source/api/zaqar.queues.transport.wsgi.v1_1.stats.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.queues.transport.wsgi.v1_1.stats` module +========================================================= + +.. automodule:: zaqar.queues.transport.wsgi.v1_1.stats + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/zaqar.version.rst b/doc/source/api/zaqar.version.rst new file mode 100644 index 000000000..d468d297f --- /dev/null +++ b/doc/source/api/zaqar.version.rst @@ -0,0 +1,7 @@ +The :mod:`zaqar.version` module +================================ + +.. automodule:: zaqar.version + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/index.rst b/doc/source/index.rst index ba6b5bb97..8c5fe3f52 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -117,6 +117,14 @@ Other resources gerrit jenkins +API reference +============= + +.. toctree:: + :maxdepth: 3 + + api/autoindex + Modules reference ================= @@ -125,3 +133,10 @@ Modules reference transport storage + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/storage.rst b/doc/source/storage.rst index 4260f9690..44a1b72fa 100644 --- a/doc/source/storage.rst +++ b/doc/source/storage.rst @@ -5,16 +5,21 @@ Storage .. currentmodule:: zaqar.queues.storage.base .. autoclass:: DataDriverBase + :noindex: :members: .. autoclass:: ControlDriverBase + :noindex: :members: .. autoclass:: Queue + :noindex: :members: .. autoclass:: Message + :noindex: :members: .. autoclass:: Claim + :noindex: :members: diff --git a/doc/source/transport.rst b/doc/source/transport.rst index 83a302967..6f6f1f16a 100644 --- a/doc/source/transport.rst +++ b/doc/source/transport.rst @@ -5,4 +5,5 @@ Transport .. currentmodule:: zaqar.queues.transport.base .. autoclass:: DriverBase + :noindex: :members: diff --git a/tools/doc/find_autodoc_modules.sh b/tools/doc/find_autodoc_modules.sh new file mode 100755 index 000000000..4986ba0ae --- /dev/null +++ b/tools/doc/find_autodoc_modules.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +ZAQAR_DIR='../../zaqar/' # include trailing slash +DOCS_DIR='source' + +modules='' +for x in `find ${ZAQAR_DIR} -name '*.py' | grep -v zaqar/tests | grep -v zaqar/bench`; do + if [ `basename ${x} .py` == "__init__" ] ; then + continue + fi + relative=zaqar.`echo ${x} | sed -e 's$^'${ZAQAR_DIR}'$$' -e 's/.py$//' -e 's$/$.$g'` + modules="${modules} ${relative}" +done + +for mod in ${modules} ; do + if [ ! -f "${DOCS_DIR}/${mod}.rst" ]; + then + echo ${mod} + fi +done \ No newline at end of file diff --git a/tools/doc/generate_autodoc_index.sh b/tools/doc/generate_autodoc_index.sh new file mode 100755 index 000000000..62e50ba1e --- /dev/null +++ b/tools/doc/generate_autodoc_index.sh @@ -0,0 +1,46 @@ +#!/bin/sh + +SOURCEDIR=../../doc/source/api + +if [ ! -d ${SOURCEDIR} ] ; then + mkdir -p ${SOURCEDIR} +fi + +for x in `./find_autodoc_modules.sh`; +do + echo "Generating ${SOURCEDIR}/${x}.rst" + echo "${SOURCEDIR}/${x}.rst" >> .autogenerated + heading="The :mod:\`${x}\` module" + # Figure out how long the heading is + # and make sure to emit that many '=' under + # it to avoid heading format errors + # in Sphinx. + heading_len=$(echo "$heading" | wc -c) + underline=$(head -c $heading_len < /dev/zero | tr '\0' '=') + ( cat < ${SOURCEDIR}/${x}.rst + +done + +if [ ! -f ${SOURCEDIR}/autoindex.rst ] ; then + + cat > ${SOURCEDIR}/autoindex.rst <> ${SOURCEDIR}/autoindex.rst + done + + echo ${SOURCEDIR}/autoindex.rst >> .autogenerated +fi \ No newline at end of file diff --git a/zaqar/common/api.py b/zaqar/common/api.py index 6ded39f1e..ea92b88a4 100644 --- a/zaqar/common/api.py +++ b/zaqar/common/api.py @@ -32,15 +32,16 @@ class Api(object): """Returns the schema for an operation :param operation: Operation for which params need - to be validated. + to be validated. :type operation: `six.text_type` :returns: Operation's schema :rtype: dict :raises: `errors.InvalidOperation` if the operation - does not exist + does not exist """ + try: return self.schema[operation] except KeyError: @@ -57,14 +58,14 @@ class Api(object): request since they are already validated server side. :param operation: Operation's for which params need - to be validated. + to be validated. :type operation: `six.text_type` :param params: Params to validate :type params: dict :returns: True if the schema is valid, False otherwise :raises: `errors.InvalidOperation` if the operation - does not exist + does not exist """ if operation not in self.validators: diff --git a/zaqar/common/decorators.py b/zaqar/common/decorators.py index ce8b43749..7772299ce 100644 --- a/zaqar/common/decorators.py +++ b/zaqar/common/decorators.py @@ -58,7 +58,7 @@ def caches(keygen, ttl, cond=None): msgpack. Note that you can also flag a remover method such that it - will purge an associated item from the cache, e.g.: + will purge an associated item from the cache, e.g.:: def project_cache_key(user, project=None): return user + ':' + str(project) diff --git a/zaqar/common/request.py b/zaqar/common/request.py index 8dff09a51..0c3f1907b 100644 --- a/zaqar/common/request.py +++ b/zaqar/common/request.py @@ -24,9 +24,8 @@ class Request(object): Transport will generate a request object and send to this the API to be processed. - :param operation: Operation to identify the API call being processed, i.e: - - get_queues - - get_messages + :param operation: Operation to identify the API call being processed, + i.e: 'get_queues', 'get_messages' :type operation: str :param content: Request's body. Default: None :type content: str diff --git a/zaqar/common/utils.py b/zaqar/common/utils.py index 6890f2076..26ec5e104 100644 --- a/zaqar/common/utils.py +++ b/zaqar/common/utils.py @@ -30,7 +30,7 @@ def fields(d, names, pred=lambda x: True, :param key_transform: a transform to apply to the key before returning it :type key_transform: a -> a :param value_transform: a transform to apply to the value before - returning it + returning it :type value_transform: a -> a :rtype: dict """ diff --git a/zaqar/queues/storage/base.py b/zaqar/queues/storage/base.py index f06a79f65..b205e8707 100644 --- a/zaqar/queues/storage/base.py +++ b/zaqar/queues/storage/base.py @@ -545,6 +545,7 @@ class PoolsBase(ControllerBase): :returns: A list of pools - name, weight, uri :rtype: [{}] """ + raise NotImplementedError @abc.abstractmethod @@ -556,11 +557,12 @@ class PoolsBase(ControllerBase): :param weight: the likelihood that this pool will be used :type weight: int :param uri: A URI that can be used by a storage client - (e.g., pymongo) to access this pool. + (e.g., pymongo) to access this pool. :type uri: six.text_type :param options: Options used to configure this pool :type options: dict """ + raise NotImplementedError @abc.abstractmethod @@ -575,6 +577,7 @@ class PoolsBase(ControllerBase): :rtype: {} :raises: PoolDoesNotExist if not found """ + raise NotImplementedError @abc.abstractmethod @@ -586,6 +589,7 @@ class PoolsBase(ControllerBase): :returns: True if the pool exists :rtype: bool """ + raise NotImplementedError @abc.abstractmethod @@ -596,6 +600,7 @@ class PoolsBase(ControllerBase): :type name: six.text_type :rtype: None """ + raise NotImplementedError @abc.abstractmethod @@ -608,11 +613,13 @@ class PoolsBase(ControllerBase): :type kwargs: dict :raises: PoolDoesNotExist """ + raise NotImplementedError @abc.abstractmethod def drop_all(self): """Deletes all pools from storage.""" + raise NotImplementedError @@ -634,6 +641,7 @@ class CatalogueBase(ControllerBase): :returns: [{'project': ..., 'queue': ..., 'pool': ...},] :rtype: [dict] """ + raise NotImplementedError @abc.abstractmethod @@ -648,6 +656,7 @@ class CatalogueBase(ControllerBase): :rtype: dict :raises: QueueNotMapped """ + raise NotImplementedError @abc.abstractmethod @@ -673,6 +682,7 @@ class CatalogueBase(ControllerBase): :param pool: pool identifier to associate this queue with :type pool: six.text_type """ + raise NotImplementedError @abc.abstractmethod @@ -684,6 +694,7 @@ class CatalogueBase(ControllerBase): :param queue: The queue name to remove :type queue: six.text_type """ + raise NotImplementedError @abc.abstractmethod @@ -698,11 +709,13 @@ class CatalogueBase(ControllerBase): :type pools: six.text_type :raises: QueueNotMapped """ + raise NotImplementedError @abc.abstractmethod def drop_all(self): """Drops all catalogue entries from storage.""" + raise NotImplementedError @@ -725,6 +738,7 @@ class FlavorsBase(ControllerBase): :returns: A list of flavors - name, project, flavor :rtype: [{}] """ + raise NotImplementedError @abc.abstractmethod @@ -740,6 +754,7 @@ class FlavorsBase(ControllerBase): :param capabilities: Flavor capabilities :type capabilities: dict """ + raise NotImplementedError @abc.abstractmethod @@ -755,6 +770,7 @@ class FlavorsBase(ControllerBase): :rtype: {} :raises: FlavorDoesNotExist if not found """ + raise NotImplementedError @abc.abstractmethod @@ -768,6 +784,7 @@ class FlavorsBase(ControllerBase): :returns: True if the flavor exists :rtype: bool """ + raise NotImplementedError @abc.abstractmethod @@ -780,6 +797,7 @@ class FlavorsBase(ControllerBase): :type project: six.text_type :rtype: None """ + raise NotImplementedError @abc.abstractmethod @@ -794,9 +812,11 @@ class FlavorsBase(ControllerBase): :type kwargs: dict :raises: FlavorDoesNotExist """ + raise NotImplementedError @abc.abstractmethod def drop_all(self): """Deletes all flavors from storage.""" + raise NotImplementedError diff --git a/zaqar/queues/storage/mongodb/catalogue.py b/zaqar/queues/storage/mongodb/catalogue.py index 333df16ad..fa9c2ad07 100644 --- a/zaqar/queues/storage/mongodb/catalogue.py +++ b/zaqar/queues/storage/mongodb/catalogue.py @@ -15,12 +15,14 @@ """MongoDB storage controller for the queues catalogue. -Serves to construct an association between a project + queue -> pool +Serves to construct an association between a project + queue -> pool. -{ - 'p_q': project_queue :: six.text_type, - 's': pool_identifier :: six.text_type -} +:: + + { + 'p_q': project_queue :: six.text_type, + 's': pool_identifier :: six.text_type + } """ import zaqar.openstack.common.log as logging diff --git a/zaqar/queues/storage/mongodb/messages.py b/zaqar/queues/storage/mongodb/messages.py index 8f0a08bee..39de3e911 100644 --- a/zaqar/queues/storage/mongodb/messages.py +++ b/zaqar/queues/storage/mongodb/messages.py @@ -113,17 +113,19 @@ class MessageController(storage.Message): Messages are scoped by project + queue. - Messages: - Name Field - ------------------------- - scope -> p_q - ttl -> t - expires -> e - marker -> k - body -> b - claim -> c - client uuid -> u - transaction -> tx + :: + + Messages: + Name Field + ------------------------- + scope -> p_q + ttl -> t + expires -> e + marker -> k + body -> b + claim -> c + client uuid -> u + transaction -> tx """ def __init__(self, *args, **kwargs): diff --git a/zaqar/queues/storage/mongodb/queues.py b/zaqar/queues/storage/mongodb/queues.py index 3e58d4caa..8966aa14e 100644 --- a/zaqar/queues/storage/mongodb/queues.py +++ b/zaqar/queues/storage/mongodb/queues.py @@ -65,20 +65,22 @@ class QueueController(storage.Queue): Queues are scoped by project, which is prefixed to the queue name. - Queues: + :: - Name Field - --------------------- - name -> p_q - msg counter -> c - metadata -> m + Queues: - Message Counter: + Name Field + --------------------- + name -> p_q + msg counter -> c + metadata -> m - Name Field - ------------------- - value -> v - modified ts -> t + Message Counter: + + Name Field + ------------------- + value -> v + modified ts -> t """ def __init__(self, *args, **kwargs): diff --git a/zaqar/queues/storage/redis/claims.py b/zaqar/queues/storage/redis/claims.py index 6da97e804..626e185f8 100644 --- a/zaqar/queues/storage/redis/claims.py +++ b/zaqar/queues/storage/redis/claims.py @@ -45,31 +45,39 @@ class ClaimController(storage.Claim): """Implements claim resource operations using Redis. Redis Data Structures: - ---------------------- + 1. Claims list (Redis set) contains claim IDs - Key: ..claims + Key: ..claims - Name Field - ------------------------- - claim_ids m + +-------------+---------+ + | Name | Field | + +=============+=========+ + | claim_ids | m | + +-------------+---------+ - 2. Claimed Messages (Redis set) contains the list of - message ids stored per claim + 2. Claimed Messages (Redis set) contains the list + of message ids stored per claim - Key: .messages + Key: .messages 3. Claim info (Redis hash): - Key: + Key: - Name Field - ------------------------- - ttl -> t - id -> id - expires -> e - num_messages -> n + +----------------+---------+ + | Name | Field | + +================+=========+ + | ttl | t | + +----------------+---------+ + | id | id | + +----------------+---------+ + | expires | e | + +----------------+---------+ + | num_messages | n | + +----------------+---------+ """ + def __init__(self, *args, **kwargs): super(ClaimController, self).__init__(*args, **kwargs) self._client = self.driver.connection diff --git a/zaqar/queues/storage/redis/messages.py b/zaqar/queues/storage/redis/messages.py index 4cc967058..ae2b4a959 100644 --- a/zaqar/queues/storage/redis/messages.py +++ b/zaqar/queues/storage/redis/messages.py @@ -51,44 +51,52 @@ class MessageController(storage.Message): Messages are scoped by project + queue. Redis Data Structures: - ---------------------- + 1. Message id's list (Redis sorted set) - Each queue in the system has a set of message ids currently - in the queue. The list is sorted based on a ranking which is - incremented atomically using the counter(MESSAGE_RANK_COUNTER_SUFFIX) - also stored in the database for every queue. + Each queue in the system has a set of message ids currently + in the queue. The list is sorted based on a ranking which is + incremented atomically using the counter(MESSAGE_RANK_COUNTER_SUFFIX) + also stored in the database for every queue. - Key: ..messages + Key: ..messages 2. Index of message ID lists (Redis sorted set) - This is a sorted set that facilitates discovery of all the - message ID lists. This is necessary when performing - garbage collection on the IDs contained within these lists. + This is a sorted set that facilitates discovery of all the + message ID lists. This is necessary when performing + garbage collection on the IDs contained within these lists. - Key: msgset_index + Key: msgset_index 3. Messages(Redis Hash): - Scoped by the UUID of the message, the redis datastructure - has the following information. + Scoped by the UUID of the message, the redis datastructure + has the following information. - - Name Field - ----------------------------- - id -> id - ttl -> t - expires -> e - body -> b - claim -> c - claim expiry time -> c.e - client uuid -> u - created time -> cr + +---------------------+---------+ + | Name | Field | + +=====================+=========+ + | id | id | + +---------------------+---------+ + | ttl | t | + +---------------------+---------+ + | expires | e | + +---------------------+---------+ + | body | b | + +---------------------+---------+ + | claim | c | + +---------------------+---------+ + | claim expiry time | c.e | + +---------------------+---------+ + | client uuid | u | + +---------------------+---------+ + | created time | cr | + +---------------------+---------+ 4. Messages rank counter (Redis Hash): - Key: ..rank_counter + Key: ..rank_counter """ def __init__(self, *args, **kwargs): diff --git a/zaqar/queues/storage/redis/queues.py b/zaqar/queues/storage/redis/queues.py index 95f7376c6..6ba6a14e5 100644 --- a/zaqar/queues/storage/redis/queues.py +++ b/zaqar/queues/storage/redis/queues.py @@ -37,25 +37,30 @@ class QueueController(storage.Queue): queue name. Redis Data Structures: - ---------------------- + 1. Queue Index (Redis sorted set): - Set of all queues for the given project, ordered by name. + Set of all queues for the given project, ordered by name. - Key: .queues_set + Key: .queues_set - Id Value - ---------------------------------------- - name -> . + +--------+-----------------------------+ + | Id | Value | + +========+=============================+ + | name | . | + +--------+-----------------------------+ 2. Queue Information (Redis hash): Key: . - Name Field - ------------------------------- - metadata -> m - creation timestamp -> t + +----------------------+---------+ + | Name | Field | + +======================+=========+ + | metadata | m | + +----------------------+---------+ + | creation timestamp | t | + +----------------------+---------+ """ def __init__(self, *args, **kwargs): diff --git a/zaqar/queues/transport/wsgi/v1_0/pools.py b/zaqar/queues/transport/wsgi/v1_0/pools.py index c14b7d989..1fd5ad192 100644 --- a/zaqar/queues/transport/wsgi/v1_0/pools.py +++ b/zaqar/queues/transport/wsgi/v1_0/pools.py @@ -19,18 +19,20 @@ A pool is added by an operator by interacting with the pooling-related endpoints. When specifying a pool, the following fields are required: -{ - "name": string, - "weight": integer, - "uri": string::uri -} +:: + + { + "name": string, + "weight": integer, + "uri": string::uri + } Furthermore, depending on the underlying storage type of pool being -registered, there is an optional field: +registered, there is an optional field:: -{ - "options": {...} -} + { + "options": {...} + } """ import falcon @@ -53,19 +55,23 @@ class Listing(object): :param pools_controller: means to interact with storage """ + def __init__(self, pools_controller): self._ctrl = pools_controller def on_get(self, request, response, project_id): """Returns a pool listing as objects embedded in an array: - [ - {"href": "", "weight": 100, "uri": ""}, - ... - ] + :: + + [ + {"href": "", "weight": 100, "uri": ""}, + ... + ] :returns: HTTP | [200, 204] """ + LOG.debug(u'LIST pools') store = {} @@ -92,6 +98,7 @@ class Resource(object): :param pools_controller: means to interact with storage """ + def __init__(self, pools_controller): self._ctrl = pools_controller validator_type = jsonschema.Draft4Validator @@ -105,9 +112,11 @@ class Resource(object): def on_get(self, request, response, project_id, pool): """Returns a JSON object for a single pool entry: - {"weight": 100, "uri": "", options: {...}} + :: - :returns: HTTP | [200, 404] + {"weight": 100, "uri": "", options: {...}} + + :returns: HTTP | [200, 404] """ LOG.debug(u'GET pool - name: %s', pool) data = None @@ -130,12 +139,15 @@ class Resource(object): def on_put(self, request, response, project_id, pool): """Registers a new pool. Expects the following input: - {"weight": 100, "uri": ""} + :: + + {"weight": 100, "uri": ""} An options object may also be provided. :returns: HTTP | [201, 204] """ + LOG.debug(u'PUT pool - name: %s', pool) data = wsgi_utils.load(request) @@ -155,6 +167,7 @@ class Resource(object): :returns: HTTP | 204 """ + LOG.debug(u'DELETE pool - name: %s', pool) self._ctrl.delete(pool) response.status = falcon.HTTP_204 @@ -171,6 +184,7 @@ class Resource(object): :returns: HTTP | 200,400 """ + LOG.debug(u'PATCH pool - name: %s', pool) data = wsgi_utils.load(request) diff --git a/zaqar/queues/transport/wsgi/v1_1/flavors.py b/zaqar/queues/transport/wsgi/v1_1/flavors.py index 42ecbadb1..a85143be6 100644 --- a/zaqar/queues/transport/wsgi/v1_1/flavors.py +++ b/zaqar/queues/transport/wsgi/v1_1/flavors.py @@ -40,13 +40,14 @@ class Listing(object): def on_get(self, request, response, project_id): """Returns a flavor listing as objects embedded in an array: - [ - {"href": "", "capabilities": {}, "pool": ""}, - ... - ] + :: + + [ + {"href": "", "capabilities": {}, "pool": ""}, + ... + ] :returns: HTTP | [200, 204] - """ LOG.debug(u'LIST flavors for project_id %s' % project_id) @@ -87,10 +88,11 @@ class Resource(object): def on_get(self, request, response, project_id, flavor): """Returns a JSON object for a single flavor entry: - {"pool": "", capabilities: {...}} + :: + + {"pool": "", capabilities: {...}} :returns: HTTP | [200, 404] - """ LOG.debug(u'GET flavor - name: %s', flavor) @@ -115,7 +117,9 @@ class Resource(object): def on_put(self, request, response, project_id, flavor): """Registers a new flavor. Expects the following input: - {"pool": "my-pool", "capabilities": {}} + :: + + {"pool": "my-pool", "capabilities": {}} A capabilities object may also be provided. @@ -145,7 +149,6 @@ class Resource(object): """Deregisters a flavor. :returns: HTTP | [204] - """ LOG.debug(u'DELETE flavor - name: %s', flavor) @@ -163,7 +166,6 @@ class Resource(object): badly formatted input. :returns: HTTP | [200, 400] - """ LOG.debug(u'PATCH flavor - name: %s', flavor) diff --git a/zaqar/queues/transport/wsgi/v1_1/pools.py b/zaqar/queues/transport/wsgi/v1_1/pools.py index 06cc8b6f6..fd7d588bb 100644 --- a/zaqar/queues/transport/wsgi/v1_1/pools.py +++ b/zaqar/queues/transport/wsgi/v1_1/pools.py @@ -19,18 +19,21 @@ A pool is added by an operator by interacting with the pooling-related endpoints. When specifying a pool, the following fields are required: -{ - "name": string, - "weight": integer, - "uri": string::uri -} +:: + + { + "name": string, + "weight": integer, + "uri": string::uri + } Furthermore, depending on the underlying storage type of pool being registered, there is an optional field: +:: -{ - "options": {...} -} + { + "options": {...} + } """ import falcon @@ -53,19 +56,23 @@ class Listing(object): :param pools_controller: means to interact with storage """ + def __init__(self, pools_controller): self._ctrl = pools_controller def on_get(self, request, response, project_id): """Returns a pool listing as objects embedded in an array: - [ - {"href": "", "weight": 100, "uri": ""}, - ... - ] + :: + + [ + {"href": "", "weight": 100, "uri": ""}, + ... + ] :returns: HTTP | [200, 204] """ + LOG.debug(u'LIST pools') store = {} @@ -91,6 +98,7 @@ class Resource(object): :param pools_controller: means to interact with storage """ + def __init__(self, pools_controller): self._ctrl = pools_controller validator_type = jsonschema.Draft4Validator @@ -104,10 +112,13 @@ class Resource(object): def on_get(self, request, response, project_id, pool): """Returns a JSON object for a single pool entry: - {"weight": 100, "uri": "", options: {...}} + :: + + {"weight": 100, "uri": "", options: {...}} :returns: HTTP | [200, 404] """ + LOG.debug(u'GET pool - name: %s', pool) data = None detailed = request.get_param_as_bool('detailed') or False @@ -128,12 +139,15 @@ class Resource(object): def on_put(self, request, response, project_id, pool): """Registers a new pool. Expects the following input: - {"weight": 100, "uri": ""} + :: + + {"weight": 100, "uri": ""} An options object may also be provided. :returns: HTTP | [201, 204] """ + LOG.debug(u'PUT pool - name: %s', pool) data = wsgi_utils.load(request) @@ -153,6 +167,7 @@ class Resource(object): :returns: HTTP | 204 """ + LOG.debug(u'DELETE pool - name: %s', pool) self._ctrl.delete(pool) response.status = falcon.HTTP_204 @@ -169,6 +184,7 @@ class Resource(object): :returns: HTTP | 200,400 """ + LOG.debug(u'PATCH pool - name: %s', pool) data = wsgi_utils.load(request)