Jump to: navigation, search

Zaqar/specs/endpoint

< Zaqar
Revision as of 18:47, 20 March 2013 by Kgriffs (talk | contribs) (Limit queue metadata to 4 KiB)

Marconi Endpoints

Endpoints define the protocol between a given transport and the storage driver. In this way, multiple transports like HTTP and ZMQ can be supported; they are not exclusive and can be enabled directly from the config file.

Related endpoints are grouped into one of several controllers, who's interface is defined by an abstract base class. The storage driver provides a concrete implementation for each controller type.

For specific implementations read: HTTP, ZMQ

Common Endpoints, exposed by Storage Drivers

Storage drivers export 3 controllers which group endpoints by resource.

TODO(kgriffs): Define params and valid ranges for each.

QueueController

  • List Queues
    • Return list of queue names in alphabetical order
    • Optional marker, limit params to support paging
    • Optionally include queue metadata in listing
  • Get queue metadata
  • Upsert Queue
    • Can specify arbitrary metadata (optional).
    • Top-level field names in the metadata document MUST NOT start with the underscore character as it is reserved for future use.
    • Metadata is limited to 4 KiB in size
    • (For Updates) The document that the client provides will completely overwrite existing metadata (partial updates are planned for a future release)
  • Delete Queue
  • Get queue stats
  • Get Actions
    • Delete message
    • Claim messages
    • Update claim
    • Release claim
    • Claim expired
    • Message expired

MessageController

  • Get Message(s)
  • Post Message(s)
  • Delete Message

ClaimController

  • Claim messages
  • Query claim
  • Update claim
  • Release Claim
  • Claim Stats

Transport-Specific

The following endpoints only apply to specific transports.

WSGI

  • Node health (test_reachable)
  • Get home document