OpenSearch/rest-api-spec/api/suggest.json

{
  "suggest": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-suggesters.html",
    "methods": ["POST", "GET"],
    "url": {
      "path": "/_suggest",
      "paths": ["/_suggest", "/{index}/_suggest"],
      "parts": {
        "index": {
          "type" : "list",
          "description" : "A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices"
        }
      },
      "params": {
        "ignore_unavailable": {
            "type" : "boolean",
            "description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
        },
        "allow_no_indices": {
            "type" : "boolean",
            "description" : "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
        },
        "expand_wildcards": {
            "type" : "enum",
            "options" : ["open","closed","none","all"],
            "default" : "open",
            "description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
        },
        "preference": {
          "type" : "string",
          "description" : "Specify the node or shard the operation should be performed on (default: random)"
        },
        "routing": {
          "type" : "string",
          "description" : "Specific routing value"
        },
        "source": {
          "type" : "string",
          "description" : "The URL-encoded request definition (instead of using request body)"
        }
      }
    },
    "body": {
      "description" : "The request definition",
      "required" : true
    }
  }
}