240c7b0572
This adds the commit log swagger definition to to the commit log definition file. The API is based on the CommitLogMetrics. The following commands were added: get_completed_tasks get_pending_tasks get_total_commit_log_size Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
120 lines
3.1 KiB
JSON
120 lines
3.1 KiB
JSON
{
|
|
"apiVersion":"0.0.1",
|
|
"swaggerVersion":"1.2",
|
|
"basePath":"{{Protocol}}://{{Host}}",
|
|
"resourcePath":"/commitlog",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"apis":[
|
|
{
|
|
"path":"/commitlog/recover/{path}",
|
|
"operations":[
|
|
{
|
|
"method":"POST",
|
|
"summary":"Recover a single file",
|
|
"type":"void",
|
|
"nickname":"commitlog_recover",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"path",
|
|
"description":"Full path of file or directory",
|
|
"required":true,
|
|
"allowMultiple":true,
|
|
"type":"string",
|
|
"paramType":"path"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/commitlog/segments/active",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"file names (not full paths) of active commit log segments (segments containing unflushed data)",
|
|
"type":"array",
|
|
"items":{
|
|
"type":"string"
|
|
},
|
|
"nickname":"get_active_segment_names",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/commitlog/segments/archiving",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"Returns files which are pending for archival attempt. Does NOT include failed archive attempts",
|
|
"type":"array",
|
|
"items":{
|
|
"type":"string"
|
|
},
|
|
"nickname":"get_archiving_segment_names",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/commitlog/metrics/completed_tasks",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get completed tasks",
|
|
"type": "long",
|
|
"nickname": "get_completed_tasks",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/commitlog/metrics/pending_tasks",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get pending tasks",
|
|
"type": "long",
|
|
"nickname": "get_pending_tasks",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/commitlog/metrics/total_commit_log_size",
|
|
"operations": [
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get total commit log size",
|
|
"type": "long",
|
|
"nickname": "get_total_commit_log_size",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": []
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|