Skip to content

Commit 00ed78f

Browse files
clintongormleyclintongormley
committed
[SPEC] Added cluster.repositories.* and cluster.snapshots.*
1 parent 500d6f7 commit 00ed78f

7 files changed

+198
-0
lines changed

‎rest-api-spec/api/cluster.repositories.delete.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"cluster.repositories.delete": {
3+
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html",
4+
"methods": ["DELETE"],
5+
"url": {
6+
"path": "/_snapshot/{repository}",
7+
"paths": ["/_snapshot/{repository}"],
8+
"parts": {
9+
"repository": {
10+
"type": "list",
11+
"description": "A comma-separated list of repository names"
12+
}
13+
},
14+
"params": {
15+
"master_timeout": {
16+
"type" : "time",
17+
"description" : "Explicit operation timeout for connection to master node"
18+
},
19+
"timeout": {
20+
"type" : "time",
21+
"description" : "Explicit operation timeout"
22+
}
23+
}
24+
},
25+
"body": null
26+
}
27+
}

‎rest-api-spec/api/cluster.repositories.get.json

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"cluster.repositories.get": {
3+
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html",
4+
"methods": ["GET"],
5+
"url": {
6+
"path": "/_snapshot",
7+
"paths": ["/_snapshot", "/_snapshot/{repository}"],
8+
"parts": {
9+
"repository": {
10+
"type": "list",
11+
"description": "A comma-separated list of repository names"
12+
}
13+
},
14+
"params": {
15+
"master_timeout": {
16+
"type" : "time",
17+
"description" : "Explicit operation timeout for connection to master node"
18+
}
19+
}
20+
},
21+
"body": null
22+
}
23+
}

‎rest-api-spec/api/cluster.repositories.put.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"cluster.repositories.put": {
3+
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html",
4+
"methods": ["PUT", "POST"],
5+
"url": {
6+
"path": "/_snapshot/{repository}",
7+
"paths": ["/_snapshot/{repository}"],
8+
"parts": {
9+
"repository": {
10+
"type": "string",
11+
"description": "A repository name"
12+
}
13+
},
14+
"params": {
15+
"master_timeout": {
16+
"type" : "time",
17+
"description" : "Explicit operation timeout for connection to master node"
18+
},
19+
"timeout": {
20+
"type" : "time",
21+
"description" : "Explicit operation timeout"
22+
}
23+
}
24+
},
25+
"description" : "The repository definition",
26+
"required" : true
27+
}
28+
}

‎rest-api-spec/api/cluster.snapshots.create.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"cluster.snapshots.create": {
3+
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html",
4+
"methods": ["PUT", "POST"],
5+
"url": {
6+
"path": "/_snapshot/{repository}/{snapshot}",
7+
"paths": ["/_snapshot/{repository}/{snapshot}", "/_snapshot/{repository}/{snapshot}/_create"],
8+
"parts": {
9+
"repository": {
10+
"type": "string",
11+
"description": "A repository name"
12+
},
13+
"snapshot": {
14+
"type": "string",
15+
"description": "A snapshot name"
16+
}
17+
},
18+
"params": {
19+
"master_timeout": {
20+
"type" : "time",
21+
"description" : "Explicit operation timeout for connection to master node"
22+
},
23+
"wait_for_completion": {
24+
"type": "boolean",
25+
"description": "Should this request wait until the operation has completed before returning",
26+
"default": false
27+
}
28+
}
29+
},
30+
"description" : "The snapshot definition",
31+
"required" : false
32+
}
33+
}

‎rest-api-spec/api/cluster.snapshots.delete.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"cluster.snapshots.delete": {
3+
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html",
4+
"methods": ["DELETE"],
5+
"url": {
6+
"path": "/_snapshot/{repository}/{snapshot}",
7+
"paths": ["/_snapshot/{repository}/{snapshot}"],
8+
"parts": {
9+
"repository": {
10+
"type": "string",
11+
"description": "A repository name"
12+
},
13+
"snapshot": {
14+
"type": "string",
15+
"description": "A snapshot name"
16+
}
17+
},
18+
"params": {
19+
"master_timeout": {
20+
"type" : "time",
21+
"description" : "Explicit operation timeout for connection to master node"
22+
}
23+
}
24+
},
25+
"body": null
26+
}
27+
}

‎rest-api-spec/api/cluster.snapshots.get.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"cluster.snapshots.get": {
3+
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html",
4+
"methods": ["GET"],
5+
"url": {
6+
"path": "/_snapshot/{repository}/{snapshot}",
7+
"paths": ["/_snapshot/{repository}/{snapshot}"],
8+
"parts": {
9+
"repository": {
10+
"type": "list",
11+
"description": "A comma-separated list of repository names"
12+
},
13+
"snapshot": {
14+
"type": "list",
15+
"description": "A comma-separated list of snapshot names"
16+
}
17+
},
18+
"params": {
19+
"master_timeout": {
20+
"type" : "time",
21+
"description" : "Explicit operation timeout for connection to master node"
22+
}
23+
}
24+
},
25+
"body": null
26+
}
27+
}

‎rest-api-spec/api/cluster.snapshots.restore.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"cluster.snapshots.restore": {
3+
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html",
4+
"methods": ["POST"],
5+
"url": {
6+
"path": "/_snapshot/{repository}/{snapshot}/_restore",
7+
"paths": ["/_snapshot/{repository}/{snapshot}/_restore"],
8+
"parts": {
9+
"repository": {
10+
"type": "string",
11+
"description": "A repository name"
12+
},
13+
"snapshot": {
14+
"type": "string",
15+
"description": "A snapshot name"
16+
}
17+
},
18+
"params": {
19+
"master_timeout": {
20+
"type" : "time",
21+
"description" : "Explicit operation timeout for connection to master node"
22+
},
23+
"wait_for_completion": {
24+
"type": "boolean",
25+
"description": "Should this request wait until the operation has completed before returning",
26+
"default": false
27+
}
28+
}
29+
},
30+
"description" : "Details of what to restore",
31+
"required" : false
32+
}
33+
}

0 commit comments

Comments
 (0)