Skip to content
This repository has been archived by the owner on Sep 20, 2022. It is now read-only.

Apiary JSON Protocol

Sam Betts edited this page Feb 10, 2014 · 1 revision

This is the structure of the outer protocol we use for all the message bus API communications.

Schema:

{
  "type" : "object", 
  "properties" : { 
    "action" : {"type" : "string"},
    "to" : {"type" : "string"},
    "from" : {"type" : "string"},
    "data" : {"type" : "object"},
    "machineid" : {"type" : "string"}
  },  
  "required" : [ "action", "to", "from", "data", "machineid" ]
}

Example:

{
  "action": "SEARCH"
  "to": "honeycomb"
  "from": "sting"
  "data": {}
  "machineid": "AJNFK1249402JNJ23049"
}