blob: 86b3b7c85903e8620cc46565d208ce6c60958443 [file] [log] [blame]
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "An Ditto Protocol acknowledgement (ACK) aggregating message containing several single ACKs.",
"title": "Ditto Protocol acknowledgements",
"properties": {
"topic": {
"type": "string",
"description": "Contains the topic of the acknowledgements."
},
"headers": {
"type": "object",
"description": "Additional headers.",
"properties": {
"correlation-id": {
"type": "string",
"description": "The correlation-id header is used for linking the acknowledgements to the event which requested it."
},
"version": {
"type": "integer",
"description": "Determines the schema version of the payload.",
"minimum": 1,
"maximum": 2
}
},
"required": [ "correlation-id" ]
},
"path": {
"type": "string",
"description": "The path is always the empty path `/` for acknowledgements."
},
"value": {
"type": "object",
"description": "The _value_ field contains the payload of the acknowledgements which consists of all included single acknowledgements with their label as JSON key and as value their JSON represenataion as JSON object."
},
"status": {
"type": "integer",
"description": "The status code that indicates the aggregated/overall status of the combined acknowledgements.\nWhen all contained acknowledgements were successfull (2xx), this status is 200 (OK).\nWhen at least one was not successful, the status is 424 (failed dependency) meaning that the contained status codes have to be looked at separately."
}
},
"required": [ "topic", "headers", "path", "status" ]
}