summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/index.json
blob: 1627bdda7354164ae09c6fd5f7527f5d4a2fb59a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
{
  "index": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html",
    "methods": ["POST", "PUT"],
    "url": {
      "path": "/{index}/{type}",
      "paths": ["/{index}/{type}", "/{index}/{type}/{id}"],
      "parts": {
        "id": {
          "type" : "string",
          "description" : "Document ID"
        },
        "index": {
          "type" : "string",
          "required" : true,
          "description" : "The name of the index"
        },
        "type": {
          "type" : "string",
          "required" : true,
          "description" : "The type of the document"
        }
      },
      "params": {
        "consistency": {
          "type" : "enum",
          "options" : ["one", "quorum", "all"],
          "description" : "Explicit write consistency setting for the operation"
        },
        "op_type": {
          "type" : "enum",
          "options" : ["index", "create"],
          "default" : "index",
          "description" : "Explicit operation type"
        },
        "parent": {
          "type" : "string",
          "description" : "ID of the parent document"
        },
        "refresh": {
          "type" : "boolean",
          "description" : "Refresh the index after performing the operation"
        },
        "replication": {
          "type" : "enum",
          "options" : ["sync","async"],
          "default" : "sync",
          "description" : "Specific replication type"
        },
        "routing": {
          "type" : "string",
          "description" : "Specific routing value"
        },
        "timeout": {
          "type" : "time",
          "description" : "Explicit operation timeout"
        },
        "timestamp": {
          "type" : "time",
          "description" : "Explicit timestamp for the document"
        },
        "ttl": {
          "type" : "duration",
          "description" : "Expiration time for the document"
        },
        "version" : {
          "type" : "number",
          "description" : "Explicit version number for concurrency control"
        },
        "version_type": {
          "type" : "enum",
          "options" : ["internal","external"],
          "description" : "Specific version type"
        }
      }
    },
    "body": {
      "description" : "The document",
      "required" : true
    }
  }
}