Zaqar/specs/proxy/v1

Marconi Proxy: v1 Blueprint

Overview

Marconi's proxy service was written to enable scaling out a Marconi deployment at the partition level. It is controlled through an HTTP API.

Reference

For authoritative header/general details, please refer to the Marconi Queues API v1 Spec.

Endpoints Synopsis

# Proxy-specific endpoints
## Partition operations
GET /partitions
GET /partitions/{partition}
PUT /partitions/{partition}
DELETE /partitions/{partition}

## Catalogue operations
GET /catalogue
GET /catalogue/{queue}
GET /health

# Queues API intercepting endpoints
## Implicitly modify catalogue
GET /queues
GET /queues/{queue}
PUT /queues/{queue}
DELETE /queues/{queue}

# Operations forwarded to Queues API
## Informative
GET /v1

## Claims-forwarding
POST /queues/{queue}/claims
GET /queues/{queue}/claims/{claim_id}
PATCH /queues/{queue}/claims/{claim_id}
DELETE /queues/{queue}/claims/{claim_id}

## Messages forwarding
GET /queues/{queue}/messages
POST /queues/{queue}/messages
DELETE /queues/{queue}/messages
GET /queues/{queue}/messages/{message_id}
DELETE /queues/{queue}/messages/{message_id}

## Metadata handling - also implicitly modifies catalogue
GET /queues/{queue}/metadata
PUT /queues/{queue}/metadata

## Queue stats
GET /queues/{queue}/stats