Files
scylladb/api/api-doc/messaging_service.json
Amnon Heiman 04de4382f3 API Doc: Adding the messaging_service swagger definition
This adds the messaging_service API definition it will expose the
messaging_service metrics.

Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
2015-06-16 14:39:51 +03:00

217 lines
5.9 KiB
JSON

{
"apiVersion":"0.0.1",
"swaggerVersion":"1.2",
"basePath":"{{Protocol}}://{{Host}}",
"resourcePath":"/messaging_service",
"produces":[
"application/json"
],
"apis":[
{
"path":"/messaging_service/totaltimeouts",
"operations":[
{
"method":"GET",
"summary":"Total number of timeouts happened on this node",
"type":"long",
"nickname":"get_totaltimeouts",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/messaging_service/messages/dropped",
"operations":[
{
"method":"GET",
"summary":"Get the number of dropped messages per verb",
"type":"array",
"items":{
"type":"verb_counter"
},
"nickname":"get_dropped_messages",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/messaging_service/messages/replied",
"operations":[
{
"method":"GET",
"summary":"Get the number of replied messages",
"type":"array",
"items":{
"type":"message_counter"
},
"nickname":"get_completed_messages",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/messaging_service/messages/sent",
"operations":[
{
"method":"GET",
"summary":"Get the number of sent messages",
"type":"array",
"items":{
"type":"message_counter"
},
"nickname":"get_sent_messages",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/messaging_service/messages/pending",
"operations":[
{
"method":"GET",
"summary":"Get the number of pending messages",
"type":"array",
"items":{
"type":"message_counter"
},
"nickname":"get_pending_messages",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/messaging_service/messages/exception",
"operations":[
{
"method":"GET",
"summary":"Get the number of messages return with an exception",
"type":"array",
"items":{
"type":"message_counter"
},
"nickname":"get_exception_messages",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/messaging_service/messages/respond_pending",
"operations":[
{
"method":"GET",
"summary":"Get the number of messages waiting for respond",
"type":"array",
"items":{
"type":"message_counter"
},
"nickname":"get_respond_pending_messages",
"produces":[
"application/json"
],
"parameters":[
]
}
]
}
],
"models":{
"message_counter":{
"id":"message_counter",
"description":"Holds command counters",
"properties":{
"count":{
"type":"long"
},
"ip":{
"type":"string"
}
}
},
"verb_counter":{
"id":"verb_counters",
"description":"Holds verb counters",
"properties":{
"count":{
"type":"long"
},
"verb":{
"type":"string",
"enum":[
"MUTATION",
"BINARY",
"READ_REPAIR",
"READ",
"REQUEST_RESPONSE",
"STREAM_INITIATE",
"STREAM_INITIATE_DONE",
"STREAM_REPLY",
"STREAM_REQUEST",
"RANGE_SLICE",
"BOOTSTRAP_TOKEN",
"TREE_REQUEST",
"TREE_RESPONSE",
"JOIN",
"GOSSIP_DIGEST_SYN",
"GOSSIP_DIGEST_ACK",
"GOSSIP_DIGEST_ACK2",
"DEFINITIONS_ANNOUNCE",
"DEFINITIONS_UPDATE",
"TRUNCATE",
"SCHEMA_CHECK",
"INDEX_SCAN",
"REPLICATION_FINISHED",
"INTERNAL_RESPONSE",
"COUNTER_MUTATION",
"STREAMING_REPAIR_REQUEST",
"STREAMING_REPAIR_RESPONSE",
"SNAPSHOT",
"MIGRATION_REQUEST",
"GOSSIP_SHUTDOWN",
"_TRACE",
"ECHO",
"REPAIR_MESSAGE",
"PAXOS_PREPARE",
"PAXOS_PROPOSE",
"PAXOS_COMMIT",
"PAGED_RANGE",
"UNUSED_1",
"UNUSED_2",
"UNUSED_3"
]
}
}
}
}
}