diff --git a/openapi_spec/json/opensearch.openapi.json b/openapi_spec/json/opensearch.openapi.json new file mode 100644 index 00000000..b6c7fdc0 --- /dev/null +++ b/openapi_spec/json/opensearch.openapi.json @@ -0,0 +1,633 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "OpenSearch", + "version": "2.5" + }, + "paths": { + "/": { + "$ref": "./paths/_.json" + }, + "/_alias": { + "$ref": "./paths/_alias.json" + }, + "/_alias/{name}": { + "$ref": "./paths/_alias.(name).json" + }, + "/_aliases": { + "$ref": "./paths/_aliases.json" + }, + "/_analyze": { + "$ref": "./paths/_analyze.json" + }, + "/_bulk": { + "$ref": "./paths/_bulk.json" + }, + "/_cache/clear": { + "$ref": "./paths/_cache.clear.json" + }, + "/_cat": { + "$ref": "./paths/_cat.json" + }, + "/_cat/aliases": { + "$ref": "./paths/_cat.aliases.json" + }, + "/_cat/aliases/{name}": { + "$ref": "./paths/_cat.aliases.(name).json" + }, + "/_cat/allocation": { + "$ref": "./paths/_cat.allocation.json" + }, + "/_cat/allocation/{node_id}": { + "$ref": "./paths/_cat.allocation.(node_id).json" + }, + "/_cat/cluster_manager": { + "$ref": "./paths/_cat.cluster_manager.json" + }, + "/_cat/count": { + "$ref": "./paths/_cat.count.json" + }, + "/_cat/count/{index}": { + "$ref": "./paths/_cat.count.(index).json" + }, + "/_cat/fielddata": { + "$ref": "./paths/_cat.fielddata.json" + }, + "/_cat/fielddata/{fields}": { + "$ref": "./paths/_cat.fielddata.(fields).json" + }, + "/_cat/health": { + "$ref": "./paths/_cat.health.json" + }, + "/_cat/indices": { + "$ref": "./paths/_cat.indices.json" + }, + "/_cat/indices/{index}": { + "$ref": "./paths/_cat.indices.(index).json" + }, + "/_cat/master": { + "$ref": "./paths/_cat.master.json" + }, + "/_cat/nodeattrs": { + "$ref": "./paths/_cat.nodeattrs.json" + }, + "/_cat/nodes": { + "$ref": "./paths/_cat.nodes.json" + }, + "/_cat/pending_tasks": { + "$ref": "./paths/_cat.pending_tasks.json" + }, + "/_cat/plugins": { + "$ref": "./paths/_cat.plugins.json" + }, + "/_cat/recovery": { + "$ref": "./paths/_cat.recovery.json" + }, + "/_cat/recovery/{index}": { + "$ref": "./paths/_cat.recovery.(index).json" + }, + "/_cat/repositories": { + "$ref": "./paths/_cat.repositories.json" + }, + "/_cat/segment_replication": { + "$ref": "./paths/_cat.segment_replication.json" + }, + "/_cat/segment_replication/{index}": { + "$ref": "./paths/_cat.segment_replication.(index).json" + }, + "/_cat/segments": { + "$ref": "./paths/_cat.segments.json" + }, + "/_cat/segments/{index}": { + "$ref": "./paths/_cat.segments.(index).json" + }, + "/_cat/shards": { + "$ref": "./paths/_cat.shards.json" + }, + "/_cat/shards/{index}": { + "$ref": "./paths/_cat.shards.(index).json" + }, + "/_cat/snapshots": { + "$ref": "./paths/_cat.snapshots.json" + }, + "/_cat/snapshots/{repository}": { + "$ref": "./paths/_cat.snapshots.(repository).json" + }, + "/_cat/tasks": { + "$ref": "./paths/_cat.tasks.json" + }, + "/_cat/templates": { + "$ref": "./paths/_cat.templates.json" + }, + "/_cat/templates/{name}": { + "$ref": "./paths/_cat.templates.(name).json" + }, + "/_cat/thread_pool": { + "$ref": "./paths/_cat.thread_pool.json" + }, + "/_cat/thread_pool/{thread_pool_patterns}": { + "$ref": "./paths/_cat.thread_pool.(thread_pool_patterns).json" + }, + "/_cluster/allocation/explain": { + "$ref": "./paths/_cluster.allocation.explain.json" + }, + "/_cluster/decommission/awareness/": { + "$ref": "./paths/_cluster.decommission.awareness..json" + }, + "/_cluster/decommission/awareness/{awareness_attribute_name}/_status": { + "$ref": "./paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.json" + }, + "/_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}": { + "$ref": "./paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).json" + }, + "/_cluster/health": { + "$ref": "./paths/_cluster.health.json" + }, + "/_cluster/health/{index}": { + "$ref": "./paths/_cluster.health.(index).json" + }, + "/_cluster/nodes/hot_threads": { + "$ref": "./paths/_cluster.nodes.hot_threads.json" + }, + "/_cluster/nodes/hotthreads": { + "$ref": "./paths/_cluster.nodes.hotthreads.json" + }, + "/_cluster/nodes/{node_id}/hot_threads": { + "$ref": "./paths/_cluster.nodes.(node_id).hot_threads.json" + }, + "/_cluster/nodes/{node_id}/hotthreads": { + "$ref": "./paths/_cluster.nodes.(node_id).hotthreads.json" + }, + "/_cluster/pending_tasks": { + "$ref": "./paths/_cluster.pending_tasks.json" + }, + "/_cluster/reroute": { + "$ref": "./paths/_cluster.reroute.json" + }, + "/_cluster/routing/awareness/weights": { + "$ref": "./paths/_cluster.routing.awareness.weights.json" + }, + "/_cluster/routing/awareness/{attribute}/weights": { + "$ref": "./paths/_cluster.routing.awareness.(attribute).weights.json" + }, + "/_cluster/settings": { + "$ref": "./paths/_cluster.settings.json" + }, + "/_cluster/state": { + "$ref": "./paths/_cluster.state.json" + }, + "/_cluster/state/{metric}": { + "$ref": "./paths/_cluster.state.(metric).json" + }, + "/_cluster/state/{metric}/{index}": { + "$ref": "./paths/_cluster.state.(metric).(index).json" + }, + "/_cluster/stats": { + "$ref": "./paths/_cluster.stats.json" + }, + "/_cluster/stats/nodes/{node_id}": { + "$ref": "./paths/_cluster.stats.nodes.(node_id).json" + }, + "/_cluster/voting_config_exclusions": { + "$ref": "./paths/_cluster.voting_config_exclusions.json" + }, + "/_component_template": { + "$ref": "./paths/_component_template.json" + }, + "/_component_template/{name}": { + "$ref": "./paths/_component_template.(name).json" + }, + "/_count": { + "$ref": "./paths/_count.json" + }, + "/_dangling": { + "$ref": "./paths/_dangling.json" + }, + "/_dangling/{index_uuid}": { + "$ref": "./paths/_dangling.(index_uuid).json" + }, + "/_data_stream": { + "$ref": "./paths/_data_stream.json" + }, + "/_data_stream/_stats": { + "$ref": "./paths/_data_stream._stats.json" + }, + "/_data_stream/{name}": { + "$ref": "./paths/_data_stream.(name).json" + }, + "/_data_stream/{name}/_stats": { + "$ref": "./paths/_data_stream.(name)._stats.json" + }, + "/_delete_by_query/{task_id}/_rethrottle": { + "$ref": "./paths/_delete_by_query.(task_id)._rethrottle.json" + }, + "/_field_caps": { + "$ref": "./paths/_field_caps.json" + }, + "/_flush": { + "$ref": "./paths/_flush.json" + }, + "/_forcemerge": { + "$ref": "./paths/_forcemerge.json" + }, + "/_index_template": { + "$ref": "./paths/_index_template.json" + }, + "/_index_template/_simulate": { + "$ref": "./paths/_index_template._simulate.json" + }, + "/_index_template/_simulate/{name}": { + "$ref": "./paths/_index_template._simulate.(name).json" + }, + "/_index_template/_simulate_index/{name}": { + "$ref": "./paths/_index_template._simulate_index.(name).json" + }, + "/_index_template/{name}": { + "$ref": "./paths/_index_template.(name).json" + }, + "/_ingest/pipeline": { + "$ref": "./paths/_ingest.pipeline.json" + }, + "/_ingest/pipeline/_simulate": { + "$ref": "./paths/_ingest.pipeline._simulate.json" + }, + "/_ingest/pipeline/{id}": { + "$ref": "./paths/_ingest.pipeline.(id).json" + }, + "/_ingest/pipeline/{id}/_simulate": { + "$ref": "./paths/_ingest.pipeline.(id)._simulate.json" + }, + "/_ingest/processor/grok": { + "$ref": "./paths/_ingest.processor.grok.json" + }, + "/_mapping": { + "$ref": "./paths/_mapping.json" + }, + "/_mapping/field/{fields}": { + "$ref": "./paths/_mapping.field.(fields).json" + }, + "/_mget": { + "$ref": "./paths/_mget.json" + }, + "/_msearch": { + "$ref": "./paths/_msearch.json" + }, + "/_msearch/template": { + "$ref": "./paths/_msearch.template.json" + }, + "/_mtermvectors": { + "$ref": "./paths/_mtermvectors.json" + }, + "/_nodes": { + "$ref": "./paths/_nodes.json" + }, + "/_nodes/hot_threads": { + "$ref": "./paths/_nodes.hot_threads.json" + }, + "/_nodes/hotthreads": { + "$ref": "./paths/_nodes.hotthreads.json" + }, + "/_nodes/reload_secure_settings": { + "$ref": "./paths/_nodes.reload_secure_settings.json" + }, + "/_nodes/stats": { + "$ref": "./paths/_nodes.stats.json" + }, + "/_nodes/stats/{metric}": { + "$ref": "./paths/_nodes.stats.(metric).json" + }, + "/_nodes/stats/{metric}/{index_metric}": { + "$ref": "./paths/_nodes.stats.(metric).(index_metric).json" + }, + "/_nodes/usage": { + "$ref": "./paths/_nodes.usage.json" + }, + "/_nodes/usage/{metric}": { + "$ref": "./paths/_nodes.usage.(metric).json" + }, + "/_nodes/{metric}": { + "$ref": "./paths/_nodes.(metric).json" + }, + "/_nodes/{node_id}": { + "$ref": "./paths/_nodes.(node_id).json" + }, + "/_nodes/{node_id}/hot_threads": { + "$ref": "./paths/_nodes.(node_id).hot_threads.json" + }, + "/_nodes/{node_id}/hotthreads": { + "$ref": "./paths/_nodes.(node_id).hotthreads.json" + }, + "/_nodes/{node_id}/reload_secure_settings": { + "$ref": "./paths/_nodes.(node_id).reload_secure_settings.json" + }, + "/_nodes/{node_id}/stats": { + "$ref": "./paths/_nodes.(node_id).stats.json" + }, + "/_nodes/{node_id}/stats/{metric}": { + "$ref": "./paths/_nodes.(node_id).stats.(metric).json" + }, + "/_nodes/{node_id}/stats/{metric}/{index_metric}": { + "$ref": "./paths/_nodes.(node_id).stats.(metric).(index_metric).json" + }, + "/_nodes/{node_id}/usage": { + "$ref": "./paths/_nodes.(node_id).usage.json" + }, + "/_nodes/{node_id}/usage/{metric}": { + "$ref": "./paths/_nodes.(node_id).usage.(metric).json" + }, + "/_nodes/{node_id}/{metric}": { + "$ref": "./paths/_nodes.(node_id).(metric).json" + }, + "/_rank_eval": { + "$ref": "./paths/_rank_eval.json" + }, + "/_recovery": { + "$ref": "./paths/_recovery.json" + }, + "/_refresh": { + "$ref": "./paths/_refresh.json" + }, + "/_reindex": { + "$ref": "./paths/_reindex.json" + }, + "/_reindex/{task_id}/_rethrottle": { + "$ref": "./paths/_reindex.(task_id)._rethrottle.json" + }, + "/_remote/info": { + "$ref": "./paths/_remote.info.json" + }, + "/_remotestore/_restore": { + "$ref": "./paths/_remotestore._restore.json" + }, + "/_render/template": { + "$ref": "./paths/_render.template.json" + }, + "/_render/template/{id}": { + "$ref": "./paths/_render.template.(id).json" + }, + "/_resolve/index/{name}": { + "$ref": "./paths/_resolve.index.(name).json" + }, + "/_script_context": { + "$ref": "./paths/_script_context.json" + }, + "/_script_language": { + "$ref": "./paths/_script_language.json" + }, + "/_scripts/painless/_execute": { + "$ref": "./paths/_scripts.painless._execute.json" + }, + "/_scripts/{id}": { + "$ref": "./paths/_scripts.(id).json" + }, + "/_scripts/{id}/{context}": { + "$ref": "./paths/_scripts.(id).(context).json" + }, + "/_search": { + "$ref": "./paths/_search.json" + }, + "/_search/point_in_time": { + "$ref": "./paths/_search.point_in_time.json" + }, + "/_search/point_in_time/_all": { + "$ref": "./paths/_search.point_in_time._all.json" + }, + "/_search/scroll": { + "$ref": "./paths/_search.scroll.json" + }, + "/_search/scroll/{scroll_id}": { + "$ref": "./paths/_search.scroll.(scroll_id).json" + }, + "/_search/template": { + "$ref": "./paths/_search.template.json" + }, + "/_search_shards": { + "$ref": "./paths/_search_shards.json" + }, + "/_segments": { + "$ref": "./paths/_segments.json" + }, + "/_settings": { + "$ref": "./paths/_settings.json" + }, + "/_settings/{name}": { + "$ref": "./paths/_settings.(name).json" + }, + "/_shard_stores": { + "$ref": "./paths/_shard_stores.json" + }, + "/_snapshot": { + "$ref": "./paths/_snapshot.json" + }, + "/_snapshot/_status": { + "$ref": "./paths/_snapshot._status.json" + }, + "/_snapshot/{repository}": { + "$ref": "./paths/_snapshot.(repository).json" + }, + "/_snapshot/{repository}/_cleanup": { + "$ref": "./paths/_snapshot.(repository)._cleanup.json" + }, + "/_snapshot/{repository}/_status": { + "$ref": "./paths/_snapshot.(repository)._status.json" + }, + "/_snapshot/{repository}/_verify": { + "$ref": "./paths/_snapshot.(repository)._verify.json" + }, + "/_snapshot/{repository}/{snapshot}": { + "$ref": "./paths/_snapshot.(repository).(snapshot).json" + }, + "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}": { + "$ref": "./paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).json" + }, + "/_snapshot/{repository}/{snapshot}/_restore": { + "$ref": "./paths/_snapshot.(repository).(snapshot)._restore.json" + }, + "/_snapshot/{repository}/{snapshot}/_status": { + "$ref": "./paths/_snapshot.(repository).(snapshot)._status.json" + }, + "/_stats": { + "$ref": "./paths/_stats.json" + }, + "/_stats/{metric}": { + "$ref": "./paths/_stats.(metric).json" + }, + "/_tasks": { + "$ref": "./paths/_tasks.json" + }, + "/_tasks/_cancel": { + "$ref": "./paths/_tasks._cancel.json" + }, + "/_tasks/{task_id}": { + "$ref": "./paths/_tasks.(task_id).json" + }, + "/_tasks/{task_id}/_cancel": { + "$ref": "./paths/_tasks.(task_id)._cancel.json" + }, + "/_template": { + "$ref": "./paths/_template.json" + }, + "/_template/{name}": { + "$ref": "./paths/_template.(name).json" + }, + "/_update_by_query/{task_id}/_rethrottle": { + "$ref": "./paths/_update_by_query.(task_id)._rethrottle.json" + }, + "/_upgrade": { + "$ref": "./paths/_upgrade.json" + }, + "/_validate/query": { + "$ref": "./paths/_validate.query.json" + }, + "/{alias}/_rollover": { + "$ref": "./paths/(alias)._rollover.json" + }, + "/{alias}/_rollover/{new_index}": { + "$ref": "./paths/(alias)._rollover.(new_index).json" + }, + "/{index}": { + "$ref": "./paths/(index).json" + }, + "/{index}/_alias": { + "$ref": "./paths/(index)._alias.json" + }, + "/{index}/_alias/{name}": { + "$ref": "./paths/(index)._alias.(name).json" + }, + "/{index}/_aliases/{name}": { + "$ref": "./paths/(index)._aliases.(name).json" + }, + "/{index}/_analyze": { + "$ref": "./paths/(index)._analyze.json" + }, + "/{index}/_block/{block}": { + "$ref": "./paths/(index)._block.(block).json" + }, + "/{index}/_bulk": { + "$ref": "./paths/(index)._bulk.json" + }, + "/{index}/_cache/clear": { + "$ref": "./paths/(index)._cache.clear.json" + }, + "/{index}/_clone/{target}": { + "$ref": "./paths/(index)._clone.(target).json" + }, + "/{index}/_close": { + "$ref": "./paths/(index)._close.json" + }, + "/{index}/_count": { + "$ref": "./paths/(index)._count.json" + }, + "/{index}/_create/{id}": { + "$ref": "./paths/(index)._create.(id).json" + }, + "/{index}/_delete_by_query": { + "$ref": "./paths/(index)._delete_by_query.json" + }, + "/{index}/_doc": { + "$ref": "./paths/(index)._doc.json" + }, + "/{index}/_doc/{id}": { + "$ref": "./paths/(index)._doc.(id).json" + }, + "/{index}/_explain/{id}": { + "$ref": "./paths/(index)._explain.(id).json" + }, + "/{index}/_field_caps": { + "$ref": "./paths/(index)._field_caps.json" + }, + "/{index}/_flush": { + "$ref": "./paths/(index)._flush.json" + }, + "/{index}/_forcemerge": { + "$ref": "./paths/(index)._forcemerge.json" + }, + "/{index}/_mapping": { + "$ref": "./paths/(index)._mapping.json" + }, + "/{index}/_mapping/field/{fields}": { + "$ref": "./paths/(index)._mapping.field.(fields).json" + }, + "/{index}/_mget": { + "$ref": "./paths/(index)._mget.json" + }, + "/{index}/_msearch": { + "$ref": "./paths/(index)._msearch.json" + }, + "/{index}/_msearch/template": { + "$ref": "./paths/(index)._msearch.template.json" + }, + "/{index}/_mtermvectors": { + "$ref": "./paths/(index)._mtermvectors.json" + }, + "/{index}/_open": { + "$ref": "./paths/(index)._open.json" + }, + "/{index}/_rank_eval": { + "$ref": "./paths/(index)._rank_eval.json" + }, + "/{index}/_recovery": { + "$ref": "./paths/(index)._recovery.json" + }, + "/{index}/_refresh": { + "$ref": "./paths/(index)._refresh.json" + }, + "/{index}/_search": { + "$ref": "./paths/(index)._search.json" + }, + "/{index}/_search/point_in_time": { + "$ref": "./paths/(index)._search.point_in_time.json" + }, + "/{index}/_search/template": { + "$ref": "./paths/(index)._search.template.json" + }, + "/{index}/_search_shards": { + "$ref": "./paths/(index)._search_shards.json" + }, + "/{index}/_segments": { + "$ref": "./paths/(index)._segments.json" + }, + "/{index}/_settings": { + "$ref": "./paths/(index)._settings.json" + }, + "/{index}/_settings/{name}": { + "$ref": "./paths/(index)._settings.(name).json" + }, + "/{index}/_shard_stores": { + "$ref": "./paths/(index)._shard_stores.json" + }, + "/{index}/_shrink/{target}": { + "$ref": "./paths/(index)._shrink.(target).json" + }, + "/{index}/_source/{id}": { + "$ref": "./paths/(index)._source.(id).json" + }, + "/{index}/_split/{target}": { + "$ref": "./paths/(index)._split.(target).json" + }, + "/{index}/_stats": { + "$ref": "./paths/(index)._stats.json" + }, + "/{index}/_stats/{metric}": { + "$ref": "./paths/(index)._stats.(metric).json" + }, + "/{index}/_termvectors": { + "$ref": "./paths/(index)._termvectors.json" + }, + "/{index}/_termvectors/{id}": { + "$ref": "./paths/(index)._termvectors.(id).json" + }, + "/{index}/_update/{id}": { + "$ref": "./paths/(index)._update.(id).json" + }, + "/{index}/_update_by_query": { + "$ref": "./paths/(index)._update_by_query.json" + }, + "/{index}/_upgrade": { + "$ref": "./paths/(index)._upgrade.json" + }, + "/{index}/_validate/query": { + "$ref": "./paths/(index)._validate.query.json" + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/parameters/query.json b/openapi_spec/json/parameters/query.json new file mode 100644 index 00000000..a5311c7f --- /dev/null +++ b/openapi_spec/json/parameters/query.json @@ -0,0 +1,1307 @@ +{ + "_source": { + "in": "query", + "name": "_source", + "description": "True or false to return the _source field or not, or a list of fields to return", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "_source_excludes": { + "in": "query", + "name": "_source_excludes", + "description": "A list of fields to exclude from the returned _source field", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "_source_includes": { + "in": "query", + "name": "_source_includes", + "description": "A list of fields to extract and return from the _source field", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "accept_data_loss": { + "in": "query", + "name": "accept_data_loss", + "description": "Must be set to true in order to delete the dangling index", + "schema": { + "type": "boolean" + } + }, + "actions": { + "in": "query", + "name": "actions", + "description": "A comma-separated list of actions that should be returned. Leave empty to return all.", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "active_only": { + "in": "query", + "name": "active_only", + "description": "If `true`, the response only includes ongoing shard recoveries", + "schema": { + "type": "boolean" + } + }, + "all_shards": { + "in": "query", + "name": "all_shards", + "description": "Execute validation on all shards instead of one random shard per index", + "schema": { + "type": "boolean" + } + }, + "allow_no_indices": { + "in": "query", + "name": "allow_no_indices", + "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)", + "schema": { + "type": "boolean" + } + }, + "allow_partial_pit_creation": { + "in": "query", + "name": "allow_partial_pit_creation", + "description": "Allow if point in time can be created with partial failures", + "schema": { + "type": "boolean" + } + }, + "allow_partial_search_results": { + "in": "query", + "name": "allow_partial_search_results", + "description": "Indicate if an error should be returned if there is a partial search failure or timeout", + "schema": { + "type": "boolean" + } + }, + "analyze_wildcard": { + "in": "query", + "name": "analyze_wildcard", + "description": "Specify whether wildcard and prefix queries should be analyzed (default: false)", + "schema": { + "type": "boolean" + } + }, + "analyzer": { + "in": "query", + "name": "analyzer", + "description": "The analyzer to use for the query string", + "schema": { + "type": "string" + } + }, + "awareness_attribute": { + "in": "query", + "name": "awareness_attribute", + "description": "The awareness attribute for which the health is required", + "schema": { + "type": "string" + } + }, + "batched_reduce_size": { + "in": "query", + "name": "batched_reduce_size", + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "schema": { + "type": "integer" + } + }, + "bytes": { + "in": "query", + "name": "bytes", + "description": "The unit in which to display byte values", + "schema": { + "type": "string", + "enum": [ + "b", + "k", + "kb", + "m", + "mb", + "g", + "gb", + "t", + "tb", + "p", + "pb" + ] + } + }, + "cause": { + "in": "query", + "name": "cause", + "description": "User defined reason for dry-run creating the new template for simulation purposes", + "schema": { + "type": "string" + } + }, + "ccs_minimize_roundtrips": { + "in": "query", + "name": "ccs_minimize_roundtrips", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", + "schema": { + "type": "boolean" + } + }, + "cluster_manager_timeout": { + "in": "query", + "name": "cluster_manager_timeout", + "description": "Specify timeout for connection to cluster-manager node", + "schema": { + "$ref": "../schemas/_common.json#/time" + } + }, + "completed_only": { + "in": "query", + "name": "completed_only", + "description": "If `true`, the response only includes latest completed segment replication events", + "schema": { + "type": "boolean" + } + }, + "completion_fields": { + "in": "query", + "name": "completion_fields", + "description": "A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "conflicts": { + "in": "query", + "name": "conflicts", + "description": "What to do when the update by query hits version conflicts?", + "schema": { + "type": "string", + "enum": [ + "abort", + "proceed" + ] + } + }, + "context": { + "in": "query", + "name": "context", + "description": "Context name to compile script against", + "schema": { + "type": "string" + } + }, + "copy_settings": { + "in": "query", + "name": "copy_settings", + "description": "whether or not to copy settings from the source index (defaults to false)", + "schema": { + "type": "boolean" + } + }, + "create": { + "in": "query", + "name": "create", + "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one", + "schema": { + "type": "boolean" + } + }, + "default_operator": { + "in": "query", + "name": "default_operator", + "description": "The default operator for query string query (AND or OR)", + "schema": { + "type": "string", + "enum": [ + "AND", + "OR" + ] + } + }, + "detailed": { + "in": "query", + "name": "detailed", + "description": "Return detailed task information (default: false)", + "schema": { + "type": "boolean" + } + }, + "df": { + "in": "query", + "name": "df", + "description": "The field to use as default where no field prefix is given in the query string", + "schema": { + "type": "string" + } + }, + "docvalue_fields": { + "in": "query", + "name": "docvalue_fields", + "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "dry_run": { + "in": "query", + "name": "dry_run", + "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false", + "schema": { + "type": "boolean" + } + }, + "ensure_node_commissioned": { + "in": "query", + "name": "ensure_node_commissioned", + "description": "Checks whether local node is commissioned or not. If set to true on a local call it will throw exception if node is decommissioned (default: false)", + "schema": { + "type": "boolean" + } + }, + "expand_wildcards": { + "in": "query", + "name": "expand_wildcards", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "hidden", + "none", + "all" + ] + } + }, + "explain": { + "in": "query", + "name": "explain", + "description": "Specify whether to return detailed information about score computation as part of a hit", + "schema": { + "type": "boolean" + } + }, + "field_statistics": { + "in": "query", + "name": "field_statistics", + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "schema": { + "type": "boolean" + } + }, + "fielddata": { + "in": "query", + "name": "fielddata", + "description": "Clear field data", + "schema": { + "type": "boolean" + } + }, + "fielddata_fields": { + "in": "query", + "name": "fielddata_fields", + "description": "A comma-separated list of fields for `fielddata` index metric (supports wildcards)", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "fields": { + "in": "query", + "name": "fields", + "description": "A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "flat_settings": { + "in": "query", + "name": "flat_settings", + "description": "Return settings in flat format (default: false)", + "schema": { + "type": "boolean" + } + }, + "flush": { + "in": "query", + "name": "flush", + "description": "Specify whether the index should be flushed after performing the operation (default: true)", + "schema": { + "type": "boolean" + } + }, + "forbid_closed_indices": { + "in": "query", + "name": "forbid_closed_indices", + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices", + "schema": { + "type": "boolean" + } + }, + "force": { + "in": "query", + "name": "force", + "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)", + "schema": { + "type": "boolean" + } + }, + "format": { + "in": "query", + "name": "format", + "description": "a short version of the Accept header, e.g. json, yaml", + "schema": { + "type": "string" + } + }, + "from": { + "in": "query", + "name": "from", + "description": "Starting offset (default: 0)", + "schema": { + "type": "integer" + } + }, + "full_id": { + "in": "query", + "name": "full_id", + "description": "Return the full node ID instead of the shortened version (default: false)", + "schema": { + "type": "boolean" + } + }, + "group_by": { + "in": "query", + "name": "group_by", + "description": "Group tasks by nodes or parent/child relationships", + "schema": { + "type": "string", + "enum": [ + "nodes", + "parents", + "none" + ] + } + }, + "groups": { + "in": "query", + "name": "groups", + "description": "A comma-separated list of search groups for `search` index metric", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "h": { + "in": "query", + "name": "h", + "description": "Comma-separated list of column names to display", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "health": { + "in": "query", + "name": "health", + "description": "A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status", + "schema": { + "type": "string", + "enum": [ + "green", + "yellow", + "red" + ] + } + }, + "help": { + "in": "query", + "name": "help", + "description": "Return help information", + "schema": { + "type": "boolean" + } + }, + "ids": { + "in": "query", + "name": "ids", + "description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "if_primary_term": { + "in": "query", + "name": "if_primary_term", + "description": "only perform the index operation if the last operation that has changed the document has the specified primary term", + "schema": { + "type": "integer" + } + }, + "if_seq_no": { + "in": "query", + "name": "if_seq_no", + "description": "only perform the index operation if the last operation that has changed the document has the specified sequence number", + "schema": { + "type": "integer" + } + }, + "ignore_idle_threads": { + "in": "query", + "name": "ignore_idle_threads", + "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)", + "schema": { + "type": "boolean" + } + }, + "ignore_throttled": { + "in": "query", + "name": "ignore_throttled", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", + "schema": { + "type": "boolean" + } + }, + "ignore_unavailable": { + "in": "query", + "name": "ignore_unavailable", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", + "schema": { + "type": "boolean" + } + }, + "include_defaults": { + "in": "query", + "name": "include_defaults", + "description": "Whether to return all default clusters setting.", + "schema": { + "type": "boolean" + } + }, + "include_disk_info": { + "in": "query", + "name": "include_disk_info", + "description": "Return information about disk usage and shard sizes (default: false)", + "schema": { + "type": "boolean" + } + }, + "include_segment_file_sizes": { + "in": "query", + "name": "include_segment_file_sizes", + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)", + "schema": { + "type": "boolean" + } + }, + "include_unloaded_segments": { + "in": "query", + "name": "include_unloaded_segments", + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory", + "schema": { + "type": "boolean" + } + }, + "include_unmapped": { + "in": "query", + "name": "include_unmapped", + "description": "Indicates whether unmapped fields should be included in the response.", + "schema": { + "type": "boolean" + } + }, + "include_yes_decisions": { + "in": "query", + "name": "include_yes_decisions", + "description": "Return 'YES' decisions in explanation (default: false)", + "schema": { + "type": "boolean" + } + }, + "index": { + "in": "query", + "name": "index", + "description": "A comma-separated list of index name to limit the operation", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "interval": { + "in": "query", + "name": "interval", + "description": "The interval for the second sampling of threads", + "schema": { + "$ref": "../schemas/_common.json#/time" + } + }, + "keep_alive": { + "in": "query", + "name": "keep_alive", + "description": "Specify the keep alive for point in time", + "schema": { + "type": "string" + } + }, + "lang": { + "in": "query", + "name": "lang", + "description": "The script language (default: painless)", + "schema": { + "type": "string" + } + }, + "lenient": { + "in": "query", + "name": "lenient", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", + "schema": { + "type": "boolean" + } + }, + "level": { + "in": "query", + "name": "level", + "description": "Return stats aggregated at cluster, index or shard level", + "schema": { + "type": "string", + "enum": [ + "cluster", + "indices", + "shards" + ] + } + }, + "local": { + "in": "query", + "name": "local", + "description": "Return local information, do not retrieve the state from master node (default: false)", + "schema": { + "type": "boolean" + } + }, + "master_timeout": { + "in": "query", + "name": "master_timeout", + "description": "Specify timeout for connection to master", + "deprecated": true, + "x-deprecation-version": "2.0.0", + "x-deprecation-description": "To support inclusive language, use 'cluster_manager_timeout' instead.", + "schema": { + "$ref": "../schemas/_common.json#/time" + } + }, + "max_concurrent_searches": { + "in": "query", + "name": "max_concurrent_searches", + "description": "Controls the maximum number of concurrent searches the multi search api will execute", + "schema": { + "type": "integer" + } + }, + "max_concurrent_shard_requests": { + "in": "query", + "name": "max_concurrent_shard_requests", + "description": "The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", + "schema": { + "type": "integer" + } + }, + "max_docs": { + "in": "query", + "name": "max_docs", + "description": "Maximum number of documents to process (default: all documents)", + "schema": { + "type": "integer" + } + }, + "max_num_segments": { + "in": "query", + "name": "max_num_segments", + "description": "The number of segments the index should be merged into (default: dynamic)", + "schema": { + "type": "integer" + } + }, + "metric": { + "in": "query", + "name": "metric", + "description": "Limit the information returned to the specified metrics. Defaults to all but metadata", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "min_score": { + "in": "query", + "name": "min_score", + "description": "Include only documents with a specific `_score` value in the result", + "schema": { + "type": "integer" + } + }, + "node_ids": { + "in": "query", + "name": "node_ids", + "description": "A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names.", + "schema": { + "type": "string" + } + }, + "node_names": { + "in": "query", + "name": "node_names", + "description": "A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids.", + "schema": { + "type": "string" + } + }, + "nodes": { + "in": "query", + "name": "nodes", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "offsets": { + "in": "query", + "name": "offsets", + "description": "Specifies if term offsets should be returned.", + "schema": { + "type": "boolean" + } + }, + "only_ancient_segments": { + "in": "query", + "name": "only_ancient_segments", + "description": "If true, only ancient (an older Lucene major release) segments will be upgraded", + "schema": { + "type": "boolean" + } + }, + "only_expunge_deletes": { + "in": "query", + "name": "only_expunge_deletes", + "description": "Specify whether the operation should only expunge deleted documents", + "schema": { + "type": "boolean" + } + }, + "op_type": { + "in": "query", + "name": "op_type", + "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID", + "schema": { + "type": "string", + "enum": [ + "index", + "create" + ] + } + }, + "order": { + "in": "query", + "name": "order", + "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)", + "schema": { + "type": "integer" + } + }, + "parent_task_id": { + "in": "query", + "name": "parent_task_id", + "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.", + "schema": { + "type": "string" + } + }, + "payloads": { + "in": "query", + "name": "payloads", + "description": "Specifies if term payloads should be returned.", + "schema": { + "type": "boolean" + } + }, + "pipeline": { + "in": "query", + "name": "pipeline", + "description": "The pipeline id to preprocess incoming documents with", + "schema": { + "type": "string" + } + }, + "positions": { + "in": "query", + "name": "positions", + "description": "Specifies if term positions should be returned.", + "schema": { + "type": "boolean" + } + }, + "pre_filter_shard_size": { + "in": "query", + "name": "pre_filter_shard_size", + "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "schema": { + "type": "integer" + } + }, + "preference": { + "in": "query", + "name": "preference", + "description": "Specify the node or shard the operation should be performed on (default: random)", + "schema": { + "type": "string" + } + }, + "preserve_existing": { + "in": "query", + "name": "preserve_existing", + "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`", + "schema": { + "type": "boolean" + } + }, + "pri": { + "in": "query", + "name": "pri", + "description": "Set to true to return stats only for primary shards", + "schema": { + "type": "boolean" + } + }, + "profile": { + "in": "query", + "name": "profile", + "description": "Specify whether to profile the query execution", + "schema": { + "type": "boolean" + } + }, + "q": { + "in": "query", + "name": "q", + "description": "Query in the Lucene query string syntax", + "schema": { + "type": "string" + } + }, + "query": { + "in": "query", + "name": "query", + "description": "Clear query caches", + "schema": { + "type": "boolean" + } + }, + "realtime": { + "in": "query", + "name": "realtime", + "description": "Specify whether to perform the operation in realtime or search mode", + "schema": { + "type": "boolean" + } + }, + "refresh": { + "in": "query", + "name": "refresh", + "description": "Should the affected indexes be refreshed?", + "schema": { + "type": "boolean" + } + }, + "request": { + "in": "query", + "name": "request", + "description": "Clear request cache", + "schema": { + "type": "boolean" + } + }, + "request_cache": { + "in": "query", + "name": "request_cache", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting", + "schema": { + "type": "boolean" + } + }, + "requests_per_second": { + "in": "query", + "name": "requests_per_second", + "description": "The throttle to set on this request in sub-requests per second. -1 means no throttle.", + "schema": { + "type": "integer" + } + }, + "require_alias": { + "in": "query", + "name": "require_alias", + "description": "When true, requires destination to be an alias. Default is false", + "schema": { + "type": "boolean" + } + }, + "rest_total_hits_as_int": { + "in": "query", + "name": "rest_total_hits_as_int", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", + "schema": { + "type": "boolean" + } + }, + "retry_failed": { + "in": "query", + "name": "retry_failed", + "description": "Retries allocation of shards that are blocked due to too many subsequent allocation failures", + "schema": { + "type": "boolean" + } + }, + "retry_on_conflict": { + "in": "query", + "name": "retry_on_conflict", + "description": "Specify how many times should the operation be retried when a conflict occurs (default: 0)", + "schema": { + "type": "integer" + } + }, + "rewrite": { + "in": "query", + "name": "rewrite", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", + "schema": { + "type": "boolean" + } + }, + "routing": { + "in": "query", + "name": "routing", + "description": "Specific routing value", + "schema": { + "type": "string" + } + }, + "s": { + "in": "query", + "name": "s", + "description": "Comma-separated list of column names or column aliases to sort by", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "scroll": { + "in": "query", + "name": "scroll", + "description": "Control how long to keep the search context alive", + "schema": { + "$ref": "../schemas/_common.json#/time" + } + }, + "scroll_id": { + "in": "query", + "name": "scroll_id", + "description": "The scroll ID for scrolled search", + "schema": { + "type": "string" + } + }, + "scroll_size": { + "in": "query", + "name": "scroll_size", + "description": "Size on the scroll request powering the update by query", + "schema": { + "type": "integer" + } + }, + "search_timeout": { + "in": "query", + "name": "search_timeout", + "description": "Explicit timeout for each search request. Defaults to no timeout.", + "schema": { + "$ref": "../schemas/_common.json#/time" + } + }, + "search_type": { + "in": "query", + "name": "search_type", + "description": "Search operation type", + "schema": { + "type": "string", + "enum": [ + "query_then_fetch", + "query_and_fetch", + "dfs_query_then_fetch", + "dfs_query_and_fetch" + ] + } + }, + "seq_no_primary_term": { + "in": "query", + "name": "seq_no_primary_term", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit", + "schema": { + "type": "boolean" + } + }, + "shards": { + "in": "query", + "name": "shards", + "description": "Comma-separated list of shards to display", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "size": { + "in": "query", + "name": "size", + "description": "Deprecated, please use `max_docs` instead", + "schema": { + "type": "integer" + } + }, + "slices": { + "in": "query", + "name": "slices", + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", + "schema": { + "type": [ + "integer", + "string" + ] + } + }, + "snapshots": { + "in": "query", + "name": "snapshots", + "description": "Number of samples of thread stacktrace (default: 10)", + "schema": { + "type": "integer" + } + }, + "sort": { + "in": "query", + "name": "sort", + "description": "A comma-separated list of : pairs", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "stats": { + "in": "query", + "name": "stats", + "description": "Specific 'tag' of the request for logging and statistical purposes", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "status": { + "in": "query", + "name": "status", + "description": "A comma-separated list of statuses used to filter on shards to get store information for", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "stored_fields": { + "in": "query", + "name": "stored_fields", + "description": "A comma-separated list of stored fields to return in the response", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "suggest_field": { + "in": "query", + "name": "suggest_field", + "description": "Specify which field to use for suggestions", + "schema": { + "type": "string" + } + }, + "suggest_mode": { + "in": "query", + "name": "suggest_mode", + "description": "Specify suggest mode", + "schema": { + "type": "string", + "enum": [ + "missing", + "popular", + "always" + ] + } + }, + "suggest_size": { + "in": "query", + "name": "suggest_size", + "description": "How many suggestions to return in response", + "schema": { + "type": "integer" + } + }, + "suggest_text": { + "in": "query", + "name": "suggest_text", + "description": "The source text for which the suggestions should be returned", + "schema": { + "type": "string" + } + }, + "term_statistics": { + "in": "query", + "name": "term_statistics", + "description": "Specifies if total term frequency and document frequency should be returned.", + "schema": { + "type": "boolean" + } + }, + "terminate_after": { + "in": "query", + "name": "terminate_after", + "description": "The maximum count for each shard, upon reaching which the query execution will terminate early", + "schema": { + "type": "integer" + } + }, + "threads": { + "in": "query", + "name": "threads", + "description": "Specify the number of threads to provide information for (default: 3)", + "schema": { + "type": "integer" + } + }, + "time": { + "in": "query", + "name": "time", + "description": "The unit in which to display time values", + "schema": { + "type": "string", + "enum": [ + "d", + "h", + "m", + "s", + "ms", + "micros", + "nanos" + ] + } + }, + "timeout": { + "in": "query", + "name": "timeout", + "description": "Explicit operation timeout", + "schema": { + "$ref": "../schemas/_common.json#/time" + } + }, + "track_scores": { + "in": "query", + "name": "track_scores", + "description": "Whether to calculate and return scores even if they are not used for sorting", + "schema": { + "type": "boolean" + } + }, + "track_total_hits": { + "in": "query", + "name": "track_total_hits", + "description": "Indicate if the number of documents that match the query should be tracked", + "schema": { + "type": "boolean" + } + }, + "ts": { + "in": "query", + "name": "ts", + "description": "Set to false to disable timestamping", + "schema": { + "type": "boolean" + } + }, + "type": { + "in": "query", + "name": "type", + "description": "The type to sample (default: cpu)", + "schema": { + "type": "string", + "enum": [ + "cpu", + "wait", + "block" + ] + } + }, + "typed_keys": { + "in": "query", + "name": "typed_keys", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", + "schema": { + "type": "boolean" + } + }, + "types": { + "in": "query", + "name": "types", + "description": "A comma-separated list of document types for the `indexing` index metric", + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + "v": { + "in": "query", + "name": "v", + "description": "Verbose mode. Display column headers", + "schema": { + "type": "boolean" + } + }, + "verbose": { + "in": "query", + "name": "verbose", + "description": "Includes detailed memory usage by Lucene.", + "schema": { + "type": "boolean" + } + }, + "verify": { + "in": "query", + "name": "verify", + "description": "Whether to verify the repository after creation", + "schema": { + "type": "boolean" + } + }, + "version": { + "in": "query", + "name": "version", + "description": "Explicit version number for concurrency control", + "schema": { + "type": "integer" + } + }, + "version_type": { + "in": "query", + "name": "version_type", + "description": "Specific version type", + "schema": { + "type": "string", + "enum": [ + "internal", + "external", + "external_gte", + "force" + ] + } + }, + "wait_for_active_shards": { + "in": "query", + "name": "wait_for_active_shards", + "description": "Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)", + "schema": { + "type": "string" + } + }, + "wait_for_completion": { + "in": "query", + "name": "wait_for_completion", + "description": "Wait for the matching tasks to complete (default: false)", + "schema": { + "type": "boolean" + } + }, + "wait_for_events": { + "in": "query", + "name": "wait_for_events", + "description": "Wait until all currently queued events with the given priority are processed", + "schema": { + "type": "string", + "enum": [ + "immediate", + "urgent", + "high", + "normal", + "low", + "languid" + ] + } + }, + "wait_for_metadata_version": { + "in": "query", + "name": "wait_for_metadata_version", + "description": "Wait for the metadata version to be equal or greater than the specified metadata version", + "schema": { + "type": "integer" + } + }, + "wait_for_no_initializing_shards": { + "in": "query", + "name": "wait_for_no_initializing_shards", + "description": "Whether to wait until there are no initializing shards in the cluster", + "schema": { + "type": "boolean" + } + }, + "wait_for_no_relocating_shards": { + "in": "query", + "name": "wait_for_no_relocating_shards", + "description": "Whether to wait until there are no relocating shards in the cluster", + "schema": { + "type": "boolean" + } + }, + "wait_for_nodes": { + "in": "query", + "name": "wait_for_nodes", + "description": "Wait until the specified number of nodes is available", + "schema": { + "type": "string" + } + }, + "wait_for_removal": { + "in": "query", + "name": "wait_for_removal", + "description": "Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list.", + "schema": { + "type": "boolean" + } + }, + "wait_for_status": { + "in": "query", + "name": "wait_for_status", + "description": "Wait until cluster is in a specific state", + "schema": { + "type": "string", + "enum": [ + "green", + "yellow", + "red" + ] + } + }, + "wait_for_timeout": { + "in": "query", + "name": "wait_for_timeout", + "description": "The maximum time to wait for wait_for_metadata_version before timing out", + "schema": { + "$ref": "../schemas/_common.json#/time" + } + }, + "wait_if_ongoing": { + "in": "query", + "name": "wait_if_ongoing", + "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.", + "schema": { + "type": "boolean" + } + }, + "write_index_only": { + "in": "query", + "name": "write_index_only", + "description": "When true, applies mappings only to the write index of an alias or data stream", + "schema": { + "type": "boolean" + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(alias)._rollover.(new_index).json b/openapi_spec/json/paths/(alias)._rollover.(new_index).json new file mode 100644 index 00000000..e8096e9f --- /dev/null +++ b/openapi_spec/json/paths/(alias)._rollover.(new_index).json @@ -0,0 +1,52 @@ +{ + "post": { + "x-endpoint-group": "indices.rollover", + "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "parameters": [ + { + "in": "path", + "name": "alias", + "description": "The name of the alias to rollover", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "new_index", + "description": "The name of the rollover index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/dry_run" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ], + "requestBody": { + "description": "The conditions that needs to be met for executing rollover", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(alias)._rollover.json b/openapi_spec/json/paths/(alias)._rollover.json new file mode 100644 index 00000000..2bc4e205 --- /dev/null +++ b/openapi_spec/json/paths/(alias)._rollover.json @@ -0,0 +1,43 @@ +{ + "post": { + "x-endpoint-group": "indices.rollover", + "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "parameters": [ + { + "in": "path", + "name": "alias", + "description": "The name of the alias to rollover", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/dry_run" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ], + "requestBody": { + "description": "The conditions that needs to be met for executing rollover", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._alias.(name).json b/openapi_spec/json/paths/(index)._alias.(name).json new file mode 100644 index 00000000..b88d71ac --- /dev/null +++ b/openapi_spec/json/paths/(index)._alias.(name).json @@ -0,0 +1,195 @@ +{ + "put": { + "x-endpoint-group": "indices.put_alias", + "description": "Creates or updates an alias.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "The name of the alias to be created or updated", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The settings for the alias, such as `routing` or `filter`", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "indices.put_alias", + "description": "Creates or updates an alias.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "The name of the alias to be created or updated", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The settings for the alias, such as `routing` or `filter`", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "head": { + "x-endpoint-group": "indices.exists_alias", + "description": "Returns information about whether a particular alias exists.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to filter aliases", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "A comma-separated list of alias names to return", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + }, + "get": { + "x-endpoint-group": "indices.get_alias", + "description": "Returns an alias.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to filter aliases", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "A comma-separated list of alias names to return", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + }, + "delete": { + "x-endpoint-group": "indices.delete_alias", + "description": "Deletes an alias.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names (supports wildcards); use `_all` for all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._alias.json b/openapi_spec/json/paths/(index)._alias.json new file mode 100644 index 00000000..b47d71ab --- /dev/null +++ b/openapi_spec/json/paths/(index)._alias.json @@ -0,0 +1,29 @@ +{ + "get": { + "x-endpoint-group": "indices.get_alias", + "description": "Returns an alias.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to filter aliases", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._aliases.(name).json b/openapi_spec/json/paths/(index)._aliases.(name).json new file mode 100644 index 00000000..e9065758 --- /dev/null +++ b/openapi_spec/json/paths/(index)._aliases.(name).json @@ -0,0 +1,123 @@ +{ + "put": { + "x-endpoint-group": "indices.put_alias", + "description": "Creates or updates an alias.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "The name of the alias to be created or updated", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The settings for the alias, such as `routing` or `filter`", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "indices.put_alias", + "description": "Creates or updates an alias.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "The name of the alias to be created or updated", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The settings for the alias, such as `routing` or `filter`", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "delete": { + "x-endpoint-group": "indices.delete_alias", + "description": "Deletes an alias.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names (supports wildcards); use `_all` for all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._analyze.json b/openapi_spec/json/paths/(index)._analyze.json new file mode 100644 index 00000000..cea9c308 --- /dev/null +++ b/openapi_spec/json/paths/(index)._analyze.json @@ -0,0 +1,49 @@ +{ + "get": { + "x-endpoint-group": "indices.analyze", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the index to scope the operation", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/index" + } + ] + }, + "post": { + "x-endpoint-group": "indices.analyze", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the index to scope the operation", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/index" + } + ], + "requestBody": { + "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._block.(block).json b/openapi_spec/json/paths/(index)._block.(block).json new file mode 100644 index 00000000..6a153a8e --- /dev/null +++ b/openapi_spec/json/paths/(index)._block.(block).json @@ -0,0 +1,44 @@ +{ + "put": { + "x-endpoint-group": "indices.add_block", + "description": "Adds a block to an index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma separated list of indices to add a block to", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "block", + "description": "The block to add (one of read, write, read_only or metadata)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._bulk.json b/openapi_spec/json/paths/(index)._bulk.json new file mode 100644 index 00000000..24387cd2 --- /dev/null +++ b/openapi_spec/json/paths/(index)._bulk.json @@ -0,0 +1,114 @@ +{ + "post": { + "x-endpoint-group": "bulk", + "description": "Allows to perform multiple index/update/delete operations in a single request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Default index for items which don't provide one", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/pipeline" + }, + { + "$ref": "../parameters/query.json#/require_alias" + } + ], + "requestBody": { + "description": "The operation definition and data (action-data pairs), separated by newlines", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "put": { + "x-endpoint-group": "bulk", + "description": "Allows to perform multiple index/update/delete operations in a single request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Default index for items which don't provide one", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/pipeline" + }, + { + "$ref": "../parameters/query.json#/require_alias" + } + ], + "requestBody": { + "description": "The operation definition and data (action-data pairs), separated by newlines", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._cache.clear.json b/openapi_spec/json/paths/(index)._cache.clear.json new file mode 100644 index 00000000..11732cd5 --- /dev/null +++ b/openapi_spec/json/paths/(index)._cache.clear.json @@ -0,0 +1,41 @@ +{ + "post": { + "x-endpoint-group": "indices.clear_cache", + "description": "Clears all or specific caches for one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index name to limit the operation", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/fielddata" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/query" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/index" + }, + { + "$ref": "../parameters/query.json#/request" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._clone.(target).json b/openapi_spec/json/paths/(index)._clone.(target).json new file mode 100644 index 00000000..61412796 --- /dev/null +++ b/openapi_spec/json/paths/(index)._clone.(target).json @@ -0,0 +1,96 @@ +{ + "put": { + "x-endpoint-group": "indices.clone", + "description": "Clones an index", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the source index to clone", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "target", + "description": "The name of the target index to clone into", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ], + "requestBody": { + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "indices.clone", + "description": "Clones an index", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the source index to clone", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "target", + "description": "The name of the target index to clone into", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ], + "requestBody": { + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._close.json b/openapi_spec/json/paths/(index)._close.json new file mode 100644 index 00000000..2d3dd84e --- /dev/null +++ b/openapi_spec/json/paths/(index)._close.json @@ -0,0 +1,38 @@ +{ + "post": { + "x-endpoint-group": "indices.close", + "description": "Closes an index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma separated list of indices to close", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._count.json b/openapi_spec/json/paths/(index)._count.json new file mode 100644 index 00000000..e9de7ebf --- /dev/null +++ b/openapi_spec/json/paths/(index)._count.json @@ -0,0 +1,127 @@ +{ + "post": { + "x-endpoint-group": "count", + "description": "Returns number of documents matching a query.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of indices to restrict the results", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/min_score" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + } + ], + "requestBody": { + "description": "A query to restrict the results specified with the Query DSL (optional)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "get": { + "x-endpoint-group": "count", + "description": "Returns number of documents matching a query.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of indices to restrict the results", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/min_score" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._create.(id).json b/openapi_spec/json/paths/(index)._create.(id).json new file mode 100644 index 00000000..c22c7b64 --- /dev/null +++ b/openapi_spec/json/paths/(index)._create.(id).json @@ -0,0 +1,114 @@ +{ + "put": { + "x-endpoint-group": "create", + "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + }, + { + "$ref": "../parameters/query.json#/pipeline" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "create", + "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + }, + { + "$ref": "../parameters/query.json#/pipeline" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._delete_by_query.json b/openapi_spec/json/paths/(index)._delete_by_query.json new file mode 100644 index 00000000..45ffd1ba --- /dev/null +++ b/openapi_spec/json/paths/(index)._delete_by_query.json @@ -0,0 +1,127 @@ +{ + "post": { + "x-endpoint-group": "delete_by_query", + "description": "Deletes documents matching the provided query.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/from" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/conflicts" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/search_timeout" + }, + { + "$ref": "../parameters/query.json#/size" + }, + { + "$ref": "../parameters/query.json#/max_docs" + }, + { + "$ref": "../parameters/query.json#/sort" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + }, + { + "$ref": "../parameters/query.json#/stats" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/request_cache" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/scroll_size" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + }, + { + "$ref": "../parameters/query.json#/requests_per_second" + }, + { + "$ref": "../parameters/query.json#/slices" + } + ], + "requestBody": { + "description": "The search definition using the Query DSL", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._doc.(id).json b/openapi_spec/json/paths/(index)._doc.(id).json new file mode 100644 index 00000000..70bc8ce7 --- /dev/null +++ b/openapi_spec/json/paths/(index)._doc.(id).json @@ -0,0 +1,294 @@ +{ + "get": { + "x-endpoint-group": "get", + "description": "Returns a document.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + }, + "delete": { + "x-endpoint-group": "delete", + "description": "Removes a document from the index.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/if_seq_no" + }, + { + "$ref": "../parameters/query.json#/if_primary_term" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + }, + "put": { + "x-endpoint-group": "index", + "description": "Creates or updates a document in an index.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/op_type" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + }, + { + "$ref": "../parameters/query.json#/if_seq_no" + }, + { + "$ref": "../parameters/query.json#/if_primary_term" + }, + { + "$ref": "../parameters/query.json#/pipeline" + }, + { + "$ref": "../parameters/query.json#/require_alias" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "index", + "description": "Creates or updates a document in an index.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/op_type" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + }, + { + "$ref": "../parameters/query.json#/if_seq_no" + }, + { + "$ref": "../parameters/query.json#/if_primary_term" + }, + { + "$ref": "../parameters/query.json#/pipeline" + }, + { + "$ref": "../parameters/query.json#/require_alias" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "head": { + "x-endpoint-group": "exists", + "description": "Returns information about whether a document exists in an index.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._doc.json b/openapi_spec/json/paths/(index)._doc.json new file mode 100644 index 00000000..d1b9187d --- /dev/null +++ b/openapi_spec/json/paths/(index)._doc.json @@ -0,0 +1,61 @@ +{ + "post": { + "x-endpoint-group": "index", + "description": "Creates or updates a document in an index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/op_type" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + }, + { + "$ref": "../parameters/query.json#/if_seq_no" + }, + { + "$ref": "../parameters/query.json#/if_primary_term" + }, + { + "$ref": "../parameters/query.json#/pipeline" + }, + { + "$ref": "../parameters/query.json#/require_alias" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._explain.(id).json b/openapi_spec/json/paths/(index)._explain.(id).json new file mode 100644 index 00000000..fa58b500 --- /dev/null +++ b/openapi_spec/json/paths/(index)._explain.(id).json @@ -0,0 +1,133 @@ +{ + "get": { + "x-endpoint-group": "explain", + "description": "Returns information about why a specific matches (or doesn't match) a query.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + } + ] + }, + "post": { + "x-endpoint-group": "explain", + "description": "Returns information about why a specific matches (or doesn't match) a query.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + } + ], + "requestBody": { + "description": "The query definition using the Query DSL", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._field_caps.json b/openapi_spec/json/paths/(index)._field_caps.json new file mode 100644 index 00000000..9c511e18 --- /dev/null +++ b/openapi_spec/json/paths/(index)._field_caps.json @@ -0,0 +1,73 @@ +{ + "get": { + "x-endpoint-group": "field_caps", + "description": "Returns the information about the capabilities of fields among multiple indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/include_unmapped" + } + ] + }, + "post": { + "x-endpoint-group": "field_caps", + "description": "Returns the information about the capabilities of fields among multiple indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/include_unmapped" + } + ], + "requestBody": { + "description": "An index filter specified with the Query DSL", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._flush.json b/openapi_spec/json/paths/(index)._flush.json new file mode 100644 index 00000000..3444a394 --- /dev/null +++ b/openapi_spec/json/paths/(index)._flush.json @@ -0,0 +1,62 @@ +{ + "post": { + "x-endpoint-group": "indices.flush", + "description": "Performs the flush operation on one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string for all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/force" + }, + { + "$ref": "../parameters/query.json#/wait_if_ongoing" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + }, + "get": { + "x-endpoint-group": "indices.flush", + "description": "Performs the flush operation on one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string for all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/force" + }, + { + "$ref": "../parameters/query.json#/wait_if_ongoing" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._forcemerge.json b/openapi_spec/json/paths/(index)._forcemerge.json new file mode 100644 index 00000000..15527802 --- /dev/null +++ b/openapi_spec/json/paths/(index)._forcemerge.json @@ -0,0 +1,35 @@ +{ + "post": { + "x-endpoint-group": "indices.forcemerge", + "description": "Performs the force merge operation on one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/flush" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/max_num_segments" + }, + { + "$ref": "../parameters/query.json#/only_expunge_deletes" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._mapping.field.(fields).json b/openapi_spec/json/paths/(index)._mapping.field.(fields).json new file mode 100644 index 00000000..c6758b56 --- /dev/null +++ b/openapi_spec/json/paths/(index)._mapping.field.(fields).json @@ -0,0 +1,41 @@ +{ + "get": { + "x-endpoint-group": "indices.get_field_mapping", + "description": "Returns mapping for one or more fields.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "fields", + "description": "A comma-separated list of fields", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/include_defaults" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._mapping.json b/openapi_spec/json/paths/(index)._mapping.json new file mode 100644 index 00000000..ad394af6 --- /dev/null +++ b/openapi_spec/json/paths/(index)._mapping.json @@ -0,0 +1,129 @@ +{ + "get": { + "x-endpoint-group": "indices.get_mapping", + "description": "Returns mappings for one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + }, + "put": { + "x-endpoint-group": "indices.put_mapping", + "description": "Updates the index mappings.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/write_index_only" + } + ], + "requestBody": { + "description": "The mapping definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "indices.put_mapping", + "description": "Updates the index mappings.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/write_index_only" + } + ], + "requestBody": { + "description": "The mapping definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._mget.json b/openapi_spec/json/paths/(index)._mget.json new file mode 100644 index 00000000..0b35cef5 --- /dev/null +++ b/openapi_spec/json/paths/(index)._mget.json @@ -0,0 +1,91 @@ +{ + "get": { + "x-endpoint-group": "mget", + "description": "Allows to get multiple documents in one request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + } + ] + }, + "post": { + "x-endpoint-group": "mget", + "description": "Allows to get multiple documents in one request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + } + ], + "requestBody": { + "description": "Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._msearch.json b/openapi_spec/json/paths/(index)._msearch.json new file mode 100644 index 00000000..b6450b46 --- /dev/null +++ b/openapi_spec/json/paths/(index)._msearch.json @@ -0,0 +1,85 @@ +{ + "get": { + "x-endpoint-group": "msearch", + "description": "Allows to execute several search operations in one request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to use as default", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_searches" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/pre_filter_shard_size" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_shard_requests" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ] + }, + "post": { + "x-endpoint-group": "msearch", + "description": "Allows to execute several search operations in one request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to use as default", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_searches" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/pre_filter_shard_size" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_shard_requests" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ], + "requestBody": { + "description": "The request definitions (metadata-search request definition pairs), separated by newlines", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._msearch.template.json b/openapi_spec/json/paths/(index)._msearch.template.json new file mode 100644 index 00000000..ab7daa3f --- /dev/null +++ b/openapi_spec/json/paths/(index)._msearch.template.json @@ -0,0 +1,73 @@ +{ + "get": { + "x-endpoint-group": "msearch_template", + "description": "Allows to execute several search template operations in one request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to use as default", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_searches" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ] + }, + "post": { + "x-endpoint-group": "msearch_template", + "description": "Allows to execute several search template operations in one request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to use as default", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_searches" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ], + "requestBody": { + "description": "The request definitions (metadata-search request definition pairs), separated by newlines", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._mtermvectors.json b/openapi_spec/json/paths/(index)._mtermvectors.json new file mode 100644 index 00000000..aae306ec --- /dev/null +++ b/openapi_spec/json/paths/(index)._mtermvectors.json @@ -0,0 +1,115 @@ +{ + "get": { + "x-endpoint-group": "mtermvectors", + "description": "Returns multiple termvectors in one request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The index in which the document resides.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/ids" + }, + { + "$ref": "../parameters/query.json#/term_statistics" + }, + { + "$ref": "../parameters/query.json#/field_statistics" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/offsets" + }, + { + "$ref": "../parameters/query.json#/positions" + }, + { + "$ref": "../parameters/query.json#/payloads" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + }, + "post": { + "x-endpoint-group": "mtermvectors", + "description": "Returns multiple termvectors in one request.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The index in which the document resides.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/ids" + }, + { + "$ref": "../parameters/query.json#/term_statistics" + }, + { + "$ref": "../parameters/query.json#/field_statistics" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/offsets" + }, + { + "$ref": "../parameters/query.json#/positions" + }, + { + "$ref": "../parameters/query.json#/payloads" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ], + "requestBody": { + "description": "Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._open.json b/openapi_spec/json/paths/(index)._open.json new file mode 100644 index 00000000..3739977f --- /dev/null +++ b/openapi_spec/json/paths/(index)._open.json @@ -0,0 +1,35 @@ +{ + "post": { + "x-endpoint-group": "indices.open", + "description": "Opens an index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma separated list of indices to open", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._rank_eval.json b/openapi_spec/json/paths/(index)._rank_eval.json new file mode 100644 index 00000000..84d61aff --- /dev/null +++ b/openapi_spec/json/paths/(index)._rank_eval.json @@ -0,0 +1,67 @@ +{ + "get": { + "x-endpoint-group": "rank_eval", + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/search_type" + } + ] + }, + "post": { + "x-endpoint-group": "rank_eval", + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/search_type" + } + ], + "requestBody": { + "description": "The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._recovery.json b/openapi_spec/json/paths/(index)._recovery.json new file mode 100644 index 00000000..ff4f645b --- /dev/null +++ b/openapi_spec/json/paths/(index)._recovery.json @@ -0,0 +1,23 @@ +{ + "get": { + "x-endpoint-group": "indices.recovery", + "description": "Returns information about ongoing index shard recoveries.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/detailed" + }, + { + "$ref": "../parameters/query.json#/active_only" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._refresh.json b/openapi_spec/json/paths/(index)._refresh.json new file mode 100644 index 00000000..97e2cc20 --- /dev/null +++ b/openapi_spec/json/paths/(index)._refresh.json @@ -0,0 +1,50 @@ +{ + "post": { + "x-endpoint-group": "indices.refresh", + "description": "Performs the refresh operation in one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + }, + "get": { + "x-endpoint-group": "indices.refresh", + "description": "Performs the refresh operation in one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._search.json b/openapi_spec/json/paths/(index)._search.json new file mode 100644 index 00000000..b9bf7d41 --- /dev/null +++ b/openapi_spec/json/paths/(index)._search.json @@ -0,0 +1,295 @@ +{ + "get": { + "x-endpoint-group": "search", + "description": "Returns results matching a query.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/docvalue_fields" + }, + { + "$ref": "../parameters/query.json#/from" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/size" + }, + { + "$ref": "../parameters/query.json#/sort" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + }, + { + "$ref": "../parameters/query.json#/stats" + }, + { + "$ref": "../parameters/query.json#/suggest_field" + }, + { + "$ref": "../parameters/query.json#/suggest_mode" + }, + { + "$ref": "../parameters/query.json#/suggest_size" + }, + { + "$ref": "../parameters/query.json#/suggest_text" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/track_scores" + }, + { + "$ref": "../parameters/query.json#/track_total_hits" + }, + { + "$ref": "../parameters/query.json#/allow_partial_search_results" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/seq_no_primary_term" + }, + { + "$ref": "../parameters/query.json#/request_cache" + }, + { + "$ref": "../parameters/query.json#/batched_reduce_size" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_shard_requests" + }, + { + "$ref": "../parameters/query.json#/pre_filter_shard_size" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + } + ] + }, + "post": { + "x-endpoint-group": "search", + "description": "Returns results matching a query.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/docvalue_fields" + }, + { + "$ref": "../parameters/query.json#/from" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/size" + }, + { + "$ref": "../parameters/query.json#/sort" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + }, + { + "$ref": "../parameters/query.json#/stats" + }, + { + "$ref": "../parameters/query.json#/suggest_field" + }, + { + "$ref": "../parameters/query.json#/suggest_mode" + }, + { + "$ref": "../parameters/query.json#/suggest_size" + }, + { + "$ref": "../parameters/query.json#/suggest_text" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/track_scores" + }, + { + "$ref": "../parameters/query.json#/track_total_hits" + }, + { + "$ref": "../parameters/query.json#/allow_partial_search_results" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/seq_no_primary_term" + }, + { + "$ref": "../parameters/query.json#/request_cache" + }, + { + "$ref": "../parameters/query.json#/batched_reduce_size" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_shard_requests" + }, + { + "$ref": "../parameters/query.json#/pre_filter_shard_size" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + } + ], + "requestBody": { + "description": "The search definition using the Query DSL", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._search.point_in_time.json b/openapi_spec/json/paths/(index)._search.point_in_time.json new file mode 100644 index 00000000..b8522b65 --- /dev/null +++ b/openapi_spec/json/paths/(index)._search.point_in_time.json @@ -0,0 +1,29 @@ +{ + "post": { + "x-endpoint-group": "create_pit", + "description": "Creates point in time context.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/allow_partial_pit_creation" + }, + { + "$ref": "../parameters/query.json#/keep_alive" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._search.template.json b/openapi_spec/json/paths/(index)._search.template.json new file mode 100644 index 00000000..270a0689 --- /dev/null +++ b/openapi_spec/json/paths/(index)._search.template.json @@ -0,0 +1,121 @@ +{ + "get": { + "x-endpoint-group": "search_template", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/profile" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ] + }, + "post": { + "x-endpoint-group": "search_template", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/profile" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ], + "requestBody": { + "description": "The search definition template and its params", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._search_shards.json b/openapi_spec/json/paths/(index)._search_shards.json new file mode 100644 index 00000000..6c279cac --- /dev/null +++ b/openapi_spec/json/paths/(index)._search_shards.json @@ -0,0 +1,68 @@ +{ + "get": { + "x-endpoint-group": "search_shards", + "description": "Returns information about the indices and shards that a search request would be executed against.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + }, + "post": { + "x-endpoint-group": "search_shards", + "description": "Returns information about the indices and shards that a search request would be executed against.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._segments.json b/openapi_spec/json/paths/(index)._segments.json new file mode 100644 index 00000000..68aa07eb --- /dev/null +++ b/openapi_spec/json/paths/(index)._segments.json @@ -0,0 +1,29 @@ +{ + "get": { + "x-endpoint-group": "indices.segments", + "description": "Provides low-level information about segments in a Lucene index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/verbose" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._settings.(name).json b/openapi_spec/json/paths/(index)._settings.(name).json new file mode 100644 index 00000000..9c379d23 --- /dev/null +++ b/openapi_spec/json/paths/(index)._settings.(name).json @@ -0,0 +1,50 @@ +{ + "get": { + "x-endpoint-group": "indices.get_settings", + "description": "Returns settings for one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "name", + "description": "The name of the settings that should be included", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/include_defaults" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._settings.json b/openapi_spec/json/paths/(index)._settings.json new file mode 100644 index 00000000..80ab090f --- /dev/null +++ b/openapi_spec/json/paths/(index)._settings.json @@ -0,0 +1,91 @@ +{ + "put": { + "x-endpoint-group": "indices.put_settings", + "description": "Updates the index settings.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/preserve_existing" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + } + ], + "requestBody": { + "description": "The index settings to be updated", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "get": { + "x-endpoint-group": "indices.get_settings", + "description": "Returns settings for one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/include_defaults" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._shard_stores.json b/openapi_spec/json/paths/(index)._shard_stores.json new file mode 100644 index 00000000..68b69085 --- /dev/null +++ b/openapi_spec/json/paths/(index)._shard_stores.json @@ -0,0 +1,29 @@ +{ + "get": { + "x-endpoint-group": "indices.shard_stores", + "description": "Provides store information for shard copies of indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/status" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._shrink.(target).json b/openapi_spec/json/paths/(index)._shrink.(target).json new file mode 100644 index 00000000..3a19bf34 --- /dev/null +++ b/openapi_spec/json/paths/(index)._shrink.(target).json @@ -0,0 +1,102 @@ +{ + "put": { + "x-endpoint-group": "indices.shrink", + "description": "Allow to shrink an existing index into a new index with fewer primary shards.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the source index to shrink", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "target", + "description": "The name of the target index to shrink into", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/copy_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ], + "requestBody": { + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "indices.shrink", + "description": "Allow to shrink an existing index into a new index with fewer primary shards.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the source index to shrink", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "target", + "description": "The name of the target index to shrink into", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/copy_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ], + "requestBody": { + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._source.(id).json b/openapi_spec/json/paths/(index)._source.(id).json new file mode 100644 index 00000000..416f76c8 --- /dev/null +++ b/openapi_spec/json/paths/(index)._source.(id).json @@ -0,0 +1,104 @@ +{ + "head": { + "x-endpoint-group": "exists_source", + "description": "Returns information about whether a document source exists in an index.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + }, + "get": { + "x-endpoint-group": "get_source", + "description": "Returns the source of a document.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._split.(target).json b/openapi_spec/json/paths/(index)._split.(target).json new file mode 100644 index 00000000..509cae9e --- /dev/null +++ b/openapi_spec/json/paths/(index)._split.(target).json @@ -0,0 +1,102 @@ +{ + "put": { + "x-endpoint-group": "indices.split", + "description": "Allows you to split an existing index into a new index with more primary shards.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the source index to split", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "target", + "description": "The name of the target index to split into", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/copy_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ], + "requestBody": { + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "indices.split", + "description": "Allows you to split an existing index into a new index with more primary shards.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the source index to split", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "target", + "description": "The name of the target index to split into", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/copy_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + } + ], + "requestBody": { + "description": "The configuration for the target index (`settings` and `aliases`)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._stats.(metric).json b/openapi_spec/json/paths/(index)._stats.(metric).json new file mode 100644 index 00000000..72d3716c --- /dev/null +++ b/openapi_spec/json/paths/(index)._stats.(metric).json @@ -0,0 +1,53 @@ +{ + "get": { + "x-endpoint-group": "indices.stats", + "description": "Provides statistics on operations happening in an index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "metric", + "description": "Limit the information returned the specific metrics.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + }, + { + "$ref": "../parameters/query.json#/include_unloaded_segments" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/forbid_closed_indices" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._stats.json b/openapi_spec/json/paths/(index)._stats.json new file mode 100644 index 00000000..781591cb --- /dev/null +++ b/openapi_spec/json/paths/(index)._stats.json @@ -0,0 +1,44 @@ +{ + "get": { + "x-endpoint-group": "indices.stats", + "description": "Provides statistics on operations happening in an index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + }, + { + "$ref": "../parameters/query.json#/include_unloaded_segments" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/forbid_closed_indices" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._termvectors.(id).json b/openapi_spec/json/paths/(index)._termvectors.(id).json new file mode 100644 index 00000000..3bdd3035 --- /dev/null +++ b/openapi_spec/json/paths/(index)._termvectors.(id).json @@ -0,0 +1,127 @@ +{ + "get": { + "x-endpoint-group": "termvectors", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The index in which the document resides.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "description": "The id of the document, when not specified a doc param should be supplied.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/term_statistics" + }, + { + "$ref": "../parameters/query.json#/field_statistics" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/offsets" + }, + { + "$ref": "../parameters/query.json#/positions" + }, + { + "$ref": "../parameters/query.json#/payloads" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + }, + "post": { + "x-endpoint-group": "termvectors", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The index in which the document resides.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "id", + "description": "The id of the document, when not specified a doc param should be supplied.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/term_statistics" + }, + { + "$ref": "../parameters/query.json#/field_statistics" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/offsets" + }, + { + "$ref": "../parameters/query.json#/positions" + }, + { + "$ref": "../parameters/query.json#/payloads" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ], + "requestBody": { + "description": "Define parameters and or supply a document to get termvectors for. See documentation.", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._termvectors.json b/openapi_spec/json/paths/(index)._termvectors.json new file mode 100644 index 00000000..9d1ba745 --- /dev/null +++ b/openapi_spec/json/paths/(index)._termvectors.json @@ -0,0 +1,109 @@ +{ + "get": { + "x-endpoint-group": "termvectors", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The index in which the document resides.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/term_statistics" + }, + { + "$ref": "../parameters/query.json#/field_statistics" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/offsets" + }, + { + "$ref": "../parameters/query.json#/positions" + }, + { + "$ref": "../parameters/query.json#/payloads" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + }, + "post": { + "x-endpoint-group": "termvectors", + "description": "Returns information and statistics about terms in the fields of a particular document.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The index in which the document resides.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/term_statistics" + }, + { + "$ref": "../parameters/query.json#/field_statistics" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/offsets" + }, + { + "$ref": "../parameters/query.json#/positions" + }, + { + "$ref": "../parameters/query.json#/payloads" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ], + "requestBody": { + "description": "Define parameters and or supply a document to get termvectors for. See documentation.", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._update.(id).json b/openapi_spec/json/paths/(index)._update.(id).json new file mode 100644 index 00000000..652d5d23 --- /dev/null +++ b/openapi_spec/json/paths/(index)._update.(id).json @@ -0,0 +1,73 @@ +{ + "post": { + "x-endpoint-group": "update", + "description": "Updates a document with a script or partial document.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Document ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/lang" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/retry_on_conflict" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/if_seq_no" + }, + { + "$ref": "../parameters/query.json#/if_primary_term" + }, + { + "$ref": "../parameters/query.json#/require_alias" + } + ], + "requestBody": { + "description": "The request definition requires either `script` or partial `doc`", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._update_by_query.json b/openapi_spec/json/paths/(index)._update_by_query.json new file mode 100644 index 00000000..fc2fc765 --- /dev/null +++ b/openapi_spec/json/paths/(index)._update_by_query.json @@ -0,0 +1,133 @@ +{ + "post": { + "x-endpoint-group": "update_by_query", + "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/from" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/conflicts" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/pipeline" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/search_timeout" + }, + { + "$ref": "../parameters/query.json#/size" + }, + { + "$ref": "../parameters/query.json#/max_docs" + }, + { + "$ref": "../parameters/query.json#/sort" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + }, + { + "$ref": "../parameters/query.json#/stats" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + }, + { + "$ref": "../parameters/query.json#/request_cache" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/scroll_size" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + }, + { + "$ref": "../parameters/query.json#/requests_per_second" + }, + { + "$ref": "../parameters/query.json#/slices" + } + ], + "requestBody": { + "description": "The search definition using the Query DSL", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._upgrade.json b/openapi_spec/json/paths/(index)._upgrade.json new file mode 100644 index 00000000..eee11a1e --- /dev/null +++ b/openapi_spec/json/paths/(index)._upgrade.json @@ -0,0 +1,56 @@ +{ + "post": { + "x-endpoint-group": "indices.upgrade", + "description": "The _upgrade API is no longer useful and will be removed.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + }, + { + "$ref": "../parameters/query.json#/only_ancient_segments" + } + ] + }, + "get": { + "x-endpoint-group": "indices.get_upgrade", + "description": "The _upgrade API is no longer useful and will be removed.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index)._validate.query.json b/openapi_spec/json/paths/(index)._validate.query.json new file mode 100644 index 00000000..6182ddff --- /dev/null +++ b/openapi_spec/json/paths/(index)._validate.query.json @@ -0,0 +1,115 @@ +{ + "get": { + "x-endpoint-group": "indices.validate_query", + "description": "Allows a user to validate a potentially expensive query without executing it.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/rewrite" + }, + { + "$ref": "../parameters/query.json#/all_shards" + } + ] + }, + "post": { + "x-endpoint-group": "indices.validate_query", + "description": "Allows a user to validate a potentially expensive query without executing it.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/rewrite" + }, + { + "$ref": "../parameters/query.json#/all_shards" + } + ], + "requestBody": { + "description": "The query definition specified with the Query DSL", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/(index).json b/openapi_spec/json/paths/(index).json new file mode 100644 index 00000000..676e247e --- /dev/null +++ b/openapi_spec/json/paths/(index).json @@ -0,0 +1,142 @@ +{ + "delete": { + "x-endpoint-group": "indices.delete", + "description": "Deletes an index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + }, + "get": { + "x-endpoint-group": "indices.get", + "description": "Returns information about one or more indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/include_defaults" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + }, + "head": { + "x-endpoint-group": "indices.exists", + "description": "Returns information about whether a particular index exists.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/include_defaults" + } + ] + }, + "put": { + "x-endpoint-group": "indices.create", + "description": "Creates an index with optional settings and mappings.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "The name of the index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The configuration for the index (`settings` and `mappings`)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_.json b/openapi_spec/json/paths/_.json new file mode 100644 index 00000000..4c1683c9 --- /dev/null +++ b/openapi_spec/json/paths/_.json @@ -0,0 +1,16 @@ +{ + "get": { + "x-endpoint-group": "info", + "description": "Returns basic information about the cluster.", + "parameters": [ + + ] + }, + "head": { + "x-endpoint-group": "ping", + "description": "Returns whether the cluster is running.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_alias.(name).json b/openapi_spec/json/paths/_alias.(name).json new file mode 100644 index 00000000..beb78509 --- /dev/null +++ b/openapi_spec/json/paths/_alias.(name).json @@ -0,0 +1,56 @@ +{ + "head": { + "x-endpoint-group": "indices.exists_alias", + "description": "Returns information about whether a particular alias exists.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of alias names to return", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + }, + "get": { + "x-endpoint-group": "indices.get_alias", + "description": "Returns an alias.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of alias names to return", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_alias.json b/openapi_spec/json/paths/_alias.json new file mode 100644 index 00000000..8746c334 --- /dev/null +++ b/openapi_spec/json/paths/_alias.json @@ -0,0 +1,20 @@ +{ + "get": { + "x-endpoint-group": "indices.get_alias", + "description": "Returns an alias.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_aliases.json b/openapi_spec/json/paths/_aliases.json new file mode 100644 index 00000000..74478392 --- /dev/null +++ b/openapi_spec/json/paths/_aliases.json @@ -0,0 +1,28 @@ +{ + "post": { + "x-endpoint-group": "indices.update_aliases", + "description": "Updates index aliases.", + "parameters": [ + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The definition of `actions` to perform", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_analyze.json b/openapi_spec/json/paths/_analyze.json new file mode 100644 index 00000000..e9b34782 --- /dev/null +++ b/openapi_spec/json/paths/_analyze.json @@ -0,0 +1,31 @@ +{ + "get": { + "x-endpoint-group": "indices.analyze", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "parameters": [ + { + "$ref": "../parameters/query.json#/index" + } + ] + }, + "post": { + "x-endpoint-group": "indices.analyze", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "parameters": [ + { + "$ref": "../parameters/query.json#/index" + } + ], + "requestBody": { + "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_bulk.json b/openapi_spec/json/paths/_bulk.json new file mode 100644 index 00000000..0e4bb8f7 --- /dev/null +++ b/openapi_spec/json/paths/_bulk.json @@ -0,0 +1,96 @@ +{ + "post": { + "x-endpoint-group": "bulk", + "description": "Allows to perform multiple index/update/delete operations in a single request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/pipeline" + }, + { + "$ref": "../parameters/query.json#/require_alias" + } + ], + "requestBody": { + "description": "The operation definition and data (action-data pairs), separated by newlines", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "put": { + "x-endpoint-group": "bulk", + "description": "Allows to perform multiple index/update/delete operations in a single request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/pipeline" + }, + { + "$ref": "../parameters/query.json#/require_alias" + } + ], + "requestBody": { + "description": "The operation definition and data (action-data pairs), separated by newlines", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cache.clear.json b/openapi_spec/json/paths/_cache.clear.json new file mode 100644 index 00000000..6e4e69a1 --- /dev/null +++ b/openapi_spec/json/paths/_cache.clear.json @@ -0,0 +1,32 @@ +{ + "post": { + "x-endpoint-group": "indices.clear_cache", + "description": "Clears all or specific caches for one or more indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/fielddata" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/query" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/index" + }, + { + "$ref": "../parameters/query.json#/request" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.aliases.(name).json b/openapi_spec/json/paths/_cat.aliases.(name).json new file mode 100644 index 00000000..32d21f67 --- /dev/null +++ b/openapi_spec/json/paths/_cat.aliases.(name).json @@ -0,0 +1,38 @@ +{ + "get": { + "x-endpoint-group": "cat.aliases", + "description": "Shows information about currently configured aliases to indices including filter and routing infos.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of alias names to return", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.aliases.json b/openapi_spec/json/paths/_cat.aliases.json new file mode 100644 index 00000000..e3606a3f --- /dev/null +++ b/openapi_spec/json/paths/_cat.aliases.json @@ -0,0 +1,29 @@ +{ + "get": { + "x-endpoint-group": "cat.aliases", + "description": "Shows information about currently configured aliases to indices including filter and routing infos.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.allocation.(node_id).json b/openapi_spec/json/paths/_cat.allocation.(node_id).json new file mode 100644 index 00000000..8552a0e5 --- /dev/null +++ b/openapi_spec/json/paths/_cat.allocation.(node_id).json @@ -0,0 +1,44 @@ +{ + "get": { + "x-endpoint-group": "cat.allocation", + "description": "Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.allocation.json b/openapi_spec/json/paths/_cat.allocation.json new file mode 100644 index 00000000..2386e6e9 --- /dev/null +++ b/openapi_spec/json/paths/_cat.allocation.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "cat.allocation", + "description": "Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.cluster_manager.json b/openapi_spec/json/paths/_cat.cluster_manager.json new file mode 100644 index 00000000..c157d430 --- /dev/null +++ b/openapi_spec/json/paths/_cat.cluster_manager.json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "cat.cluster_manager", + "description": "Returns information about the cluster-manager node.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.count.(index).json b/openapi_spec/json/paths/_cat.count.(index).json new file mode 100644 index 00000000..0624554c --- /dev/null +++ b/openapi_spec/json/paths/_cat.count.(index).json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "cat.count", + "description": "Provides quick access to the document count of the entire cluster, or individual indices.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to limit the returned information", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.count.json b/openapi_spec/json/paths/_cat.count.json new file mode 100644 index 00000000..2cd989c4 --- /dev/null +++ b/openapi_spec/json/paths/_cat.count.json @@ -0,0 +1,23 @@ +{ + "get": { + "x-endpoint-group": "cat.count", + "description": "Provides quick access to the document count of the entire cluster, or individual indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.fielddata.(fields).json b/openapi_spec/json/paths/_cat.fielddata.(fields).json new file mode 100644 index 00000000..bf7dbd19 --- /dev/null +++ b/openapi_spec/json/paths/_cat.fielddata.(fields).json @@ -0,0 +1,38 @@ +{ + "get": { + "x-endpoint-group": "cat.fielddata", + "description": "Shows how much heap memory is currently being used by fielddata on every data node in the cluster.", + "parameters": [ + { + "in": "path", + "name": "fields", + "description": "A comma-separated list of fields to return the fielddata size", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + }, + { + "$ref": "../parameters/query.json#/fields" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.fielddata.json b/openapi_spec/json/paths/_cat.fielddata.json new file mode 100644 index 00000000..6f9d2835 --- /dev/null +++ b/openapi_spec/json/paths/_cat.fielddata.json @@ -0,0 +1,29 @@ +{ + "get": { + "x-endpoint-group": "cat.fielddata", + "description": "Shows how much heap memory is currently being used by fielddata on every data node in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + }, + { + "$ref": "../parameters/query.json#/fields" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.health.json b/openapi_spec/json/paths/_cat.health.json new file mode 100644 index 00000000..9457a14e --- /dev/null +++ b/openapi_spec/json/paths/_cat.health.json @@ -0,0 +1,29 @@ +{ + "get": { + "x-endpoint-group": "cat.health", + "description": "Returns a concise representation of the cluster health.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/ts" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.indices.(index).json b/openapi_spec/json/paths/_cat.indices.(index).json new file mode 100644 index 00000000..51416fe9 --- /dev/null +++ b/openapi_spec/json/paths/_cat.indices.(index).json @@ -0,0 +1,59 @@ +{ + "get": { + "x-endpoint-group": "cat.indices", + "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, ...", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to limit the returned information", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/health" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/pri" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + }, + { + "$ref": "../parameters/query.json#/include_unloaded_segments" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.indices.json b/openapi_spec/json/paths/_cat.indices.json new file mode 100644 index 00000000..2f383b57 --- /dev/null +++ b/openapi_spec/json/paths/_cat.indices.json @@ -0,0 +1,50 @@ +{ + "get": { + "x-endpoint-group": "cat.indices", + "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, ...", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/health" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/pri" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + }, + { + "$ref": "../parameters/query.json#/include_unloaded_segments" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.json b/openapi_spec/json/paths/_cat.json new file mode 100644 index 00000000..78cd7588 --- /dev/null +++ b/openapi_spec/json/paths/_cat.json @@ -0,0 +1,14 @@ +{ + "get": { + "x-endpoint-group": "cat.help", + "description": "Returns help for the Cat APIs.", + "parameters": [ + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.master.json b/openapi_spec/json/paths/_cat.master.json new file mode 100644 index 00000000..c157d430 --- /dev/null +++ b/openapi_spec/json/paths/_cat.master.json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "cat.cluster_manager", + "description": "Returns information about the cluster-manager node.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.nodeattrs.json b/openapi_spec/json/paths/_cat.nodeattrs.json new file mode 100644 index 00000000..fb360cf5 --- /dev/null +++ b/openapi_spec/json/paths/_cat.nodeattrs.json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "cat.nodeattrs", + "description": "Returns information about custom node attributes.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.nodes.json b/openapi_spec/json/paths/_cat.nodes.json new file mode 100644 index 00000000..73d495fc --- /dev/null +++ b/openapi_spec/json/paths/_cat.nodes.json @@ -0,0 +1,41 @@ +{ + "get": { + "x-endpoint-group": "cat.nodes", + "description": "Returns basic statistics about performance of cluster nodes.", + "parameters": [ + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/full_id" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.pending_tasks.json b/openapi_spec/json/paths/_cat.pending_tasks.json new file mode 100644 index 00000000..ac9666be --- /dev/null +++ b/openapi_spec/json/paths/_cat.pending_tasks.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "cat.pending_tasks", + "description": "Returns a concise representation of the cluster pending tasks.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.plugins.json b/openapi_spec/json/paths/_cat.plugins.json new file mode 100644 index 00000000..f67836de --- /dev/null +++ b/openapi_spec/json/paths/_cat.plugins.json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "cat.plugins", + "description": "Returns information about installed plugins across nodes node.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.recovery.(index).json b/openapi_spec/json/paths/_cat.recovery.(index).json new file mode 100644 index 00000000..a673a722 --- /dev/null +++ b/openapi_spec/json/paths/_cat.recovery.(index).json @@ -0,0 +1,47 @@ +{ + "get": { + "x-endpoint-group": "cat.recovery", + "description": "Returns information about index shard recoveries, both on-going completed.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list or wildcard expression of index names to limit the returned information", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/active_only" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/detailed" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/index" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.recovery.json b/openapi_spec/json/paths/_cat.recovery.json new file mode 100644 index 00000000..60275b13 --- /dev/null +++ b/openapi_spec/json/paths/_cat.recovery.json @@ -0,0 +1,38 @@ +{ + "get": { + "x-endpoint-group": "cat.recovery", + "description": "Returns information about index shard recoveries, both on-going completed.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/active_only" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/detailed" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/index" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.repositories.json b/openapi_spec/json/paths/_cat.repositories.json new file mode 100644 index 00000000..0d2e144c --- /dev/null +++ b/openapi_spec/json/paths/_cat.repositories.json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "cat.repositories", + "description": "Returns information about snapshot repositories registered in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.segment_replication.(index).json b/openapi_spec/json/paths/_cat.segment_replication.(index).json new file mode 100644 index 00000000..18a932cb --- /dev/null +++ b/openapi_spec/json/paths/_cat.segment_replication.(index).json @@ -0,0 +1,53 @@ +{ + "get": { + "x-endpoint-group": "cat.segment_replication", + "description": "Returns information about both on-going and latest completed Segment Replication events", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Comma-separated list or wildcard expression of index names to limit the returned information", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/active_only" + }, + { + "$ref": "../parameters/query.json#/completed_only" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/detailed" + }, + { + "$ref": "../parameters/query.json#/shards" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/index" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.segment_replication.json b/openapi_spec/json/paths/_cat.segment_replication.json new file mode 100644 index 00000000..ca87cc4c --- /dev/null +++ b/openapi_spec/json/paths/_cat.segment_replication.json @@ -0,0 +1,44 @@ +{ + "get": { + "x-endpoint-group": "cat.segment_replication", + "description": "Returns information about both on-going and latest completed Segment Replication events", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/active_only" + }, + { + "$ref": "../parameters/query.json#/completed_only" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/detailed" + }, + { + "$ref": "../parameters/query.json#/shards" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/index" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.segments.(index).json b/openapi_spec/json/paths/_cat.segments.(index).json new file mode 100644 index 00000000..71e903af --- /dev/null +++ b/openapi_spec/json/paths/_cat.segments.(index).json @@ -0,0 +1,41 @@ +{ + "get": { + "x-endpoint-group": "cat.segments", + "description": "Provides low-level information about the segments in the shards of an index.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to limit the returned information", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.segments.json b/openapi_spec/json/paths/_cat.segments.json new file mode 100644 index 00000000..4923d885 --- /dev/null +++ b/openapi_spec/json/paths/_cat.segments.json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "cat.segments", + "description": "Provides low-level information about the segments in the shards of an index.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.shards.(index).json b/openapi_spec/json/paths/_cat.shards.(index).json new file mode 100644 index 00000000..2d9f8547 --- /dev/null +++ b/openapi_spec/json/paths/_cat.shards.(index).json @@ -0,0 +1,47 @@ +{ + "get": { + "x-endpoint-group": "cat.shards", + "description": "Provides a detailed view of shard allocation on nodes.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names to limit the returned information", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.shards.json b/openapi_spec/json/paths/_cat.shards.json new file mode 100644 index 00000000..9bd8a513 --- /dev/null +++ b/openapi_spec/json/paths/_cat.shards.json @@ -0,0 +1,38 @@ +{ + "get": { + "x-endpoint-group": "cat.shards", + "description": "Provides a detailed view of shard allocation on nodes.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/bytes" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.snapshots.(repository).json b/openapi_spec/json/paths/_cat.snapshots.(repository).json new file mode 100644 index 00000000..3e6a16ef --- /dev/null +++ b/openapi_spec/json/paths/_cat.snapshots.(repository).json @@ -0,0 +1,44 @@ +{ + "get": { + "x-endpoint-group": "cat.snapshots", + "description": "Returns all snapshots in a specific repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "Name of repository from which to fetch the snapshot information", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.snapshots.json b/openapi_spec/json/paths/_cat.snapshots.json new file mode 100644 index 00000000..a6a254bc --- /dev/null +++ b/openapi_spec/json/paths/_cat.snapshots.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "cat.snapshots", + "description": "Returns all snapshots in a specific repository.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.tasks.json b/openapi_spec/json/paths/_cat.tasks.json new file mode 100644 index 00000000..07cad888 --- /dev/null +++ b/openapi_spec/json/paths/_cat.tasks.json @@ -0,0 +1,38 @@ +{ + "get": { + "x-endpoint-group": "cat.tasks", + "description": "Returns information about the tasks currently executing on one or more nodes in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/nodes" + }, + { + "$ref": "../parameters/query.json#/actions" + }, + { + "$ref": "../parameters/query.json#/detailed" + }, + { + "$ref": "../parameters/query.json#/parent_task_id" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/time" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.templates.(name).json b/openapi_spec/json/paths/_cat.templates.(name).json new file mode 100644 index 00000000..3931312f --- /dev/null +++ b/openapi_spec/json/paths/_cat.templates.(name).json @@ -0,0 +1,41 @@ +{ + "get": { + "x-endpoint-group": "cat.templates", + "description": "Returns information about existing templates.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A pattern that returned template names must match", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.templates.json b/openapi_spec/json/paths/_cat.templates.json new file mode 100644 index 00000000..4ce6ba8e --- /dev/null +++ b/openapi_spec/json/paths/_cat.templates.json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "cat.templates", + "description": "Returns information about existing templates.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.thread_pool.(thread_pool_patterns).json b/openapi_spec/json/paths/_cat.thread_pool.(thread_pool_patterns).json new file mode 100644 index 00000000..5e2aee48 --- /dev/null +++ b/openapi_spec/json/paths/_cat.thread_pool.(thread_pool_patterns).json @@ -0,0 +1,44 @@ +{ + "get": { + "x-endpoint-group": "cat.thread_pool", + "description": "Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools.", + "parameters": [ + { + "in": "path", + "name": "thread_pool_patterns", + "description": "A comma-separated list of regular-expressions to filter the thread pools in the output", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/size" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cat.thread_pool.json b/openapi_spec/json/paths/_cat.thread_pool.json new file mode 100644 index 00000000..5a16e354 --- /dev/null +++ b/openapi_spec/json/paths/_cat.thread_pool.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "cat.thread_pool", + "description": "Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools.", + "parameters": [ + { + "$ref": "../parameters/query.json#/format" + }, + { + "$ref": "../parameters/query.json#/size" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/h" + }, + { + "$ref": "../parameters/query.json#/help" + }, + { + "$ref": "../parameters/query.json#/s" + }, + { + "$ref": "../parameters/query.json#/v" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.allocation.explain.json b/openapi_spec/json/paths/_cluster.allocation.explain.json new file mode 100644 index 00000000..8796c63a --- /dev/null +++ b/openapi_spec/json/paths/_cluster.allocation.explain.json @@ -0,0 +1,37 @@ +{ + "get": { + "x-endpoint-group": "cluster.allocation_explain", + "description": "Provides explanations for shard allocations in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/include_yes_decisions" + }, + { + "$ref": "../parameters/query.json#/include_disk_info" + } + ] + }, + "post": { + "x-endpoint-group": "cluster.allocation_explain", + "description": "Provides explanations for shard allocations in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/include_yes_decisions" + }, + { + "$ref": "../parameters/query.json#/include_disk_info" + } + ], + "requestBody": { + "description": "The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).json b/openapi_spec/json/paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).json new file mode 100644 index 00000000..07834c91 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).json @@ -0,0 +1,26 @@ +{ + "put": { + "x-endpoint-group": "cluster.put_decommission_awareness", + "description": "Decommissions an awareness attribute", + "parameters": [ + { + "in": "path", + "name": "awareness_attribute_name", + "description": "Awareness attribute name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "awareness_attribute_value", + "description": "Awareness attribute value", + "required": true, + "schema": { + "type": "string" + } + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.json b/openapi_spec/json/paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.json new file mode 100644 index 00000000..e45d988b --- /dev/null +++ b/openapi_spec/json/paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.json @@ -0,0 +1,17 @@ +{ + "get": { + "x-endpoint-group": "cluster.get_decommission_awareness", + "description": "Get details and status of decommissioned attribute", + "parameters": [ + { + "in": "path", + "name": "awareness_attribute_name", + "description": "Awareness attribute name", + "required": true, + "schema": { + "type": "string" + } + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.decommission.awareness..json b/openapi_spec/json/paths/_cluster.decommission.awareness..json new file mode 100644 index 00000000..259fecda --- /dev/null +++ b/openapi_spec/json/paths/_cluster.decommission.awareness..json @@ -0,0 +1,9 @@ +{ + "delete": { + "x-endpoint-group": "cluster.delete_decommission_awareness", + "description": "Delete any existing decommission.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.health.(index).json b/openapi_spec/json/paths/_cluster.health.(index).json new file mode 100644 index 00000000..4bc75545 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.health.(index).json @@ -0,0 +1,59 @@ +{ + "get": { + "x-endpoint-group": "cluster.health", + "description": "Returns basic information about the health of the cluster.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "Limit the information returned to a specific index", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/wait_for_nodes" + }, + { + "$ref": "../parameters/query.json#/wait_for_events" + }, + { + "$ref": "../parameters/query.json#/wait_for_no_relocating_shards" + }, + { + "$ref": "../parameters/query.json#/wait_for_no_initializing_shards" + }, + { + "$ref": "../parameters/query.json#/wait_for_status" + }, + { + "$ref": "../parameters/query.json#/awareness_attribute" + }, + { + "$ref": "../parameters/query.json#/ensure_node_commissioned" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.health.json b/openapi_spec/json/paths/_cluster.health.json new file mode 100644 index 00000000..f6a1521b --- /dev/null +++ b/openapi_spec/json/paths/_cluster.health.json @@ -0,0 +1,50 @@ +{ + "get": { + "x-endpoint-group": "cluster.health", + "description": "Returns basic information about the health of the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/wait_for_nodes" + }, + { + "$ref": "../parameters/query.json#/wait_for_events" + }, + { + "$ref": "../parameters/query.json#/wait_for_no_relocating_shards" + }, + { + "$ref": "../parameters/query.json#/wait_for_no_initializing_shards" + }, + { + "$ref": "../parameters/query.json#/wait_for_status" + }, + { + "$ref": "../parameters/query.json#/awareness_attribute" + }, + { + "$ref": "../parameters/query.json#/ensure_node_commissioned" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.nodes.(node_id).hot_threads.json b/openapi_spec/json/paths/_cluster.nodes.(node_id).hot_threads.json new file mode 100644 index 00000000..4676e4ee --- /dev/null +++ b/openapi_spec/json/paths/_cluster.nodes.(node_id).hot_threads.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "nodes.hot_threads", + "description": "Returns information about hot threads on each node in the cluster.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/interval" + }, + { + "$ref": "../parameters/query.json#/snapshots" + }, + { + "$ref": "../parameters/query.json#/threads" + }, + { + "$ref": "../parameters/query.json#/ignore_idle_threads" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.nodes.(node_id).hotthreads.json b/openapi_spec/json/paths/_cluster.nodes.(node_id).hotthreads.json new file mode 100644 index 00000000..4676e4ee --- /dev/null +++ b/openapi_spec/json/paths/_cluster.nodes.(node_id).hotthreads.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "nodes.hot_threads", + "description": "Returns information about hot threads on each node in the cluster.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/interval" + }, + { + "$ref": "../parameters/query.json#/snapshots" + }, + { + "$ref": "../parameters/query.json#/threads" + }, + { + "$ref": "../parameters/query.json#/ignore_idle_threads" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.nodes.hot_threads.json b/openapi_spec/json/paths/_cluster.nodes.hot_threads.json new file mode 100644 index 00000000..11e09747 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.nodes.hot_threads.json @@ -0,0 +1,26 @@ +{ + "get": { + "x-endpoint-group": "nodes.hot_threads", + "description": "Returns information about hot threads on each node in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/interval" + }, + { + "$ref": "../parameters/query.json#/snapshots" + }, + { + "$ref": "../parameters/query.json#/threads" + }, + { + "$ref": "../parameters/query.json#/ignore_idle_threads" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.nodes.hotthreads.json b/openapi_spec/json/paths/_cluster.nodes.hotthreads.json new file mode 100644 index 00000000..11e09747 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.nodes.hotthreads.json @@ -0,0 +1,26 @@ +{ + "get": { + "x-endpoint-group": "nodes.hot_threads", + "description": "Returns information about hot threads on each node in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/interval" + }, + { + "$ref": "../parameters/query.json#/snapshots" + }, + { + "$ref": "../parameters/query.json#/threads" + }, + { + "$ref": "../parameters/query.json#/ignore_idle_threads" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.pending_tasks.json b/openapi_spec/json/paths/_cluster.pending_tasks.json new file mode 100644 index 00000000..ead2b2f4 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.pending_tasks.json @@ -0,0 +1,17 @@ +{ + "get": { + "x-endpoint-group": "cluster.pending_tasks", + "description": "Returns a list of any cluster-level changes (e.g. create index, update mapping,\nallocate or fail shard) which have not yet been executed.", + "parameters": [ + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.reroute.json b/openapi_spec/json/paths/_cluster.reroute.json new file mode 100644 index 00000000..fd264533 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.reroute.json @@ -0,0 +1,40 @@ +{ + "post": { + "x-endpoint-group": "cluster.reroute", + "description": "Allows to manually change the allocation of individual shards in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/dry_run" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/retry_failed" + }, + { + "$ref": "../parameters/query.json#/metric" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ], + "requestBody": { + "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.routing.awareness.(attribute).weights.json b/openapi_spec/json/paths/_cluster.routing.awareness.(attribute).weights.json new file mode 100644 index 00000000..f8fcc0c2 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.routing.awareness.(attribute).weights.json @@ -0,0 +1,32 @@ +{ + "put": { + "x-endpoint-group": "cluster.put_weighted_routing", + "description": "Updates weighted shard routing weights", + "parameters": [ + { + "in": "path", + "name": "attribute", + "description": "Awareness attribute name", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "get": { + "x-endpoint-group": "cluster.get_weighted_routing", + "description": "Fetches weighted shard routing weights", + "parameters": [ + { + "in": "path", + "name": "attribute", + "description": "Awareness attribute name", + "required": true, + "schema": { + "type": "string" + } + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.routing.awareness.weights.json b/openapi_spec/json/paths/_cluster.routing.awareness.weights.json new file mode 100644 index 00000000..ca6f2e3a --- /dev/null +++ b/openapi_spec/json/paths/_cluster.routing.awareness.weights.json @@ -0,0 +1,9 @@ +{ + "delete": { + "x-endpoint-group": "cluster.delete_weighted_routing", + "description": "Delete weighted shard routing weights", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.settings.json b/openapi_spec/json/paths/_cluster.settings.json new file mode 100644 index 00000000..bf8579ed --- /dev/null +++ b/openapi_spec/json/paths/_cluster.settings.json @@ -0,0 +1,52 @@ +{ + "put": { + "x-endpoint-group": "cluster.put_settings", + "description": "Updates the cluster settings.", + "parameters": [ + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ], + "requestBody": { + "description": "The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "get": { + "x-endpoint-group": "cluster.get_settings", + "description": "Returns cluster settings.", + "parameters": [ + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/include_defaults" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.state.(metric).(index).json b/openapi_spec/json/paths/_cluster.state.(metric).(index).json new file mode 100644 index 00000000..e8735816 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.state.(metric).(index).json @@ -0,0 +1,53 @@ +{ + "get": { + "x-endpoint-group": "cluster.state", + "description": "Returns a comprehensive information about the state of the cluster.", + "parameters": [ + { + "in": "path", + "name": "index", + "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "metric", + "description": "Limit the information returned to the specified metrics", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/wait_for_metadata_version" + }, + { + "$ref": "../parameters/query.json#/wait_for_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.state.(metric).json b/openapi_spec/json/paths/_cluster.state.(metric).json new file mode 100644 index 00000000..40770331 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.state.(metric).json @@ -0,0 +1,44 @@ +{ + "get": { + "x-endpoint-group": "cluster.state", + "description": "Returns a comprehensive information about the state of the cluster.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "Limit the information returned to the specified metrics", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/wait_for_metadata_version" + }, + { + "$ref": "../parameters/query.json#/wait_for_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.state.json b/openapi_spec/json/paths/_cluster.state.json new file mode 100644 index 00000000..f576e91a --- /dev/null +++ b/openapi_spec/json/paths/_cluster.state.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "cluster.state", + "description": "Returns a comprehensive information about the state of the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/wait_for_metadata_version" + }, + { + "$ref": "../parameters/query.json#/wait_for_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.stats.json b/openapi_spec/json/paths/_cluster.stats.json new file mode 100644 index 00000000..e8482de1 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.stats.json @@ -0,0 +1,14 @@ +{ + "get": { + "x-endpoint-group": "cluster.stats", + "description": "Returns high-level overview of cluster statistics.", + "parameters": [ + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.stats.nodes.(node_id).json b/openapi_spec/json/paths/_cluster.stats.nodes.(node_id).json new file mode 100644 index 00000000..fe00e6ef --- /dev/null +++ b/openapi_spec/json/paths/_cluster.stats.nodes.(node_id).json @@ -0,0 +1,23 @@ +{ + "get": { + "x-endpoint-group": "cluster.stats", + "description": "Returns high-level overview of cluster statistics.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_cluster.voting_config_exclusions.json b/openapi_spec/json/paths/_cluster.voting_config_exclusions.json new file mode 100644 index 00000000..8f291615 --- /dev/null +++ b/openapi_spec/json/paths/_cluster.voting_config_exclusions.json @@ -0,0 +1,26 @@ +{ + "post": { + "x-endpoint-group": "cluster.post_voting_config_exclusions", + "description": "Updates the cluster voting config exclusions by node ids or node names.", + "parameters": [ + { + "$ref": "../parameters/query.json#/node_ids" + }, + { + "$ref": "../parameters/query.json#/node_names" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + }, + "delete": { + "x-endpoint-group": "cluster.delete_voting_config_exclusions", + "description": "Clears cluster voting config exclusions.", + "parameters": [ + { + "$ref": "../parameters/query.json#/wait_for_removal" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_component_template.(name).json b/openapi_spec/json/paths/_component_template.(name).json new file mode 100644 index 00000000..19ed73d4 --- /dev/null +++ b/openapi_spec/json/paths/_component_template.(name).json @@ -0,0 +1,147 @@ +{ + "put": { + "x-endpoint-group": "cluster.put_component_template", + "description": "Creates or updates a component template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The template definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "cluster.put_component_template", + "description": "Creates or updates a component template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The template definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "delete": { + "x-endpoint-group": "cluster.delete_component_template", + "description": "Deletes a component template", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + }, + "head": { + "x-endpoint-group": "cluster.exists_component_template", + "description": "Returns information about whether a particular component template exist", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + }, + "get": { + "x-endpoint-group": "cluster.get_component_template", + "description": "Returns one or more component templates", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The comma separated names of the component templates", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_component_template.json b/openapi_spec/json/paths/_component_template.json new file mode 100644 index 00000000..498819b5 --- /dev/null +++ b/openapi_spec/json/paths/_component_template.json @@ -0,0 +1,17 @@ +{ + "get": { + "x-endpoint-group": "cluster.get_component_template", + "description": "Returns one or more component templates", + "parameters": [ + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_count.json b/openapi_spec/json/paths/_count.json new file mode 100644 index 00000000..f3d82402 --- /dev/null +++ b/openapi_spec/json/paths/_count.json @@ -0,0 +1,109 @@ +{ + "post": { + "x-endpoint-group": "count", + "description": "Returns number of documents matching a query.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/min_score" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + } + ], + "requestBody": { + "description": "A query to restrict the results specified with the Query DSL (optional)", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "get": { + "x-endpoint-group": "count", + "description": "Returns number of documents matching a query.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/min_score" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_dangling.(index_uuid).json b/openapi_spec/json/paths/_dangling.(index_uuid).json new file mode 100644 index 00000000..b2ebc90f --- /dev/null +++ b/openapi_spec/json/paths/_dangling.(index_uuid).json @@ -0,0 +1,56 @@ +{ + "post": { + "x-endpoint-group": "dangling_indices.import_dangling_index", + "description": "Imports the specified dangling index", + "parameters": [ + { + "in": "path", + "name": "index_uuid", + "description": "The UUID of the dangling index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/accept_data_loss" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + }, + "delete": { + "x-endpoint-group": "dangling_indices.delete_dangling_index", + "description": "Deletes the specified dangling index", + "parameters": [ + { + "in": "path", + "name": "index_uuid", + "description": "The UUID of the dangling index", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/accept_data_loss" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_dangling.json b/openapi_spec/json/paths/_dangling.json new file mode 100644 index 00000000..207327d8 --- /dev/null +++ b/openapi_spec/json/paths/_dangling.json @@ -0,0 +1,9 @@ +{ + "get": { + "x-endpoint-group": "dangling_indices.list_dangling_indices", + "description": "Returns all dangling indices.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_data_stream.(name)._stats.json b/openapi_spec/json/paths/_data_stream.(name)._stats.json new file mode 100644 index 00000000..d2dd12bc --- /dev/null +++ b/openapi_spec/json/paths/_data_stream.(name)._stats.json @@ -0,0 +1,17 @@ +{ + "get": { + "x-endpoint-group": "indices.data_streams_stats", + "description": "Provides statistics on operations happening in a data stream.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_data_stream.(name).json b/openapi_spec/json/paths/_data_stream.(name).json new file mode 100644 index 00000000..25efa74d --- /dev/null +++ b/openapi_spec/json/paths/_data_stream.(name).json @@ -0,0 +1,58 @@ +{ + "delete": { + "x-endpoint-group": "indices.delete_data_stream", + "description": "Deletes a data stream.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of data streams to delete; use `*` to delete all data streams", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + } + ] + }, + "get": { + "x-endpoint-group": "indices.get_data_stream", + "description": "Returns data streams.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of data streams to get; use `*` to get all data streams", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + } + ] + }, + "put": { + "x-endpoint-group": "indices.create_data_stream", + "description": "Creates or updates a data stream", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the data stream", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The data stream definition", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_data_stream._stats.json b/openapi_spec/json/paths/_data_stream._stats.json new file mode 100644 index 00000000..31694598 --- /dev/null +++ b/openapi_spec/json/paths/_data_stream._stats.json @@ -0,0 +1,9 @@ +{ + "get": { + "x-endpoint-group": "indices.data_streams_stats", + "description": "Provides statistics on operations happening in a data stream.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_data_stream.json b/openapi_spec/json/paths/_data_stream.json new file mode 100644 index 00000000..52e897b0 --- /dev/null +++ b/openapi_spec/json/paths/_data_stream.json @@ -0,0 +1,9 @@ +{ + "get": { + "x-endpoint-group": "indices.get_data_stream", + "description": "Returns data streams.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_delete_by_query.(task_id)._rethrottle.json b/openapi_spec/json/paths/_delete_by_query.(task_id)._rethrottle.json new file mode 100644 index 00000000..b9e0f292 --- /dev/null +++ b/openapi_spec/json/paths/_delete_by_query.(task_id)._rethrottle.json @@ -0,0 +1,20 @@ +{ + "post": { + "x-endpoint-group": "delete_by_query_rethrottle", + "description": "Changes the number of requests per second for a particular Delete By Query operation.", + "parameters": [ + { + "in": "path", + "name": "task_id", + "description": "The task id to rethrottle", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/requests_per_second" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_field_caps.json b/openapi_spec/json/paths/_field_caps.json new file mode 100644 index 00000000..00989055 --- /dev/null +++ b/openapi_spec/json/paths/_field_caps.json @@ -0,0 +1,55 @@ +{ + "get": { + "x-endpoint-group": "field_caps", + "description": "Returns the information about the capabilities of fields among multiple indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/include_unmapped" + } + ] + }, + "post": { + "x-endpoint-group": "field_caps", + "description": "Returns the information about the capabilities of fields among multiple indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/include_unmapped" + } + ], + "requestBody": { + "description": "An index filter specified with the Query DSL", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_flush.json b/openapi_spec/json/paths/_flush.json new file mode 100644 index 00000000..1c6bf2f0 --- /dev/null +++ b/openapi_spec/json/paths/_flush.json @@ -0,0 +1,44 @@ +{ + "post": { + "x-endpoint-group": "indices.flush", + "description": "Performs the flush operation on one or more indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/force" + }, + { + "$ref": "../parameters/query.json#/wait_if_ongoing" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + }, + "get": { + "x-endpoint-group": "indices.flush", + "description": "Performs the flush operation on one or more indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/force" + }, + { + "$ref": "../parameters/query.json#/wait_if_ongoing" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_forcemerge.json b/openapi_spec/json/paths/_forcemerge.json new file mode 100644 index 00000000..a8b36e4e --- /dev/null +++ b/openapi_spec/json/paths/_forcemerge.json @@ -0,0 +1,26 @@ +{ + "post": { + "x-endpoint-group": "indices.forcemerge", + "description": "Performs the force merge operation on one or more indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/flush" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/max_num_segments" + }, + { + "$ref": "../parameters/query.json#/only_expunge_deletes" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_index_template.(name).json b/openapi_spec/json/paths/_index_template.(name).json new file mode 100644 index 00000000..1b894f06 --- /dev/null +++ b/openapi_spec/json/paths/_index_template.(name).json @@ -0,0 +1,153 @@ +{ + "get": { + "x-endpoint-group": "indices.get_index_template", + "description": "Returns an index template.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The comma separated names of the index templates", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + }, + "put": { + "x-endpoint-group": "indices.put_index_template", + "description": "Creates or updates an index template.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/cause" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The template definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "indices.put_index_template", + "description": "Creates or updates an index template.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/cause" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The template definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "delete": { + "x-endpoint-group": "indices.delete_index_template", + "description": "Deletes an index template.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + }, + "head": { + "x-endpoint-group": "indices.exists_index_template", + "description": "Returns information about whether a particular index template exists.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_index_template._simulate.(name).json b/openapi_spec/json/paths/_index_template._simulate.(name).json new file mode 100644 index 00000000..143bd05a --- /dev/null +++ b/openapi_spec/json/paths/_index_template._simulate.(name).json @@ -0,0 +1,40 @@ +{ + "post": { + "x-endpoint-group": "indices.simulate_template", + "description": "Simulate resolving the given template name or body", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the index template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/cause" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "New index template definition to be simulated, if no index template name is specified", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_index_template._simulate.json b/openapi_spec/json/paths/_index_template._simulate.json new file mode 100644 index 00000000..3ce0d268 --- /dev/null +++ b/openapi_spec/json/paths/_index_template._simulate.json @@ -0,0 +1,31 @@ +{ + "post": { + "x-endpoint-group": "indices.simulate_template", + "description": "Simulate resolving the given template name or body", + "parameters": [ + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/cause" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "New index template definition to be simulated, if no index template name is specified", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_index_template._simulate_index.(name).json b/openapi_spec/json/paths/_index_template._simulate_index.(name).json new file mode 100644 index 00000000..ed2e055b --- /dev/null +++ b/openapi_spec/json/paths/_index_template._simulate_index.(name).json @@ -0,0 +1,40 @@ +{ + "post": { + "x-endpoint-group": "indices.simulate_index_template", + "description": "Simulate matching the given index name against the index templates in the system", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the index (it must be a concrete index name)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/cause" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "New index template definition, which will be included in the simulation, as if it already exists in the system", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_index_template.json b/openapi_spec/json/paths/_index_template.json new file mode 100644 index 00000000..fb780ed2 --- /dev/null +++ b/openapi_spec/json/paths/_index_template.json @@ -0,0 +1,20 @@ +{ + "get": { + "x-endpoint-group": "indices.get_index_template", + "description": "Returns an index template.", + "parameters": [ + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_ingest.pipeline.(id)._simulate.json b/openapi_spec/json/paths/_ingest.pipeline.(id)._simulate.json new file mode 100644 index 00000000..2d6c5d4b --- /dev/null +++ b/openapi_spec/json/paths/_ingest.pipeline.(id)._simulate.json @@ -0,0 +1,49 @@ +{ + "get": { + "x-endpoint-group": "ingest.simulate", + "description": "Allows to simulate a pipeline with example documents.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Pipeline ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/verbose" + } + ] + }, + "post": { + "x-endpoint-group": "ingest.simulate", + "description": "Allows to simulate a pipeline with example documents.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Pipeline ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/verbose" + } + ], + "requestBody": { + "description": "The simulate definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_ingest.pipeline.(id).json b/openapi_spec/json/paths/_ingest.pipeline.(id).json new file mode 100644 index 00000000..8d68218a --- /dev/null +++ b/openapi_spec/json/paths/_ingest.pipeline.(id).json @@ -0,0 +1,82 @@ +{ + "put": { + "x-endpoint-group": "ingest.put_pipeline", + "description": "Creates or updates a pipeline.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Pipeline ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ], + "requestBody": { + "description": "The ingest definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "delete": { + "x-endpoint-group": "ingest.delete_pipeline", + "description": "Deletes a pipeline.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Pipeline ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + }, + "get": { + "x-endpoint-group": "ingest.get_pipeline", + "description": "Returns a pipeline.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Comma separated list of pipeline ids. Wildcards supported", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_ingest.pipeline._simulate.json b/openapi_spec/json/paths/_ingest.pipeline._simulate.json new file mode 100644 index 00000000..cc46e0f6 --- /dev/null +++ b/openapi_spec/json/paths/_ingest.pipeline._simulate.json @@ -0,0 +1,31 @@ +{ + "get": { + "x-endpoint-group": "ingest.simulate", + "description": "Allows to simulate a pipeline with example documents.", + "parameters": [ + { + "$ref": "../parameters/query.json#/verbose" + } + ] + }, + "post": { + "x-endpoint-group": "ingest.simulate", + "description": "Allows to simulate a pipeline with example documents.", + "parameters": [ + { + "$ref": "../parameters/query.json#/verbose" + } + ], + "requestBody": { + "description": "The simulate definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_ingest.pipeline.json b/openapi_spec/json/paths/_ingest.pipeline.json new file mode 100644 index 00000000..76f1eeba --- /dev/null +++ b/openapi_spec/json/paths/_ingest.pipeline.json @@ -0,0 +1,14 @@ +{ + "get": { + "x-endpoint-group": "ingest.get_pipeline", + "description": "Returns a pipeline.", + "parameters": [ + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_ingest.processor.grok.json b/openapi_spec/json/paths/_ingest.processor.grok.json new file mode 100644 index 00000000..abb48b29 --- /dev/null +++ b/openapi_spec/json/paths/_ingest.processor.grok.json @@ -0,0 +1,9 @@ +{ + "get": { + "x-endpoint-group": "ingest.processor_grok", + "description": "Returns a list of the built-in patterns.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_mapping.field.(fields).json b/openapi_spec/json/paths/_mapping.field.(fields).json new file mode 100644 index 00000000..66fff997 --- /dev/null +++ b/openapi_spec/json/paths/_mapping.field.(fields).json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "indices.get_field_mapping", + "description": "Returns mapping for one or more fields.", + "parameters": [ + { + "in": "path", + "name": "fields", + "description": "A comma-separated list of fields", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/include_defaults" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_mapping.json b/openapi_spec/json/paths/_mapping.json new file mode 100644 index 00000000..3a9014c3 --- /dev/null +++ b/openapi_spec/json/paths/_mapping.json @@ -0,0 +1,26 @@ +{ + "get": { + "x-endpoint-group": "indices.get_mapping", + "description": "Returns mappings for one or more indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_mget.json b/openapi_spec/json/paths/_mget.json new file mode 100644 index 00000000..8883cbb4 --- /dev/null +++ b/openapi_spec/json/paths/_mget.json @@ -0,0 +1,73 @@ +{ + "get": { + "x-endpoint-group": "mget", + "description": "Allows to get multiple documents in one request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + } + ] + }, + "post": { + "x-endpoint-group": "mget", + "description": "Allows to get multiple documents in one request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + } + ], + "requestBody": { + "description": "Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_msearch.json b/openapi_spec/json/paths/_msearch.json new file mode 100644 index 00000000..91e5b401 --- /dev/null +++ b/openapi_spec/json/paths/_msearch.json @@ -0,0 +1,67 @@ +{ + "get": { + "x-endpoint-group": "msearch", + "description": "Allows to execute several search operations in one request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_searches" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/pre_filter_shard_size" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_shard_requests" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ] + }, + "post": { + "x-endpoint-group": "msearch", + "description": "Allows to execute several search operations in one request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_searches" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/pre_filter_shard_size" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_shard_requests" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ], + "requestBody": { + "description": "The request definitions (metadata-search request definition pairs), separated by newlines", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_msearch.template.json b/openapi_spec/json/paths/_msearch.template.json new file mode 100644 index 00000000..c3d67cb6 --- /dev/null +++ b/openapi_spec/json/paths/_msearch.template.json @@ -0,0 +1,55 @@ +{ + "get": { + "x-endpoint-group": "msearch_template", + "description": "Allows to execute several search template operations in one request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_searches" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ] + }, + "post": { + "x-endpoint-group": "msearch_template", + "description": "Allows to execute several search template operations in one request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_searches" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ], + "requestBody": { + "description": "The request definitions (metadata-search request definition pairs), separated by newlines", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_mtermvectors.json b/openapi_spec/json/paths/_mtermvectors.json new file mode 100644 index 00000000..86b98d55 --- /dev/null +++ b/openapi_spec/json/paths/_mtermvectors.json @@ -0,0 +1,97 @@ +{ + "get": { + "x-endpoint-group": "mtermvectors", + "description": "Returns multiple termvectors in one request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ids" + }, + { + "$ref": "../parameters/query.json#/term_statistics" + }, + { + "$ref": "../parameters/query.json#/field_statistics" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/offsets" + }, + { + "$ref": "../parameters/query.json#/positions" + }, + { + "$ref": "../parameters/query.json#/payloads" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ] + }, + "post": { + "x-endpoint-group": "mtermvectors", + "description": "Returns multiple termvectors in one request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ids" + }, + { + "$ref": "../parameters/query.json#/term_statistics" + }, + { + "$ref": "../parameters/query.json#/field_statistics" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/offsets" + }, + { + "$ref": "../parameters/query.json#/positions" + }, + { + "$ref": "../parameters/query.json#/payloads" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/realtime" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/version_type" + } + ], + "requestBody": { + "description": "Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(metric).json b/openapi_spec/json/paths/_nodes.(metric).json new file mode 100644 index 00000000..d070f16e --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(metric).json @@ -0,0 +1,23 @@ +{ + "get": { + "x-endpoint-group": "nodes.info", + "description": "Returns information about nodes in the cluster.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "A comma-separated list of metrics you wish returned. Leave empty to return all.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).(metric).json b/openapi_spec/json/paths/_nodes.(node_id).(metric).json new file mode 100644 index 00000000..3f80acd7 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).(metric).json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "nodes.info", + "description": "Returns information about nodes in the cluster.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "metric", + "description": "A comma-separated list of metrics you wish returned. Leave empty to return all.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).hot_threads.json b/openapi_spec/json/paths/_nodes.(node_id).hot_threads.json new file mode 100644 index 00000000..4676e4ee --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).hot_threads.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "nodes.hot_threads", + "description": "Returns information about hot threads on each node in the cluster.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/interval" + }, + { + "$ref": "../parameters/query.json#/snapshots" + }, + { + "$ref": "../parameters/query.json#/threads" + }, + { + "$ref": "../parameters/query.json#/ignore_idle_threads" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).hotthreads.json b/openapi_spec/json/paths/_nodes.(node_id).hotthreads.json new file mode 100644 index 00000000..4676e4ee --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).hotthreads.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "nodes.hot_threads", + "description": "Returns information about hot threads on each node in the cluster.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/interval" + }, + { + "$ref": "../parameters/query.json#/snapshots" + }, + { + "$ref": "../parameters/query.json#/threads" + }, + { + "$ref": "../parameters/query.json#/ignore_idle_threads" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).json b/openapi_spec/json/paths/_nodes.(node_id).json new file mode 100644 index 00000000..4e48f177 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).json @@ -0,0 +1,23 @@ +{ + "get": { + "x-endpoint-group": "nodes.info", + "description": "Returns information about nodes in the cluster.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).reload_secure_settings.json b/openapi_spec/json/paths/_nodes.(node_id).reload_secure_settings.json new file mode 100644 index 00000000..6e9f88a1 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).reload_secure_settings.json @@ -0,0 +1,31 @@ +{ + "post": { + "x-endpoint-group": "nodes.reload_secure_settings", + "description": "Reloads secure settings.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ], + "requestBody": { + "description": "An object containing the password for the opensearch keystore", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).stats.(metric).(index_metric).json b/openapi_spec/json/paths/_nodes.(node_id).stats.(metric).(index_metric).json new file mode 100644 index 00000000..d9450c45 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).stats.(metric).(index_metric).json @@ -0,0 +1,59 @@ +{ + "get": { + "x-endpoint-group": "nodes.stats", + "description": "Returns statistical information about nodes in the cluster.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "Limit the information returned to the specified metrics", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "index_metric", + "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/types" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).stats.(metric).json b/openapi_spec/json/paths/_nodes.(node_id).stats.(metric).json new file mode 100644 index 00000000..10acc9e8 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).stats.(metric).json @@ -0,0 +1,50 @@ +{ + "get": { + "x-endpoint-group": "nodes.stats", + "description": "Returns statistical information about nodes in the cluster.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "Limit the information returned to the specified metrics", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/types" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).stats.json b/openapi_spec/json/paths/_nodes.(node_id).stats.json new file mode 100644 index 00000000..c4e54ab6 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).stats.json @@ -0,0 +1,41 @@ +{ + "get": { + "x-endpoint-group": "nodes.stats", + "description": "Returns statistical information about nodes in the cluster.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/types" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).usage.(metric).json b/openapi_spec/json/paths/_nodes.(node_id).usage.(metric).json new file mode 100644 index 00000000..3bce4ecb --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).usage.(metric).json @@ -0,0 +1,29 @@ +{ + "get": { + "x-endpoint-group": "nodes.usage", + "description": "Returns low-level information about REST actions usage on nodes.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "Limit the information returned to the specified metrics", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.(node_id).usage.json b/openapi_spec/json/paths/_nodes.(node_id).usage.json new file mode 100644 index 00000000..da6acf97 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.(node_id).usage.json @@ -0,0 +1,20 @@ +{ + "get": { + "x-endpoint-group": "nodes.usage", + "description": "Returns low-level information about REST actions usage on nodes.", + "parameters": [ + { + "in": "path", + "name": "node_id", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.hot_threads.json b/openapi_spec/json/paths/_nodes.hot_threads.json new file mode 100644 index 00000000..11e09747 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.hot_threads.json @@ -0,0 +1,26 @@ +{ + "get": { + "x-endpoint-group": "nodes.hot_threads", + "description": "Returns information about hot threads on each node in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/interval" + }, + { + "$ref": "../parameters/query.json#/snapshots" + }, + { + "$ref": "../parameters/query.json#/threads" + }, + { + "$ref": "../parameters/query.json#/ignore_idle_threads" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.hotthreads.json b/openapi_spec/json/paths/_nodes.hotthreads.json new file mode 100644 index 00000000..11e09747 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.hotthreads.json @@ -0,0 +1,26 @@ +{ + "get": { + "x-endpoint-group": "nodes.hot_threads", + "description": "Returns information about hot threads on each node in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/interval" + }, + { + "$ref": "../parameters/query.json#/snapshots" + }, + { + "$ref": "../parameters/query.json#/threads" + }, + { + "$ref": "../parameters/query.json#/ignore_idle_threads" + }, + { + "$ref": "../parameters/query.json#/type" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.json b/openapi_spec/json/paths/_nodes.json new file mode 100644 index 00000000..db24fae8 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.json @@ -0,0 +1,14 @@ +{ + "get": { + "x-endpoint-group": "nodes.info", + "description": "Returns information about nodes in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.reload_secure_settings.json b/openapi_spec/json/paths/_nodes.reload_secure_settings.json new file mode 100644 index 00000000..c198181e --- /dev/null +++ b/openapi_spec/json/paths/_nodes.reload_secure_settings.json @@ -0,0 +1,22 @@ +{ + "post": { + "x-endpoint-group": "nodes.reload_secure_settings", + "description": "Reloads secure settings.", + "parameters": [ + { + "$ref": "../parameters/query.json#/timeout" + } + ], + "requestBody": { + "description": "An object containing the password for the opensearch keystore", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.stats.(metric).(index_metric).json b/openapi_spec/json/paths/_nodes.stats.(metric).(index_metric).json new file mode 100644 index 00000000..1355c041 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.stats.(metric).(index_metric).json @@ -0,0 +1,50 @@ +{ + "get": { + "x-endpoint-group": "nodes.stats", + "description": "Returns statistical information about nodes in the cluster.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "Limit the information returned to the specified metrics", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "in": "path", + "name": "index_metric", + "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/types" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.stats.(metric).json b/openapi_spec/json/paths/_nodes.stats.(metric).json new file mode 100644 index 00000000..2c12ae2b --- /dev/null +++ b/openapi_spec/json/paths/_nodes.stats.(metric).json @@ -0,0 +1,41 @@ +{ + "get": { + "x-endpoint-group": "nodes.stats", + "description": "Returns statistical information about nodes in the cluster.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "Limit the information returned to the specified metrics", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/types" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.stats.json b/openapi_spec/json/paths/_nodes.stats.json new file mode 100644 index 00000000..e28e7e30 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.stats.json @@ -0,0 +1,32 @@ +{ + "get": { + "x-endpoint-group": "nodes.stats", + "description": "Returns statistical information about nodes in the cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/types" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.usage.(metric).json b/openapi_spec/json/paths/_nodes.usage.(metric).json new file mode 100644 index 00000000..c5a4c2b0 --- /dev/null +++ b/openapi_spec/json/paths/_nodes.usage.(metric).json @@ -0,0 +1,20 @@ +{ + "get": { + "x-endpoint-group": "nodes.usage", + "description": "Returns low-level information about REST actions usage on nodes.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "Limit the information returned to the specified metrics", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_nodes.usage.json b/openapi_spec/json/paths/_nodes.usage.json new file mode 100644 index 00000000..5a1bb5da --- /dev/null +++ b/openapi_spec/json/paths/_nodes.usage.json @@ -0,0 +1,11 @@ +{ + "get": { + "x-endpoint-group": "nodes.usage", + "description": "Returns low-level information about REST actions usage on nodes.", + "parameters": [ + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_rank_eval.json b/openapi_spec/json/paths/_rank_eval.json new file mode 100644 index 00000000..95a43a48 --- /dev/null +++ b/openapi_spec/json/paths/_rank_eval.json @@ -0,0 +1,49 @@ +{ + "get": { + "x-endpoint-group": "rank_eval", + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/search_type" + } + ] + }, + "post": { + "x-endpoint-group": "rank_eval", + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/search_type" + } + ], + "requestBody": { + "description": "The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_recovery.json b/openapi_spec/json/paths/_recovery.json new file mode 100644 index 00000000..5fd25ddb --- /dev/null +++ b/openapi_spec/json/paths/_recovery.json @@ -0,0 +1,14 @@ +{ + "get": { + "x-endpoint-group": "indices.recovery", + "description": "Returns information about ongoing index shard recoveries.", + "parameters": [ + { + "$ref": "../parameters/query.json#/detailed" + }, + { + "$ref": "../parameters/query.json#/active_only" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_refresh.json b/openapi_spec/json/paths/_refresh.json new file mode 100644 index 00000000..d4c83430 --- /dev/null +++ b/openapi_spec/json/paths/_refresh.json @@ -0,0 +1,32 @@ +{ + "post": { + "x-endpoint-group": "indices.refresh", + "description": "Performs the refresh operation in one or more indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + }, + "get": { + "x-endpoint-group": "indices.refresh", + "description": "Performs the refresh operation in one or more indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_reindex.(task_id)._rethrottle.json b/openapi_spec/json/paths/_reindex.(task_id)._rethrottle.json new file mode 100644 index 00000000..45f51ddf --- /dev/null +++ b/openapi_spec/json/paths/_reindex.(task_id)._rethrottle.json @@ -0,0 +1,20 @@ +{ + "post": { + "x-endpoint-group": "reindex_rethrottle", + "description": "Changes the number of requests per second for a particular Reindex operation.", + "parameters": [ + { + "in": "path", + "name": "task_id", + "description": "The task id to rethrottle", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/requests_per_second" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_reindex.json b/openapi_spec/json/paths/_reindex.json new file mode 100644 index 00000000..aa356320 --- /dev/null +++ b/openapi_spec/json/paths/_reindex.json @@ -0,0 +1,43 @@ +{ + "post": { + "x-endpoint-group": "reindex", + "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", + "parameters": [ + { + "$ref": "../parameters/query.json#/refresh" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_active_shards" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + }, + { + "$ref": "../parameters/query.json#/requests_per_second" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/slices" + }, + { + "$ref": "../parameters/query.json#/max_docs" + } + ], + "requestBody": { + "description": "The search definition using the Query DSL and the prototype for the index request.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_remote.info.json b/openapi_spec/json/paths/_remote.info.json new file mode 100644 index 00000000..535e7bb8 --- /dev/null +++ b/openapi_spec/json/paths/_remote.info.json @@ -0,0 +1,9 @@ +{ + "get": { + "x-endpoint-group": "cluster.remote_info", + "description": "Returns the information about configured remote clusters.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_remotestore._restore.json b/openapi_spec/json/paths/_remotestore._restore.json new file mode 100644 index 00000000..421ddc50 --- /dev/null +++ b/openapi_spec/json/paths/_remotestore._restore.json @@ -0,0 +1,25 @@ +{ + "post": { + "x-endpoint-group": "remote_store.restore", + "description": "Restores from remote store.", + "parameters": [ + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + } + ], + "requestBody": { + "description": "A comma separated list of index IDs", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_render.template.(id).json b/openapi_spec/json/paths/_render.template.(id).json new file mode 100644 index 00000000..3fe6a1a8 --- /dev/null +++ b/openapi_spec/json/paths/_render.template.(id).json @@ -0,0 +1,43 @@ +{ + "get": { + "x-endpoint-group": "render_search_template", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The id of the stored search template", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "x-endpoint-group": "render_search_template", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The id of the stored search template", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The search definition template and its params", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_render.template.json b/openapi_spec/json/paths/_render.template.json new file mode 100644 index 00000000..5e2b71f0 --- /dev/null +++ b/openapi_spec/json/paths/_render.template.json @@ -0,0 +1,27 @@ +{ + "get": { + "x-endpoint-group": "render_search_template", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "parameters": [ + + ] + }, + "post": { + "x-endpoint-group": "render_search_template", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "parameters": [ + + ], + "requestBody": { + "description": "The search definition template and its params", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_resolve.index.(name).json b/openapi_spec/json/paths/_resolve.index.(name).json new file mode 100644 index 00000000..9aeb4280 --- /dev/null +++ b/openapi_spec/json/paths/_resolve.index.(name).json @@ -0,0 +1,20 @@ +{ + "get": { + "x-endpoint-group": "indices.resolve_index", + "description": "Returns information about any matching indices, aliases, and data streams", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of names or wildcard expressions", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_script_context.json b/openapi_spec/json/paths/_script_context.json new file mode 100644 index 00000000..05c93cb7 --- /dev/null +++ b/openapi_spec/json/paths/_script_context.json @@ -0,0 +1,9 @@ +{ + "get": { + "x-endpoint-group": "get_script_context", + "description": "Returns all script contexts.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_script_language.json b/openapi_spec/json/paths/_script_language.json new file mode 100644 index 00000000..0dd2ec79 --- /dev/null +++ b/openapi_spec/json/paths/_script_language.json @@ -0,0 +1,9 @@ +{ + "get": { + "x-endpoint-group": "get_script_languages", + "description": "Returns available script types, languages and contexts", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_scripts.(id).(context).json b/openapi_spec/json/paths/_scripts.(id).(context).json new file mode 100644 index 00000000..84952c11 --- /dev/null +++ b/openapi_spec/json/paths/_scripts.(id).(context).json @@ -0,0 +1,96 @@ +{ + "put": { + "x-endpoint-group": "put_script", + "description": "Creates or updates a script.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Script ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "context", + "description": "Script context", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/context" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "put_script", + "description": "Creates or updates a script.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Script ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "context", + "description": "Script context", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/context" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_scripts.(id).json b/openapi_spec/json/paths/_scripts.(id).json new file mode 100644 index 00000000..776033c6 --- /dev/null +++ b/openapi_spec/json/paths/_scripts.(id).json @@ -0,0 +1,123 @@ +{ + "delete": { + "x-endpoint-group": "delete_script", + "description": "Deletes a script.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Script ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + }, + "get": { + "x-endpoint-group": "get_script", + "description": "Returns a script.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Script ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + }, + "put": { + "x-endpoint-group": "put_script", + "description": "Creates or updates a script.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Script ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/context" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "put_script", + "description": "Creates or updates a script.", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Script ID", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/context" + } + ], + "requestBody": { + "description": "The document", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_scripts.painless._execute.json b/openapi_spec/json/paths/_scripts.painless._execute.json new file mode 100644 index 00000000..3015b3c2 --- /dev/null +++ b/openapi_spec/json/paths/_scripts.painless._execute.json @@ -0,0 +1,27 @@ +{ + "get": { + "x-endpoint-group": "scripts_painless_execute", + "description": "Allows an arbitrary script to be executed and a result to be returned", + "parameters": [ + + ] + }, + "post": { + "x-endpoint-group": "scripts_painless_execute", + "description": "Allows an arbitrary script to be executed and a result to be returned", + "parameters": [ + + ], + "requestBody": { + "description": "The script to execute", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_search.json b/openapi_spec/json/paths/_search.json new file mode 100644 index 00000000..dfdbd8df --- /dev/null +++ b/openapi_spec/json/paths/_search.json @@ -0,0 +1,277 @@ +{ + "get": { + "x-endpoint-group": "search", + "description": "Returns results matching a query.", + "parameters": [ + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/docvalue_fields" + }, + { + "$ref": "../parameters/query.json#/from" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/size" + }, + { + "$ref": "../parameters/query.json#/sort" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + }, + { + "$ref": "../parameters/query.json#/stats" + }, + { + "$ref": "../parameters/query.json#/suggest_field" + }, + { + "$ref": "../parameters/query.json#/suggest_mode" + }, + { + "$ref": "../parameters/query.json#/suggest_size" + }, + { + "$ref": "../parameters/query.json#/suggest_text" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/track_scores" + }, + { + "$ref": "../parameters/query.json#/track_total_hits" + }, + { + "$ref": "../parameters/query.json#/allow_partial_search_results" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/seq_no_primary_term" + }, + { + "$ref": "../parameters/query.json#/request_cache" + }, + { + "$ref": "../parameters/query.json#/batched_reduce_size" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_shard_requests" + }, + { + "$ref": "../parameters/query.json#/pre_filter_shard_size" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + } + ] + }, + "post": { + "x-endpoint-group": "search", + "description": "Returns results matching a query.", + "parameters": [ + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/stored_fields" + }, + { + "$ref": "../parameters/query.json#/docvalue_fields" + }, + { + "$ref": "../parameters/query.json#/from" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/size" + }, + { + "$ref": "../parameters/query.json#/sort" + }, + { + "$ref": "../parameters/query.json#/_source" + }, + { + "$ref": "../parameters/query.json#/_source_excludes" + }, + { + "$ref": "../parameters/query.json#/_source_includes" + }, + { + "$ref": "../parameters/query.json#/terminate_after" + }, + { + "$ref": "../parameters/query.json#/stats" + }, + { + "$ref": "../parameters/query.json#/suggest_field" + }, + { + "$ref": "../parameters/query.json#/suggest_mode" + }, + { + "$ref": "../parameters/query.json#/suggest_size" + }, + { + "$ref": "../parameters/query.json#/suggest_text" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/track_scores" + }, + { + "$ref": "../parameters/query.json#/track_total_hits" + }, + { + "$ref": "../parameters/query.json#/allow_partial_search_results" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/version" + }, + { + "$ref": "../parameters/query.json#/seq_no_primary_term" + }, + { + "$ref": "../parameters/query.json#/request_cache" + }, + { + "$ref": "../parameters/query.json#/batched_reduce_size" + }, + { + "$ref": "../parameters/query.json#/max_concurrent_shard_requests" + }, + { + "$ref": "../parameters/query.json#/pre_filter_shard_size" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + } + ], + "requestBody": { + "description": "The search definition using the Query DSL", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_search.point_in_time._all.json b/openapi_spec/json/paths/_search.point_in_time._all.json new file mode 100644 index 00000000..91f84414 --- /dev/null +++ b/openapi_spec/json/paths/_search.point_in_time._all.json @@ -0,0 +1,16 @@ +{ + "delete": { + "x-endpoint-group": "delete_all_pits", + "description": "Deletes all active point in time searches.", + "parameters": [ + + ] + }, + "get": { + "x-endpoint-group": "get_all_pits", + "description": "Lists all active point in time searches.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_search.point_in_time.json b/openapi_spec/json/paths/_search.point_in_time.json new file mode 100644 index 00000000..081ce5b1 --- /dev/null +++ b/openapi_spec/json/paths/_search.point_in_time.json @@ -0,0 +1,9 @@ +{ + "delete": { + "x-endpoint-group": "delete_pit", + "description": "Deletes one or more point in time searches based on the IDs passed.", + "parameters": [ + + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_search.scroll.(scroll_id).json b/openapi_spec/json/paths/_search.scroll.(scroll_id).json new file mode 100644 index 00000000..1e06dcb9 --- /dev/null +++ b/openapi_spec/json/paths/_search.scroll.(scroll_id).json @@ -0,0 +1,79 @@ +{ + "delete": { + "x-endpoint-group": "clear_scroll", + "description": "Explicitly clears the search context for a scroll.", + "parameters": [ + { + "in": "path", + "name": "scroll_id", + "description": "A comma-separated list of scroll IDs to clear", + "required": true, + "deprecated": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + } + ] + }, + "get": { + "x-endpoint-group": "scroll", + "description": "Allows to retrieve a large numbers of results from a single search request.", + "parameters": [ + { + "in": "path", + "name": "scroll_id", + "description": "The scroll ID", + "required": true, + "deprecated": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/scroll_id" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + } + ] + }, + "post": { + "x-endpoint-group": "scroll", + "description": "Allows to retrieve a large numbers of results from a single search request.", + "parameters": [ + { + "in": "path", + "name": "scroll_id", + "description": "The scroll ID", + "required": true, + "deprecated": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/scroll_id" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + } + ], + "requestBody": { + "description": "The scroll ID if not passed by URL or query parameter.", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_search.scroll.json b/openapi_spec/json/paths/_search.scroll.json new file mode 100644 index 00000000..ecc24023 --- /dev/null +++ b/openapi_spec/json/paths/_search.scroll.json @@ -0,0 +1,50 @@ +{ + "delete": { + "x-endpoint-group": "clear_scroll", + "description": "Explicitly clears the search context for a scroll.", + "parameters": [ + + ] + }, + "get": { + "x-endpoint-group": "scroll", + "description": "Allows to retrieve a large numbers of results from a single search request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/scroll_id" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + } + ] + }, + "post": { + "x-endpoint-group": "scroll", + "description": "Allows to retrieve a large numbers of results from a single search request.", + "parameters": [ + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/scroll_id" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + } + ], + "requestBody": { + "description": "The scroll ID if not passed by URL or query parameter.", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_search.template.json b/openapi_spec/json/paths/_search.template.json new file mode 100644 index 00000000..e3616887 --- /dev/null +++ b/openapi_spec/json/paths/_search.template.json @@ -0,0 +1,103 @@ +{ + "get": { + "x-endpoint-group": "search_template", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/profile" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ] + }, + "post": { + "x-endpoint-group": "search_template", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/ignore_throttled" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/scroll" + }, + { + "$ref": "../parameters/query.json#/search_type" + }, + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/profile" + }, + { + "$ref": "../parameters/query.json#/typed_keys" + }, + { + "$ref": "../parameters/query.json#/rest_total_hits_as_int" + }, + { + "$ref": "../parameters/query.json#/ccs_minimize_roundtrips" + } + ], + "requestBody": { + "description": "The search definition template and its params", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_search_shards.json b/openapi_spec/json/paths/_search_shards.json new file mode 100644 index 00000000..9dd5ebb9 --- /dev/null +++ b/openapi_spec/json/paths/_search_shards.json @@ -0,0 +1,50 @@ +{ + "get": { + "x-endpoint-group": "search_shards", + "description": "Returns information about the indices and shards that a search request would be executed against.", + "parameters": [ + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + }, + "post": { + "x-endpoint-group": "search_shards", + "description": "Returns information about the indices and shards that a search request would be executed against.", + "parameters": [ + { + "$ref": "../parameters/query.json#/preference" + }, + { + "$ref": "../parameters/query.json#/routing" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_segments.json b/openapi_spec/json/paths/_segments.json new file mode 100644 index 00000000..686da6ff --- /dev/null +++ b/openapi_spec/json/paths/_segments.json @@ -0,0 +1,20 @@ +{ + "get": { + "x-endpoint-group": "indices.segments", + "description": "Provides low-level information about segments in a Lucene index.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/verbose" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_settings.(name).json b/openapi_spec/json/paths/_settings.(name).json new file mode 100644 index 00000000..9ac9c0d8 --- /dev/null +++ b/openapi_spec/json/paths/_settings.(name).json @@ -0,0 +1,41 @@ +{ + "get": { + "x-endpoint-group": "indices.get_settings", + "description": "Returns settings for one or more indices.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the settings that should be included", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/include_defaults" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_settings.json b/openapi_spec/json/paths/_settings.json new file mode 100644 index 00000000..ebdde345 --- /dev/null +++ b/openapi_spec/json/paths/_settings.json @@ -0,0 +1,73 @@ +{ + "put": { + "x-endpoint-group": "indices.put_settings", + "description": "Updates the index settings.", + "parameters": [ + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/preserve_existing" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + } + ], + "requestBody": { + "description": "The index settings to be updated", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "get": { + "x-endpoint-group": "indices.get_settings", + "description": "Returns settings for one or more indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/local" + }, + { + "$ref": "../parameters/query.json#/include_defaults" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_shard_stores.json b/openapi_spec/json/paths/_shard_stores.json new file mode 100644 index 00000000..12b5519a --- /dev/null +++ b/openapi_spec/json/paths/_shard_stores.json @@ -0,0 +1,20 @@ +{ + "get": { + "x-endpoint-group": "indices.shard_stores", + "description": "Provides store information for shard copies of indices.", + "parameters": [ + { + "$ref": "../parameters/query.json#/status" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).json b/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).json new file mode 100644 index 00000000..a53f0306 --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).json @@ -0,0 +1,52 @@ +{ + "put": { + "x-endpoint-group": "snapshot.clone", + "description": "Clones indices from one snapshot into another snapshot in the same repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "snapshot", + "description": "The name of the snapshot to clone from", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "target_snapshot", + "description": "The name of the cloned snapshot to create", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The snapshot clone definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._restore.json b/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._restore.json new file mode 100644 index 00000000..439df89c --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._restore.json @@ -0,0 +1,46 @@ +{ + "post": { + "x-endpoint-group": "snapshot.restore", + "description": "Restores a snapshot.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "snapshot", + "description": "A snapshot name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + } + ], + "requestBody": { + "description": "Details of what to restore", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._status.json b/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._status.json new file mode 100644 index 00000000..4450a41c --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.(repository).(snapshot)._status.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "snapshot.status", + "description": "Returns information about the status of a snapshot.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "snapshot", + "description": "A comma-separated list of snapshot names", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.(repository).(snapshot).json b/openapi_spec/json/paths/_snapshot.(repository).(snapshot).json new file mode 100644 index 00000000..0fd0aac9 --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.(repository).(snapshot).json @@ -0,0 +1,156 @@ +{ + "put": { + "x-endpoint-group": "snapshot.create", + "description": "Creates a snapshot in a repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "snapshot", + "description": "A snapshot name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + } + ], + "requestBody": { + "description": "The snapshot definition", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "snapshot.create", + "description": "Creates a snapshot in a repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "snapshot", + "description": "A snapshot name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + } + ], + "requestBody": { + "description": "The snapshot definition", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "get": { + "x-endpoint-group": "snapshot.get", + "description": "Returns information about a snapshot.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "snapshot", + "description": "A comma-separated list of snapshot names", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/verbose" + } + ] + }, + "delete": { + "x-endpoint-group": "snapshot.delete", + "description": "Deletes a snapshot.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "snapshot", + "description": "A snapshot name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.(repository)._cleanup.json b/openapi_spec/json/paths/_snapshot.(repository)._cleanup.json new file mode 100644 index 00000000..1dfa6445 --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.(repository)._cleanup.json @@ -0,0 +1,26 @@ +{ + "post": { + "x-endpoint-group": "snapshot.cleanup_repository", + "description": "Removes stale data from repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.(repository)._status.json b/openapi_spec/json/paths/_snapshot.(repository)._status.json new file mode 100644 index 00000000..723230ac --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.(repository)._status.json @@ -0,0 +1,26 @@ +{ + "get": { + "x-endpoint-group": "snapshot.status", + "description": "Returns information about the status of a snapshot.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.(repository)._verify.json b/openapi_spec/json/paths/_snapshot.(repository)._verify.json new file mode 100644 index 00000000..352adddb --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.(repository)._verify.json @@ -0,0 +1,26 @@ +{ + "post": { + "x-endpoint-group": "snapshot.verify_repository", + "description": "Verifies a repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.(repository).json b/openapi_spec/json/paths/_snapshot.(repository).json new file mode 100644 index 00000000..e609e333 --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.(repository).json @@ -0,0 +1,126 @@ +{ + "get": { + "x-endpoint-group": "snapshot.get_repository", + "description": "Returns information about a repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A comma-separated list of repository names", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + }, + "put": { + "x-endpoint-group": "snapshot.create_repository", + "description": "Creates a repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/verify" + } + ], + "requestBody": { + "description": "The repository definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "snapshot.create_repository", + "description": "Creates a repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "A repository name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/verify" + } + ], + "requestBody": { + "description": "The repository definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "delete": { + "x-endpoint-group": "snapshot.delete_repository", + "description": "Deletes a repository.", + "parameters": [ + { + "in": "path", + "name": "repository", + "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot._status.json b/openapi_spec/json/paths/_snapshot._status.json new file mode 100644 index 00000000..dead97d6 --- /dev/null +++ b/openapi_spec/json/paths/_snapshot._status.json @@ -0,0 +1,17 @@ +{ + "get": { + "x-endpoint-group": "snapshot.status", + "description": "Returns information about the status of a snapshot.", + "parameters": [ + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_snapshot.json b/openapi_spec/json/paths/_snapshot.json new file mode 100644 index 00000000..116a4cfc --- /dev/null +++ b/openapi_spec/json/paths/_snapshot.json @@ -0,0 +1,17 @@ +{ + "get": { + "x-endpoint-group": "snapshot.get_repository", + "description": "Returns information about a repository.", + "parameters": [ + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_stats.(metric).json b/openapi_spec/json/paths/_stats.(metric).json new file mode 100644 index 00000000..dbce9114 --- /dev/null +++ b/openapi_spec/json/paths/_stats.(metric).json @@ -0,0 +1,44 @@ +{ + "get": { + "x-endpoint-group": "indices.stats", + "description": "Provides statistics on operations happening in an index.", + "parameters": [ + { + "in": "path", + "name": "metric", + "description": "Limit the information returned the specific metrics.", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + }, + { + "$ref": "../parameters/query.json#/include_unloaded_segments" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/forbid_closed_indices" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_stats.json b/openapi_spec/json/paths/_stats.json new file mode 100644 index 00000000..e0b9708f --- /dev/null +++ b/openapi_spec/json/paths/_stats.json @@ -0,0 +1,35 @@ +{ + "get": { + "x-endpoint-group": "indices.stats", + "description": "Provides statistics on operations happening in an index.", + "parameters": [ + { + "$ref": "../parameters/query.json#/completion_fields" + }, + { + "$ref": "../parameters/query.json#/fielddata_fields" + }, + { + "$ref": "../parameters/query.json#/fields" + }, + { + "$ref": "../parameters/query.json#/groups" + }, + { + "$ref": "../parameters/query.json#/level" + }, + { + "$ref": "../parameters/query.json#/include_segment_file_sizes" + }, + { + "$ref": "../parameters/query.json#/include_unloaded_segments" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/forbid_closed_indices" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_tasks.(task_id)._cancel.json b/openapi_spec/json/paths/_tasks.(task_id)._cancel.json new file mode 100644 index 00000000..5f220e62 --- /dev/null +++ b/openapi_spec/json/paths/_tasks.(task_id)._cancel.json @@ -0,0 +1,29 @@ +{ + "post": { + "x-endpoint-group": "tasks.cancel", + "description": "Cancels a task, if it can be cancelled through an API.", + "parameters": [ + { + "in": "path", + "name": "task_id", + "description": "Cancel the task with specified task id (node_id:task_number)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/nodes" + }, + { + "$ref": "../parameters/query.json#/actions" + }, + { + "$ref": "../parameters/query.json#/parent_task_id" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_tasks.(task_id).json b/openapi_spec/json/paths/_tasks.(task_id).json new file mode 100644 index 00000000..a0c2bd89 --- /dev/null +++ b/openapi_spec/json/paths/_tasks.(task_id).json @@ -0,0 +1,23 @@ +{ + "get": { + "x-endpoint-group": "tasks.get", + "description": "Returns information about a task.", + "parameters": [ + { + "in": "path", + "name": "task_id", + "description": "Return the task with specified id (node_id:task_number)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_tasks._cancel.json b/openapi_spec/json/paths/_tasks._cancel.json new file mode 100644 index 00000000..0465dd0a --- /dev/null +++ b/openapi_spec/json/paths/_tasks._cancel.json @@ -0,0 +1,20 @@ +{ + "post": { + "x-endpoint-group": "tasks.cancel", + "description": "Cancels a task, if it can be cancelled through an API.", + "parameters": [ + { + "$ref": "../parameters/query.json#/nodes" + }, + { + "$ref": "../parameters/query.json#/actions" + }, + { + "$ref": "../parameters/query.json#/parent_task_id" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_tasks.json b/openapi_spec/json/paths/_tasks.json new file mode 100644 index 00000000..c02a3d5b --- /dev/null +++ b/openapi_spec/json/paths/_tasks.json @@ -0,0 +1,29 @@ +{ + "get": { + "x-endpoint-group": "tasks.list", + "description": "Returns a list of tasks.", + "parameters": [ + { + "$ref": "../parameters/query.json#/nodes" + }, + { + "$ref": "../parameters/query.json#/actions" + }, + { + "$ref": "../parameters/query.json#/detailed" + }, + { + "$ref": "../parameters/query.json#/parent_task_id" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + }, + { + "$ref": "../parameters/query.json#/group_by" + }, + { + "$ref": "../parameters/query.json#/timeout" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_template.(name).json b/openapi_spec/json/paths/_template.(name).json new file mode 100644 index 00000000..57192c14 --- /dev/null +++ b/openapi_spec/json/paths/_template.(name).json @@ -0,0 +1,153 @@ +{ + "put": { + "x-endpoint-group": "indices.put_template", + "description": "Creates or updates an index template.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/order" + }, + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The template definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "post": { + "x-endpoint-group": "indices.put_template", + "description": "Creates or updates an index template.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/order" + }, + { + "$ref": "../parameters/query.json#/create" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ], + "requestBody": { + "description": "The template definition", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "get": { + "x-endpoint-group": "indices.get_template", + "description": "Returns an index template.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The comma separated names of the index templates", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + }, + "delete": { + "x-endpoint-group": "indices.delete_template", + "description": "Deletes an index template.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The name of the template", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/timeout" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + } + ] + }, + "head": { + "x-endpoint-group": "indices.exists_template", + "description": "Returns information about whether a particular index template exists.", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "The comma separated names of the index templates", + "required": true, + "schema": { + "$ref": "../schemas/_common.json#/string_array" + } + }, + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_template.json b/openapi_spec/json/paths/_template.json new file mode 100644 index 00000000..dee5f2be --- /dev/null +++ b/openapi_spec/json/paths/_template.json @@ -0,0 +1,20 @@ +{ + "get": { + "x-endpoint-group": "indices.get_template", + "description": "Returns an index template.", + "parameters": [ + { + "$ref": "../parameters/query.json#/flat_settings" + }, + { + "$ref": "../parameters/query.json#/master_timeout" + }, + { + "$ref": "../parameters/query.json#/cluster_manager_timeout" + }, + { + "$ref": "../parameters/query.json#/local" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_update_by_query.(task_id)._rethrottle.json b/openapi_spec/json/paths/_update_by_query.(task_id)._rethrottle.json new file mode 100644 index 00000000..19a18838 --- /dev/null +++ b/openapi_spec/json/paths/_update_by_query.(task_id)._rethrottle.json @@ -0,0 +1,20 @@ +{ + "post": { + "x-endpoint-group": "update_by_query_rethrottle", + "description": "Changes the number of requests per second for a particular Update By Query operation.", + "parameters": [ + { + "in": "path", + "name": "task_id", + "description": "The task id to rethrottle", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "../parameters/query.json#/requests_per_second" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_upgrade.json b/openapi_spec/json/paths/_upgrade.json new file mode 100644 index 00000000..beec2ba0 --- /dev/null +++ b/openapi_spec/json/paths/_upgrade.json @@ -0,0 +1,38 @@ +{ + "post": { + "x-endpoint-group": "indices.upgrade", + "description": "The _upgrade API is no longer useful and will be removed.", + "parameters": [ + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/wait_for_completion" + }, + { + "$ref": "../parameters/query.json#/only_ancient_segments" + } + ] + }, + "get": { + "x-endpoint-group": "indices.get_upgrade", + "description": "The _upgrade API is no longer useful and will be removed.", + "parameters": [ + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + } + ] + } +} \ No newline at end of file diff --git a/openapi_spec/json/paths/_validate.query.json b/openapi_spec/json/paths/_validate.query.json new file mode 100644 index 00000000..356e35cc --- /dev/null +++ b/openapi_spec/json/paths/_validate.query.json @@ -0,0 +1,97 @@ +{ + "get": { + "x-endpoint-group": "indices.validate_query", + "description": "Allows a user to validate a potentially expensive query without executing it.", + "parameters": [ + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/rewrite" + }, + { + "$ref": "../parameters/query.json#/all_shards" + } + ] + }, + "post": { + "x-endpoint-group": "indices.validate_query", + "description": "Allows a user to validate a potentially expensive query without executing it.", + "parameters": [ + { + "$ref": "../parameters/query.json#/explain" + }, + { + "$ref": "../parameters/query.json#/ignore_unavailable" + }, + { + "$ref": "../parameters/query.json#/allow_no_indices" + }, + { + "$ref": "../parameters/query.json#/expand_wildcards" + }, + { + "$ref": "../parameters/query.json#/q" + }, + { + "$ref": "../parameters/query.json#/analyzer" + }, + { + "$ref": "../parameters/query.json#/analyze_wildcard" + }, + { + "$ref": "../parameters/query.json#/default_operator" + }, + { + "$ref": "../parameters/query.json#/df" + }, + { + "$ref": "../parameters/query.json#/lenient" + }, + { + "$ref": "../parameters/query.json#/rewrite" + }, + { + "$ref": "../parameters/query.json#/all_shards" + } + ], + "requestBody": { + "description": "The query definition specified with the Query DSL", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } +} \ No newline at end of file diff --git a/openapi_spec/json/schemas/_common.json b/openapi_spec/json/schemas/_common.json new file mode 100644 index 00000000..1a92014f --- /dev/null +++ b/openapi_spec/json/schemas/_common.json @@ -0,0 +1,13 @@ +{ + "time": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" + }, + "string_array": { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } +} \ No newline at end of file diff --git a/openapi_spec/opensearch.openapi.yaml b/openapi_spec/opensearch.openapi.yaml new file mode 100644 index 00000000..f80cb92d --- /dev/null +++ b/openapi_spec/opensearch.openapi.yaml @@ -0,0 +1,422 @@ +--- +openapi: 3.1.0 +info: + title: OpenSearch + version: '2.5' +paths: + "/": + $ref: "./paths/_.yaml" + "/_alias": + $ref: "./paths/_alias.yaml" + "/_alias/{name}": + $ref: "./paths/_alias.(name).yaml" + "/_aliases": + $ref: "./paths/_aliases.yaml" + "/_analyze": + $ref: "./paths/_analyze.yaml" + "/_bulk": + $ref: "./paths/_bulk.yaml" + "/_cache/clear": + $ref: "./paths/_cache.clear.yaml" + "/_cat": + $ref: "./paths/_cat.yaml" + "/_cat/aliases": + $ref: "./paths/_cat.aliases.yaml" + "/_cat/aliases/{name}": + $ref: "./paths/_cat.aliases.(name).yaml" + "/_cat/allocation": + $ref: "./paths/_cat.allocation.yaml" + "/_cat/allocation/{node_id}": + $ref: "./paths/_cat.allocation.(node_id).yaml" + "/_cat/cluster_manager": + $ref: "./paths/_cat.cluster_manager.yaml" + "/_cat/count": + $ref: "./paths/_cat.count.yaml" + "/_cat/count/{index}": + $ref: "./paths/_cat.count.(index).yaml" + "/_cat/fielddata": + $ref: "./paths/_cat.fielddata.yaml" + "/_cat/fielddata/{fields}": + $ref: "./paths/_cat.fielddata.(fields).yaml" + "/_cat/health": + $ref: "./paths/_cat.health.yaml" + "/_cat/indices": + $ref: "./paths/_cat.indices.yaml" + "/_cat/indices/{index}": + $ref: "./paths/_cat.indices.(index).yaml" + "/_cat/master": + $ref: "./paths/_cat.master.yaml" + "/_cat/nodeattrs": + $ref: "./paths/_cat.nodeattrs.yaml" + "/_cat/nodes": + $ref: "./paths/_cat.nodes.yaml" + "/_cat/pending_tasks": + $ref: "./paths/_cat.pending_tasks.yaml" + "/_cat/plugins": + $ref: "./paths/_cat.plugins.yaml" + "/_cat/recovery": + $ref: "./paths/_cat.recovery.yaml" + "/_cat/recovery/{index}": + $ref: "./paths/_cat.recovery.(index).yaml" + "/_cat/repositories": + $ref: "./paths/_cat.repositories.yaml" + "/_cat/segment_replication": + $ref: "./paths/_cat.segment_replication.yaml" + "/_cat/segment_replication/{index}": + $ref: "./paths/_cat.segment_replication.(index).yaml" + "/_cat/segments": + $ref: "./paths/_cat.segments.yaml" + "/_cat/segments/{index}": + $ref: "./paths/_cat.segments.(index).yaml" + "/_cat/shards": + $ref: "./paths/_cat.shards.yaml" + "/_cat/shards/{index}": + $ref: "./paths/_cat.shards.(index).yaml" + "/_cat/snapshots": + $ref: "./paths/_cat.snapshots.yaml" + "/_cat/snapshots/{repository}": + $ref: "./paths/_cat.snapshots.(repository).yaml" + "/_cat/tasks": + $ref: "./paths/_cat.tasks.yaml" + "/_cat/templates": + $ref: "./paths/_cat.templates.yaml" + "/_cat/templates/{name}": + $ref: "./paths/_cat.templates.(name).yaml" + "/_cat/thread_pool": + $ref: "./paths/_cat.thread_pool.yaml" + "/_cat/thread_pool/{thread_pool_patterns}": + $ref: "./paths/_cat.thread_pool.(thread_pool_patterns).yaml" + "/_cluster/allocation/explain": + $ref: "./paths/_cluster.allocation.explain.yaml" + "/_cluster/decommission/awareness/": + $ref: "./paths/_cluster.decommission.awareness..yaml" + "/_cluster/decommission/awareness/{awareness_attribute_name}/_status": + $ref: "./paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.yaml" + "/_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}": + $ref: "./paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).yaml" + "/_cluster/health": + $ref: "./paths/_cluster.health.yaml" + "/_cluster/health/{index}": + $ref: "./paths/_cluster.health.(index).yaml" + "/_cluster/nodes/hot_threads": + $ref: "./paths/_cluster.nodes.hot_threads.yaml" + "/_cluster/nodes/hotthreads": + $ref: "./paths/_cluster.nodes.hotthreads.yaml" + "/_cluster/nodes/{node_id}/hot_threads": + $ref: "./paths/_cluster.nodes.(node_id).hot_threads.yaml" + "/_cluster/nodes/{node_id}/hotthreads": + $ref: "./paths/_cluster.nodes.(node_id).hotthreads.yaml" + "/_cluster/pending_tasks": + $ref: "./paths/_cluster.pending_tasks.yaml" + "/_cluster/reroute": + $ref: "./paths/_cluster.reroute.yaml" + "/_cluster/routing/awareness/weights": + $ref: "./paths/_cluster.routing.awareness.weights.yaml" + "/_cluster/routing/awareness/{attribute}/weights": + $ref: "./paths/_cluster.routing.awareness.(attribute).weights.yaml" + "/_cluster/settings": + $ref: "./paths/_cluster.settings.yaml" + "/_cluster/state": + $ref: "./paths/_cluster.state.yaml" + "/_cluster/state/{metric}": + $ref: "./paths/_cluster.state.(metric).yaml" + "/_cluster/state/{metric}/{index}": + $ref: "./paths/_cluster.state.(metric).(index).yaml" + "/_cluster/stats": + $ref: "./paths/_cluster.stats.yaml" + "/_cluster/stats/nodes/{node_id}": + $ref: "./paths/_cluster.stats.nodes.(node_id).yaml" + "/_cluster/voting_config_exclusions": + $ref: "./paths/_cluster.voting_config_exclusions.yaml" + "/_component_template": + $ref: "./paths/_component_template.yaml" + "/_component_template/{name}": + $ref: "./paths/_component_template.(name).yaml" + "/_count": + $ref: "./paths/_count.yaml" + "/_dangling": + $ref: "./paths/_dangling.yaml" + "/_dangling/{index_uuid}": + $ref: "./paths/_dangling.(index_uuid).yaml" + "/_data_stream": + $ref: "./paths/_data_stream.yaml" + "/_data_stream/_stats": + $ref: "./paths/_data_stream._stats.yaml" + "/_data_stream/{name}": + $ref: "./paths/_data_stream.(name).yaml" + "/_data_stream/{name}/_stats": + $ref: "./paths/_data_stream.(name)._stats.yaml" + "/_delete_by_query/{task_id}/_rethrottle": + $ref: "./paths/_delete_by_query.(task_id)._rethrottle.yaml" + "/_field_caps": + $ref: "./paths/_field_caps.yaml" + "/_flush": + $ref: "./paths/_flush.yaml" + "/_forcemerge": + $ref: "./paths/_forcemerge.yaml" + "/_index_template": + $ref: "./paths/_index_template.yaml" + "/_index_template/_simulate": + $ref: "./paths/_index_template._simulate.yaml" + "/_index_template/_simulate/{name}": + $ref: "./paths/_index_template._simulate.(name).yaml" + "/_index_template/_simulate_index/{name}": + $ref: "./paths/_index_template._simulate_index.(name).yaml" + "/_index_template/{name}": + $ref: "./paths/_index_template.(name).yaml" + "/_ingest/pipeline": + $ref: "./paths/_ingest.pipeline.yaml" + "/_ingest/pipeline/_simulate": + $ref: "./paths/_ingest.pipeline._simulate.yaml" + "/_ingest/pipeline/{id}": + $ref: "./paths/_ingest.pipeline.(id).yaml" + "/_ingest/pipeline/{id}/_simulate": + $ref: "./paths/_ingest.pipeline.(id)._simulate.yaml" + "/_ingest/processor/grok": + $ref: "./paths/_ingest.processor.grok.yaml" + "/_mapping": + $ref: "./paths/_mapping.yaml" + "/_mapping/field/{fields}": + $ref: "./paths/_mapping.field.(fields).yaml" + "/_mget": + $ref: "./paths/_mget.yaml" + "/_msearch": + $ref: "./paths/_msearch.yaml" + "/_msearch/template": + $ref: "./paths/_msearch.template.yaml" + "/_mtermvectors": + $ref: "./paths/_mtermvectors.yaml" + "/_nodes": + $ref: "./paths/_nodes.yaml" + "/_nodes/hot_threads": + $ref: "./paths/_nodes.hot_threads.yaml" + "/_nodes/hotthreads": + $ref: "./paths/_nodes.hotthreads.yaml" + "/_nodes/reload_secure_settings": + $ref: "./paths/_nodes.reload_secure_settings.yaml" + "/_nodes/stats": + $ref: "./paths/_nodes.stats.yaml" + "/_nodes/stats/{metric}": + $ref: "./paths/_nodes.stats.(metric).yaml" + "/_nodes/stats/{metric}/{index_metric}": + $ref: "./paths/_nodes.stats.(metric).(index_metric).yaml" + "/_nodes/usage": + $ref: "./paths/_nodes.usage.yaml" + "/_nodes/usage/{metric}": + $ref: "./paths/_nodes.usage.(metric).yaml" + "/_nodes/{metric}": + $ref: "./paths/_nodes.(metric).yaml" + "/_nodes/{node_id}": + $ref: "./paths/_nodes.(node_id).yaml" + "/_nodes/{node_id}/hot_threads": + $ref: "./paths/_nodes.(node_id).hot_threads.yaml" + "/_nodes/{node_id}/hotthreads": + $ref: "./paths/_nodes.(node_id).hotthreads.yaml" + "/_nodes/{node_id}/reload_secure_settings": + $ref: "./paths/_nodes.(node_id).reload_secure_settings.yaml" + "/_nodes/{node_id}/stats": + $ref: "./paths/_nodes.(node_id).stats.yaml" + "/_nodes/{node_id}/stats/{metric}": + $ref: "./paths/_nodes.(node_id).stats.(metric).yaml" + "/_nodes/{node_id}/stats/{metric}/{index_metric}": + $ref: "./paths/_nodes.(node_id).stats.(metric).(index_metric).yaml" + "/_nodes/{node_id}/usage": + $ref: "./paths/_nodes.(node_id).usage.yaml" + "/_nodes/{node_id}/usage/{metric}": + $ref: "./paths/_nodes.(node_id).usage.(metric).yaml" + "/_nodes/{node_id}/{metric}": + $ref: "./paths/_nodes.(node_id).(metric).yaml" + "/_rank_eval": + $ref: "./paths/_rank_eval.yaml" + "/_recovery": + $ref: "./paths/_recovery.yaml" + "/_refresh": + $ref: "./paths/_refresh.yaml" + "/_reindex": + $ref: "./paths/_reindex.yaml" + "/_reindex/{task_id}/_rethrottle": + $ref: "./paths/_reindex.(task_id)._rethrottle.yaml" + "/_remote/info": + $ref: "./paths/_remote.info.yaml" + "/_remotestore/_restore": + $ref: "./paths/_remotestore._restore.yaml" + "/_render/template": + $ref: "./paths/_render.template.yaml" + "/_render/template/{id}": + $ref: "./paths/_render.template.(id).yaml" + "/_resolve/index/{name}": + $ref: "./paths/_resolve.index.(name).yaml" + "/_script_context": + $ref: "./paths/_script_context.yaml" + "/_script_language": + $ref: "./paths/_script_language.yaml" + "/_scripts/painless/_execute": + $ref: "./paths/_scripts.painless._execute.yaml" + "/_scripts/{id}": + $ref: "./paths/_scripts.(id).yaml" + "/_scripts/{id}/{context}": + $ref: "./paths/_scripts.(id).(context).yaml" + "/_search": + $ref: "./paths/_search.yaml" + "/_search/point_in_time": + $ref: "./paths/_search.point_in_time.yaml" + "/_search/point_in_time/_all": + $ref: "./paths/_search.point_in_time._all.yaml" + "/_search/scroll": + $ref: "./paths/_search.scroll.yaml" + "/_search/scroll/{scroll_id}": + $ref: "./paths/_search.scroll.(scroll_id).yaml" + "/_search/template": + $ref: "./paths/_search.template.yaml" + "/_search_shards": + $ref: "./paths/_search_shards.yaml" + "/_segments": + $ref: "./paths/_segments.yaml" + "/_settings": + $ref: "./paths/_settings.yaml" + "/_settings/{name}": + $ref: "./paths/_settings.(name).yaml" + "/_shard_stores": + $ref: "./paths/_shard_stores.yaml" + "/_snapshot": + $ref: "./paths/_snapshot.yaml" + "/_snapshot/_status": + $ref: "./paths/_snapshot._status.yaml" + "/_snapshot/{repository}": + $ref: "./paths/_snapshot.(repository).yaml" + "/_snapshot/{repository}/_cleanup": + $ref: "./paths/_snapshot.(repository)._cleanup.yaml" + "/_snapshot/{repository}/_status": + $ref: "./paths/_snapshot.(repository)._status.yaml" + "/_snapshot/{repository}/_verify": + $ref: "./paths/_snapshot.(repository)._verify.yaml" + "/_snapshot/{repository}/{snapshot}": + $ref: "./paths/_snapshot.(repository).(snapshot).yaml" + "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}": + $ref: "./paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).yaml" + "/_snapshot/{repository}/{snapshot}/_restore": + $ref: "./paths/_snapshot.(repository).(snapshot)._restore.yaml" + "/_snapshot/{repository}/{snapshot}/_status": + $ref: "./paths/_snapshot.(repository).(snapshot)._status.yaml" + "/_stats": + $ref: "./paths/_stats.yaml" + "/_stats/{metric}": + $ref: "./paths/_stats.(metric).yaml" + "/_tasks": + $ref: "./paths/_tasks.yaml" + "/_tasks/_cancel": + $ref: "./paths/_tasks._cancel.yaml" + "/_tasks/{task_id}": + $ref: "./paths/_tasks.(task_id).yaml" + "/_tasks/{task_id}/_cancel": + $ref: "./paths/_tasks.(task_id)._cancel.yaml" + "/_template": + $ref: "./paths/_template.yaml" + "/_template/{name}": + $ref: "./paths/_template.(name).yaml" + "/_update_by_query/{task_id}/_rethrottle": + $ref: "./paths/_update_by_query.(task_id)._rethrottle.yaml" + "/_upgrade": + $ref: "./paths/_upgrade.yaml" + "/_validate/query": + $ref: "./paths/_validate.query.yaml" + "/{alias}/_rollover": + $ref: "./paths/(alias)._rollover.yaml" + "/{alias}/_rollover/{new_index}": + $ref: "./paths/(alias)._rollover.(new_index).yaml" + "/{index}": + $ref: "./paths/(index).yaml" + "/{index}/_alias": + $ref: "./paths/(index)._alias.yaml" + "/{index}/_alias/{name}": + $ref: "./paths/(index)._alias.(name).yaml" + "/{index}/_aliases/{name}": + $ref: "./paths/(index)._aliases.(name).yaml" + "/{index}/_analyze": + $ref: "./paths/(index)._analyze.yaml" + "/{index}/_block/{block}": + $ref: "./paths/(index)._block.(block).yaml" + "/{index}/_bulk": + $ref: "./paths/(index)._bulk.yaml" + "/{index}/_cache/clear": + $ref: "./paths/(index)._cache.clear.yaml" + "/{index}/_clone/{target}": + $ref: "./paths/(index)._clone.(target).yaml" + "/{index}/_close": + $ref: "./paths/(index)._close.yaml" + "/{index}/_count": + $ref: "./paths/(index)._count.yaml" + "/{index}/_create/{id}": + $ref: "./paths/(index)._create.(id).yaml" + "/{index}/_delete_by_query": + $ref: "./paths/(index)._delete_by_query.yaml" + "/{index}/_doc": + $ref: "./paths/(index)._doc.yaml" + "/{index}/_doc/{id}": + $ref: "./paths/(index)._doc.(id).yaml" + "/{index}/_explain/{id}": + $ref: "./paths/(index)._explain.(id).yaml" + "/{index}/_field_caps": + $ref: "./paths/(index)._field_caps.yaml" + "/{index}/_flush": + $ref: "./paths/(index)._flush.yaml" + "/{index}/_forcemerge": + $ref: "./paths/(index)._forcemerge.yaml" + "/{index}/_mapping": + $ref: "./paths/(index)._mapping.yaml" + "/{index}/_mapping/field/{fields}": + $ref: "./paths/(index)._mapping.field.(fields).yaml" + "/{index}/_mget": + $ref: "./paths/(index)._mget.yaml" + "/{index}/_msearch": + $ref: "./paths/(index)._msearch.yaml" + "/{index}/_msearch/template": + $ref: "./paths/(index)._msearch.template.yaml" + "/{index}/_mtermvectors": + $ref: "./paths/(index)._mtermvectors.yaml" + "/{index}/_open": + $ref: "./paths/(index)._open.yaml" + "/{index}/_rank_eval": + $ref: "./paths/(index)._rank_eval.yaml" + "/{index}/_recovery": + $ref: "./paths/(index)._recovery.yaml" + "/{index}/_refresh": + $ref: "./paths/(index)._refresh.yaml" + "/{index}/_search": + $ref: "./paths/(index)._search.yaml" + "/{index}/_search/point_in_time": + $ref: "./paths/(index)._search.point_in_time.yaml" + "/{index}/_search/template": + $ref: "./paths/(index)._search.template.yaml" + "/{index}/_search_shards": + $ref: "./paths/(index)._search_shards.yaml" + "/{index}/_segments": + $ref: "./paths/(index)._segments.yaml" + "/{index}/_settings": + $ref: "./paths/(index)._settings.yaml" + "/{index}/_settings/{name}": + $ref: "./paths/(index)._settings.(name).yaml" + "/{index}/_shard_stores": + $ref: "./paths/(index)._shard_stores.yaml" + "/{index}/_shrink/{target}": + $ref: "./paths/(index)._shrink.(target).yaml" + "/{index}/_source/{id}": + $ref: "./paths/(index)._source.(id).yaml" + "/{index}/_split/{target}": + $ref: "./paths/(index)._split.(target).yaml" + "/{index}/_stats": + $ref: "./paths/(index)._stats.yaml" + "/{index}/_stats/{metric}": + $ref: "./paths/(index)._stats.(metric).yaml" + "/{index}/_termvectors": + $ref: "./paths/(index)._termvectors.yaml" + "/{index}/_termvectors/{id}": + $ref: "./paths/(index)._termvectors.(id).yaml" + "/{index}/_update/{id}": + $ref: "./paths/(index)._update.(id).yaml" + "/{index}/_update_by_query": + $ref: "./paths/(index)._update_by_query.yaml" + "/{index}/_upgrade": + $ref: "./paths/(index)._upgrade.yaml" + "/{index}/_validate/query": + $ref: "./paths/(index)._validate.query.yaml" diff --git a/openapi_spec/yaml/opensearch.openapi.yaml b/openapi_spec/yaml/opensearch.openapi.yaml new file mode 100644 index 00000000..f80cb92d --- /dev/null +++ b/openapi_spec/yaml/opensearch.openapi.yaml @@ -0,0 +1,422 @@ +--- +openapi: 3.1.0 +info: + title: OpenSearch + version: '2.5' +paths: + "/": + $ref: "./paths/_.yaml" + "/_alias": + $ref: "./paths/_alias.yaml" + "/_alias/{name}": + $ref: "./paths/_alias.(name).yaml" + "/_aliases": + $ref: "./paths/_aliases.yaml" + "/_analyze": + $ref: "./paths/_analyze.yaml" + "/_bulk": + $ref: "./paths/_bulk.yaml" + "/_cache/clear": + $ref: "./paths/_cache.clear.yaml" + "/_cat": + $ref: "./paths/_cat.yaml" + "/_cat/aliases": + $ref: "./paths/_cat.aliases.yaml" + "/_cat/aliases/{name}": + $ref: "./paths/_cat.aliases.(name).yaml" + "/_cat/allocation": + $ref: "./paths/_cat.allocation.yaml" + "/_cat/allocation/{node_id}": + $ref: "./paths/_cat.allocation.(node_id).yaml" + "/_cat/cluster_manager": + $ref: "./paths/_cat.cluster_manager.yaml" + "/_cat/count": + $ref: "./paths/_cat.count.yaml" + "/_cat/count/{index}": + $ref: "./paths/_cat.count.(index).yaml" + "/_cat/fielddata": + $ref: "./paths/_cat.fielddata.yaml" + "/_cat/fielddata/{fields}": + $ref: "./paths/_cat.fielddata.(fields).yaml" + "/_cat/health": + $ref: "./paths/_cat.health.yaml" + "/_cat/indices": + $ref: "./paths/_cat.indices.yaml" + "/_cat/indices/{index}": + $ref: "./paths/_cat.indices.(index).yaml" + "/_cat/master": + $ref: "./paths/_cat.master.yaml" + "/_cat/nodeattrs": + $ref: "./paths/_cat.nodeattrs.yaml" + "/_cat/nodes": + $ref: "./paths/_cat.nodes.yaml" + "/_cat/pending_tasks": + $ref: "./paths/_cat.pending_tasks.yaml" + "/_cat/plugins": + $ref: "./paths/_cat.plugins.yaml" + "/_cat/recovery": + $ref: "./paths/_cat.recovery.yaml" + "/_cat/recovery/{index}": + $ref: "./paths/_cat.recovery.(index).yaml" + "/_cat/repositories": + $ref: "./paths/_cat.repositories.yaml" + "/_cat/segment_replication": + $ref: "./paths/_cat.segment_replication.yaml" + "/_cat/segment_replication/{index}": + $ref: "./paths/_cat.segment_replication.(index).yaml" + "/_cat/segments": + $ref: "./paths/_cat.segments.yaml" + "/_cat/segments/{index}": + $ref: "./paths/_cat.segments.(index).yaml" + "/_cat/shards": + $ref: "./paths/_cat.shards.yaml" + "/_cat/shards/{index}": + $ref: "./paths/_cat.shards.(index).yaml" + "/_cat/snapshots": + $ref: "./paths/_cat.snapshots.yaml" + "/_cat/snapshots/{repository}": + $ref: "./paths/_cat.snapshots.(repository).yaml" + "/_cat/tasks": + $ref: "./paths/_cat.tasks.yaml" + "/_cat/templates": + $ref: "./paths/_cat.templates.yaml" + "/_cat/templates/{name}": + $ref: "./paths/_cat.templates.(name).yaml" + "/_cat/thread_pool": + $ref: "./paths/_cat.thread_pool.yaml" + "/_cat/thread_pool/{thread_pool_patterns}": + $ref: "./paths/_cat.thread_pool.(thread_pool_patterns).yaml" + "/_cluster/allocation/explain": + $ref: "./paths/_cluster.allocation.explain.yaml" + "/_cluster/decommission/awareness/": + $ref: "./paths/_cluster.decommission.awareness..yaml" + "/_cluster/decommission/awareness/{awareness_attribute_name}/_status": + $ref: "./paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.yaml" + "/_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}": + $ref: "./paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).yaml" + "/_cluster/health": + $ref: "./paths/_cluster.health.yaml" + "/_cluster/health/{index}": + $ref: "./paths/_cluster.health.(index).yaml" + "/_cluster/nodes/hot_threads": + $ref: "./paths/_cluster.nodes.hot_threads.yaml" + "/_cluster/nodes/hotthreads": + $ref: "./paths/_cluster.nodes.hotthreads.yaml" + "/_cluster/nodes/{node_id}/hot_threads": + $ref: "./paths/_cluster.nodes.(node_id).hot_threads.yaml" + "/_cluster/nodes/{node_id}/hotthreads": + $ref: "./paths/_cluster.nodes.(node_id).hotthreads.yaml" + "/_cluster/pending_tasks": + $ref: "./paths/_cluster.pending_tasks.yaml" + "/_cluster/reroute": + $ref: "./paths/_cluster.reroute.yaml" + "/_cluster/routing/awareness/weights": + $ref: "./paths/_cluster.routing.awareness.weights.yaml" + "/_cluster/routing/awareness/{attribute}/weights": + $ref: "./paths/_cluster.routing.awareness.(attribute).weights.yaml" + "/_cluster/settings": + $ref: "./paths/_cluster.settings.yaml" + "/_cluster/state": + $ref: "./paths/_cluster.state.yaml" + "/_cluster/state/{metric}": + $ref: "./paths/_cluster.state.(metric).yaml" + "/_cluster/state/{metric}/{index}": + $ref: "./paths/_cluster.state.(metric).(index).yaml" + "/_cluster/stats": + $ref: "./paths/_cluster.stats.yaml" + "/_cluster/stats/nodes/{node_id}": + $ref: "./paths/_cluster.stats.nodes.(node_id).yaml" + "/_cluster/voting_config_exclusions": + $ref: "./paths/_cluster.voting_config_exclusions.yaml" + "/_component_template": + $ref: "./paths/_component_template.yaml" + "/_component_template/{name}": + $ref: "./paths/_component_template.(name).yaml" + "/_count": + $ref: "./paths/_count.yaml" + "/_dangling": + $ref: "./paths/_dangling.yaml" + "/_dangling/{index_uuid}": + $ref: "./paths/_dangling.(index_uuid).yaml" + "/_data_stream": + $ref: "./paths/_data_stream.yaml" + "/_data_stream/_stats": + $ref: "./paths/_data_stream._stats.yaml" + "/_data_stream/{name}": + $ref: "./paths/_data_stream.(name).yaml" + "/_data_stream/{name}/_stats": + $ref: "./paths/_data_stream.(name)._stats.yaml" + "/_delete_by_query/{task_id}/_rethrottle": + $ref: "./paths/_delete_by_query.(task_id)._rethrottle.yaml" + "/_field_caps": + $ref: "./paths/_field_caps.yaml" + "/_flush": + $ref: "./paths/_flush.yaml" + "/_forcemerge": + $ref: "./paths/_forcemerge.yaml" + "/_index_template": + $ref: "./paths/_index_template.yaml" + "/_index_template/_simulate": + $ref: "./paths/_index_template._simulate.yaml" + "/_index_template/_simulate/{name}": + $ref: "./paths/_index_template._simulate.(name).yaml" + "/_index_template/_simulate_index/{name}": + $ref: "./paths/_index_template._simulate_index.(name).yaml" + "/_index_template/{name}": + $ref: "./paths/_index_template.(name).yaml" + "/_ingest/pipeline": + $ref: "./paths/_ingest.pipeline.yaml" + "/_ingest/pipeline/_simulate": + $ref: "./paths/_ingest.pipeline._simulate.yaml" + "/_ingest/pipeline/{id}": + $ref: "./paths/_ingest.pipeline.(id).yaml" + "/_ingest/pipeline/{id}/_simulate": + $ref: "./paths/_ingest.pipeline.(id)._simulate.yaml" + "/_ingest/processor/grok": + $ref: "./paths/_ingest.processor.grok.yaml" + "/_mapping": + $ref: "./paths/_mapping.yaml" + "/_mapping/field/{fields}": + $ref: "./paths/_mapping.field.(fields).yaml" + "/_mget": + $ref: "./paths/_mget.yaml" + "/_msearch": + $ref: "./paths/_msearch.yaml" + "/_msearch/template": + $ref: "./paths/_msearch.template.yaml" + "/_mtermvectors": + $ref: "./paths/_mtermvectors.yaml" + "/_nodes": + $ref: "./paths/_nodes.yaml" + "/_nodes/hot_threads": + $ref: "./paths/_nodes.hot_threads.yaml" + "/_nodes/hotthreads": + $ref: "./paths/_nodes.hotthreads.yaml" + "/_nodes/reload_secure_settings": + $ref: "./paths/_nodes.reload_secure_settings.yaml" + "/_nodes/stats": + $ref: "./paths/_nodes.stats.yaml" + "/_nodes/stats/{metric}": + $ref: "./paths/_nodes.stats.(metric).yaml" + "/_nodes/stats/{metric}/{index_metric}": + $ref: "./paths/_nodes.stats.(metric).(index_metric).yaml" + "/_nodes/usage": + $ref: "./paths/_nodes.usage.yaml" + "/_nodes/usage/{metric}": + $ref: "./paths/_nodes.usage.(metric).yaml" + "/_nodes/{metric}": + $ref: "./paths/_nodes.(metric).yaml" + "/_nodes/{node_id}": + $ref: "./paths/_nodes.(node_id).yaml" + "/_nodes/{node_id}/hot_threads": + $ref: "./paths/_nodes.(node_id).hot_threads.yaml" + "/_nodes/{node_id}/hotthreads": + $ref: "./paths/_nodes.(node_id).hotthreads.yaml" + "/_nodes/{node_id}/reload_secure_settings": + $ref: "./paths/_nodes.(node_id).reload_secure_settings.yaml" + "/_nodes/{node_id}/stats": + $ref: "./paths/_nodes.(node_id).stats.yaml" + "/_nodes/{node_id}/stats/{metric}": + $ref: "./paths/_nodes.(node_id).stats.(metric).yaml" + "/_nodes/{node_id}/stats/{metric}/{index_metric}": + $ref: "./paths/_nodes.(node_id).stats.(metric).(index_metric).yaml" + "/_nodes/{node_id}/usage": + $ref: "./paths/_nodes.(node_id).usage.yaml" + "/_nodes/{node_id}/usage/{metric}": + $ref: "./paths/_nodes.(node_id).usage.(metric).yaml" + "/_nodes/{node_id}/{metric}": + $ref: "./paths/_nodes.(node_id).(metric).yaml" + "/_rank_eval": + $ref: "./paths/_rank_eval.yaml" + "/_recovery": + $ref: "./paths/_recovery.yaml" + "/_refresh": + $ref: "./paths/_refresh.yaml" + "/_reindex": + $ref: "./paths/_reindex.yaml" + "/_reindex/{task_id}/_rethrottle": + $ref: "./paths/_reindex.(task_id)._rethrottle.yaml" + "/_remote/info": + $ref: "./paths/_remote.info.yaml" + "/_remotestore/_restore": + $ref: "./paths/_remotestore._restore.yaml" + "/_render/template": + $ref: "./paths/_render.template.yaml" + "/_render/template/{id}": + $ref: "./paths/_render.template.(id).yaml" + "/_resolve/index/{name}": + $ref: "./paths/_resolve.index.(name).yaml" + "/_script_context": + $ref: "./paths/_script_context.yaml" + "/_script_language": + $ref: "./paths/_script_language.yaml" + "/_scripts/painless/_execute": + $ref: "./paths/_scripts.painless._execute.yaml" + "/_scripts/{id}": + $ref: "./paths/_scripts.(id).yaml" + "/_scripts/{id}/{context}": + $ref: "./paths/_scripts.(id).(context).yaml" + "/_search": + $ref: "./paths/_search.yaml" + "/_search/point_in_time": + $ref: "./paths/_search.point_in_time.yaml" + "/_search/point_in_time/_all": + $ref: "./paths/_search.point_in_time._all.yaml" + "/_search/scroll": + $ref: "./paths/_search.scroll.yaml" + "/_search/scroll/{scroll_id}": + $ref: "./paths/_search.scroll.(scroll_id).yaml" + "/_search/template": + $ref: "./paths/_search.template.yaml" + "/_search_shards": + $ref: "./paths/_search_shards.yaml" + "/_segments": + $ref: "./paths/_segments.yaml" + "/_settings": + $ref: "./paths/_settings.yaml" + "/_settings/{name}": + $ref: "./paths/_settings.(name).yaml" + "/_shard_stores": + $ref: "./paths/_shard_stores.yaml" + "/_snapshot": + $ref: "./paths/_snapshot.yaml" + "/_snapshot/_status": + $ref: "./paths/_snapshot._status.yaml" + "/_snapshot/{repository}": + $ref: "./paths/_snapshot.(repository).yaml" + "/_snapshot/{repository}/_cleanup": + $ref: "./paths/_snapshot.(repository)._cleanup.yaml" + "/_snapshot/{repository}/_status": + $ref: "./paths/_snapshot.(repository)._status.yaml" + "/_snapshot/{repository}/_verify": + $ref: "./paths/_snapshot.(repository)._verify.yaml" + "/_snapshot/{repository}/{snapshot}": + $ref: "./paths/_snapshot.(repository).(snapshot).yaml" + "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}": + $ref: "./paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).yaml" + "/_snapshot/{repository}/{snapshot}/_restore": + $ref: "./paths/_snapshot.(repository).(snapshot)._restore.yaml" + "/_snapshot/{repository}/{snapshot}/_status": + $ref: "./paths/_snapshot.(repository).(snapshot)._status.yaml" + "/_stats": + $ref: "./paths/_stats.yaml" + "/_stats/{metric}": + $ref: "./paths/_stats.(metric).yaml" + "/_tasks": + $ref: "./paths/_tasks.yaml" + "/_tasks/_cancel": + $ref: "./paths/_tasks._cancel.yaml" + "/_tasks/{task_id}": + $ref: "./paths/_tasks.(task_id).yaml" + "/_tasks/{task_id}/_cancel": + $ref: "./paths/_tasks.(task_id)._cancel.yaml" + "/_template": + $ref: "./paths/_template.yaml" + "/_template/{name}": + $ref: "./paths/_template.(name).yaml" + "/_update_by_query/{task_id}/_rethrottle": + $ref: "./paths/_update_by_query.(task_id)._rethrottle.yaml" + "/_upgrade": + $ref: "./paths/_upgrade.yaml" + "/_validate/query": + $ref: "./paths/_validate.query.yaml" + "/{alias}/_rollover": + $ref: "./paths/(alias)._rollover.yaml" + "/{alias}/_rollover/{new_index}": + $ref: "./paths/(alias)._rollover.(new_index).yaml" + "/{index}": + $ref: "./paths/(index).yaml" + "/{index}/_alias": + $ref: "./paths/(index)._alias.yaml" + "/{index}/_alias/{name}": + $ref: "./paths/(index)._alias.(name).yaml" + "/{index}/_aliases/{name}": + $ref: "./paths/(index)._aliases.(name).yaml" + "/{index}/_analyze": + $ref: "./paths/(index)._analyze.yaml" + "/{index}/_block/{block}": + $ref: "./paths/(index)._block.(block).yaml" + "/{index}/_bulk": + $ref: "./paths/(index)._bulk.yaml" + "/{index}/_cache/clear": + $ref: "./paths/(index)._cache.clear.yaml" + "/{index}/_clone/{target}": + $ref: "./paths/(index)._clone.(target).yaml" + "/{index}/_close": + $ref: "./paths/(index)._close.yaml" + "/{index}/_count": + $ref: "./paths/(index)._count.yaml" + "/{index}/_create/{id}": + $ref: "./paths/(index)._create.(id).yaml" + "/{index}/_delete_by_query": + $ref: "./paths/(index)._delete_by_query.yaml" + "/{index}/_doc": + $ref: "./paths/(index)._doc.yaml" + "/{index}/_doc/{id}": + $ref: "./paths/(index)._doc.(id).yaml" + "/{index}/_explain/{id}": + $ref: "./paths/(index)._explain.(id).yaml" + "/{index}/_field_caps": + $ref: "./paths/(index)._field_caps.yaml" + "/{index}/_flush": + $ref: "./paths/(index)._flush.yaml" + "/{index}/_forcemerge": + $ref: "./paths/(index)._forcemerge.yaml" + "/{index}/_mapping": + $ref: "./paths/(index)._mapping.yaml" + "/{index}/_mapping/field/{fields}": + $ref: "./paths/(index)._mapping.field.(fields).yaml" + "/{index}/_mget": + $ref: "./paths/(index)._mget.yaml" + "/{index}/_msearch": + $ref: "./paths/(index)._msearch.yaml" + "/{index}/_msearch/template": + $ref: "./paths/(index)._msearch.template.yaml" + "/{index}/_mtermvectors": + $ref: "./paths/(index)._mtermvectors.yaml" + "/{index}/_open": + $ref: "./paths/(index)._open.yaml" + "/{index}/_rank_eval": + $ref: "./paths/(index)._rank_eval.yaml" + "/{index}/_recovery": + $ref: "./paths/(index)._recovery.yaml" + "/{index}/_refresh": + $ref: "./paths/(index)._refresh.yaml" + "/{index}/_search": + $ref: "./paths/(index)._search.yaml" + "/{index}/_search/point_in_time": + $ref: "./paths/(index)._search.point_in_time.yaml" + "/{index}/_search/template": + $ref: "./paths/(index)._search.template.yaml" + "/{index}/_search_shards": + $ref: "./paths/(index)._search_shards.yaml" + "/{index}/_segments": + $ref: "./paths/(index)._segments.yaml" + "/{index}/_settings": + $ref: "./paths/(index)._settings.yaml" + "/{index}/_settings/{name}": + $ref: "./paths/(index)._settings.(name).yaml" + "/{index}/_shard_stores": + $ref: "./paths/(index)._shard_stores.yaml" + "/{index}/_shrink/{target}": + $ref: "./paths/(index)._shrink.(target).yaml" + "/{index}/_source/{id}": + $ref: "./paths/(index)._source.(id).yaml" + "/{index}/_split/{target}": + $ref: "./paths/(index)._split.(target).yaml" + "/{index}/_stats": + $ref: "./paths/(index)._stats.yaml" + "/{index}/_stats/{metric}": + $ref: "./paths/(index)._stats.(metric).yaml" + "/{index}/_termvectors": + $ref: "./paths/(index)._termvectors.yaml" + "/{index}/_termvectors/{id}": + $ref: "./paths/(index)._termvectors.(id).yaml" + "/{index}/_update/{id}": + $ref: "./paths/(index)._update.(id).yaml" + "/{index}/_update_by_query": + $ref: "./paths/(index)._update_by_query.yaml" + "/{index}/_upgrade": + $ref: "./paths/(index)._upgrade.yaml" + "/{index}/_validate/query": + $ref: "./paths/(index)._validate.query.yaml" diff --git a/openapi_spec/yaml/parameters/query.yaml b/openapi_spec/yaml/parameters/query.yaml new file mode 100644 index 00000000..2dc33d10 --- /dev/null +++ b/openapi_spec/yaml/parameters/query.yaml @@ -0,0 +1,1074 @@ +--- +_source: + in: query + name: _source + description: True or false to return the _source field or not, or a list of fields + to return + schema: + $ref: "../schemas/_common.yaml#/string_array" +_source_excludes: + in: query + name: _source_excludes + description: A list of fields to exclude from the returned _source field + schema: + $ref: "../schemas/_common.yaml#/string_array" +_source_includes: + in: query + name: _source_includes + description: A list of fields to extract and return from the _source field + schema: + $ref: "../schemas/_common.yaml#/string_array" +accept_data_loss: + in: query + name: accept_data_loss + description: Must be set to true in order to delete the dangling index + schema: + type: boolean +actions: + in: query + name: actions + description: A comma-separated list of actions that should be returned. Leave empty + to return all. + schema: + $ref: "../schemas/_common.yaml#/string_array" +active_only: + in: query + name: active_only + description: If `true`, the response only includes ongoing shard recoveries + schema: + type: boolean +all_shards: + in: query + name: all_shards + description: Execute validation on all shards instead of one random shard per index + schema: + type: boolean +allow_no_indices: + in: query + name: allow_no_indices + 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) + schema: + type: boolean +allow_partial_pit_creation: + in: query + name: allow_partial_pit_creation + description: Allow if point in time can be created with partial failures + schema: + type: boolean +allow_partial_search_results: + in: query + name: allow_partial_search_results + description: Indicate if an error should be returned if there is a partial search + failure or timeout + schema: + type: boolean +analyze_wildcard: + in: query + name: analyze_wildcard + description: 'Specify whether wildcard and prefix queries should be analyzed (default: + false)' + schema: + type: boolean +analyzer: + in: query + name: analyzer + description: The analyzer to use for the query string + schema: + type: string +awareness_attribute: + in: query + name: awareness_attribute + description: The awareness attribute for which the health is required + schema: + type: string +batched_reduce_size: + in: query + name: batched_reduce_size + description: The number of shard results that should be reduced at once on the coordinating + node. This value should be used as a protection mechanism to reduce the memory + overhead per search request if the potential number of shards in the request can + be large. + schema: + type: integer +bytes: + in: query + name: bytes + description: The unit in which to display byte values + schema: + type: string + enum: + - b + - k + - kb + - m + - mb + - g + - gb + - t + - tb + - p + - pb +cause: + in: query + name: cause + description: User defined reason for dry-run creating the new template for simulation + purposes + schema: + type: string +ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: Indicates whether network round-trips should be minimized as part of + cross-cluster search requests execution + schema: + type: boolean +cluster_manager_timeout: + in: query + name: cluster_manager_timeout + description: Specify timeout for connection to cluster-manager node + schema: + $ref: "../schemas/_common.yaml#/time" +completed_only: + in: query + name: completed_only + description: If `true`, the response only includes latest completed segment replication + events + schema: + type: boolean +completion_fields: + in: query + name: completion_fields + description: A comma-separated list of fields for `fielddata` and `suggest` index + metric (supports wildcards) + schema: + $ref: "../schemas/_common.yaml#/string_array" +conflicts: + in: query + name: conflicts + description: What to do when the update by query hits version conflicts? + schema: + type: string + enum: + - abort + - proceed +context: + in: query + name: context + description: Context name to compile script against + schema: + type: string +copy_settings: + in: query + name: copy_settings + description: whether or not to copy settings from the source index (defaults to + false) + schema: + type: boolean +create: + in: query + name: create + description: Whether the index template we optionally defined in the body should + only be dry-run added if new or can also replace an existing one + schema: + type: boolean +default_operator: + in: query + name: default_operator + description: The default operator for query string query (AND or OR) + schema: + type: string + enum: + - AND + - OR +detailed: + in: query + name: detailed + description: 'Return detailed task information (default: false)' + schema: + type: boolean +df: + in: query + name: df + description: The field to use as default where no field prefix is given in the query + string + schema: + type: string +docvalue_fields: + in: query + name: docvalue_fields + description: A comma-separated list of fields to return as the docvalue representation + of a field for each hit + schema: + $ref: "../schemas/_common.yaml#/string_array" +dry_run: + in: query + name: dry_run + description: If set to true the rollover action will only be validated but not actually + performed even if a condition matches. The default is false + schema: + type: boolean +ensure_node_commissioned: + in: query + name: ensure_node_commissioned + description: 'Checks whether local node is commissioned or not. If set to true on + a local call it will throw exception if node is decommissioned (default: false)' + schema: + type: boolean +expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are + open, closed or both. + schema: + type: string + enum: + - open + - closed + - hidden + - none + - all +explain: + in: query + name: explain + description: Specify whether to return detailed information about score computation + as part of a hit + schema: + type: boolean +field_statistics: + in: query + name: field_statistics + description: Specifies if document count, sum of document frequencies and sum of + total term frequencies should be returned. + schema: + type: boolean +fielddata: + in: query + name: fielddata + description: Clear field data + schema: + type: boolean +fielddata_fields: + in: query + name: fielddata_fields + description: A comma-separated list of fields for `fielddata` index metric (supports + wildcards) + schema: + $ref: "../schemas/_common.yaml#/string_array" +fields: + in: query + name: fields + description: 'A comma-separated list of fields to clear when using the `fielddata` + parameter (default: all)' + schema: + $ref: "../schemas/_common.yaml#/string_array" +flat_settings: + in: query + name: flat_settings + description: 'Return settings in flat format (default: false)' + schema: + type: boolean +flush: + in: query + name: flush + description: 'Specify whether the index should be flushed after performing the operation + (default: true)' + schema: + type: boolean +forbid_closed_indices: + in: query + name: forbid_closed_indices + description: If set to false stats will also collected from closed indices if explicitly + specified or if expand_wildcards expands to closed indices + schema: + type: boolean +force: + in: query + name: force + description: Whether a flush should be forced even if it is not necessarily needed + ie. if no changes will be committed to the index. This is useful if transaction + log IDs should be incremented even if no uncommitted changes are present. (This + setting can be considered as internal) + schema: + type: boolean +format: + in: query + name: format + description: a short version of the Accept header, e.g. json, yaml + schema: + type: string +from: + in: query + name: from + description: 'Starting offset (default: 0)' + schema: + type: integer +full_id: + in: query + name: full_id + description: 'Return the full node ID instead of the shortened version (default: + false)' + schema: + type: boolean +group_by: + in: query + name: group_by + description: Group tasks by nodes or parent/child relationships + schema: + type: string + enum: + - nodes + - parents + - none +groups: + in: query + name: groups + description: A comma-separated list of search groups for `search` index metric + schema: + $ref: "../schemas/_common.yaml#/string_array" +h: + in: query + name: h + description: Comma-separated list of column names to display + schema: + $ref: "../schemas/_common.yaml#/string_array" +health: + in: query + name: health + description: A health status ("green", "yellow", or "red" to filter only indices + matching the specified health status + schema: + type: string + enum: + - green + - yellow + - red +help: + in: query + name: help + description: Return help information + schema: + type: boolean +ids: + in: query + name: ids + description: A comma-separated list of documents ids. You must define ids as parameter + or set "ids" or "docs" in the request body + schema: + $ref: "../schemas/_common.yaml#/string_array" +if_primary_term: + in: query + name: if_primary_term + description: only perform the index operation if the last operation that has changed + the document has the specified primary term + schema: + type: integer +if_seq_no: + in: query + name: if_seq_no + description: only perform the index operation if the last operation that has changed + the document has the specified sequence number + schema: + type: integer +ignore_idle_threads: + in: query + name: ignore_idle_threads + description: 'Don''t show threads that are in known-idle places, such as waiting + on a socket select or pulling from an empty task queue (default: true)' + schema: + type: boolean +ignore_throttled: + in: query + name: ignore_throttled + description: Whether specified concrete, expanded or aliased indices should be ignored + when throttled + schema: + type: boolean +ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether specified concrete indices should be ignored when unavailable + (missing or closed) + schema: + type: boolean +include_defaults: + in: query + name: include_defaults + description: Whether to return all default clusters setting. + schema: + type: boolean +include_disk_info: + in: query + name: include_disk_info + description: 'Return information about disk usage and shard sizes (default: false)' + schema: + type: boolean +include_segment_file_sizes: + in: query + name: include_segment_file_sizes + description: Whether to report the aggregated disk usage of each one of the Lucene + index files (only applies if segment stats are requested) + schema: + type: boolean +include_unloaded_segments: + in: query + name: include_unloaded_segments + description: If set to true segment stats will include stats for segments that are + not currently loaded into memory + schema: + type: boolean +include_unmapped: + in: query + name: include_unmapped + description: Indicates whether unmapped fields should be included in the response. + schema: + type: boolean +include_yes_decisions: + in: query + name: include_yes_decisions + description: 'Return ''YES'' decisions in explanation (default: false)' + schema: + type: boolean +index: + in: query + name: index + description: A comma-separated list of index name to limit the operation + schema: + $ref: "../schemas/_common.yaml#/string_array" +interval: + in: query + name: interval + description: The interval for the second sampling of threads + schema: + $ref: "../schemas/_common.yaml#/time" +keep_alive: + in: query + name: keep_alive + description: Specify the keep alive for point in time + schema: + type: string +lang: + in: query + name: lang + description: 'The script language (default: painless)' + schema: + type: string +lenient: + in: query + name: lenient + description: Specify whether format-based query failures (such as providing text + to a numeric field) should be ignored + schema: + type: boolean +level: + in: query + name: level + description: Return stats aggregated at cluster, index or shard level + schema: + type: string + enum: + - cluster + - indices + - shards +local: + in: query + name: local + description: 'Return local information, do not retrieve the state from master node + (default: false)' + schema: + type: boolean +master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + x-deprecation-version: 2.0.0 + x-deprecation-description: To support inclusive language, use 'cluster_manager_timeout' + instead. + schema: + $ref: "../schemas/_common.yaml#/time" +max_concurrent_searches: + in: query + name: max_concurrent_searches + description: Controls the maximum number of concurrent searches the multi search + api will execute + schema: + type: integer +max_concurrent_shard_requests: + in: query + name: max_concurrent_shard_requests + description: The number of concurrent shard requests each sub search executes concurrently + per node. This value should be used to limit the impact of the search on the cluster + in order to limit the number of concurrent shard requests + schema: + type: integer +max_docs: + in: query + name: max_docs + description: 'Maximum number of documents to process (default: all documents)' + schema: + type: integer +max_num_segments: + in: query + name: max_num_segments + description: 'The number of segments the index should be merged into (default: dynamic)' + schema: + type: integer +metric: + in: query + name: metric + description: Limit the information returned to the specified metrics. Defaults to + all but metadata + schema: + $ref: "../schemas/_common.yaml#/string_array" +min_score: + in: query + name: min_score + description: Include only documents with a specific `_score` value in the result + schema: + type: integer +node_ids: + in: query + name: node_ids + description: A comma-separated list of the persistent ids of the nodes to exclude + from the voting configuration. If specified, you may not also specify ?node_names. + schema: + type: string +node_names: + in: query + name: node_names + description: A comma-separated list of the names of the nodes to exclude from the + voting configuration. If specified, you may not also specify ?node_ids. + schema: + type: string +nodes: + in: query + name: nodes + description: A comma-separated list of node IDs or names to limit the returned information; + use `_local` to return information from the node you're connecting to, leave empty + to get information from all nodes + schema: + $ref: "../schemas/_common.yaml#/string_array" +offsets: + in: query + name: offsets + description: Specifies if term offsets should be returned. + schema: + type: boolean +only_ancient_segments: + in: query + name: only_ancient_segments + description: If true, only ancient (an older Lucene major release) segments will + be upgraded + schema: + type: boolean +only_expunge_deletes: + in: query + name: only_expunge_deletes + description: Specify whether the operation should only expunge deleted documents + schema: + type: boolean +op_type: + in: query + name: op_type + description: Explicit operation type. Defaults to `index` for requests with an explicit + document ID, and to `create`for requests without an explicit document ID + schema: + type: string + enum: + - index + - create +order: + in: query + name: order + description: The order for this template when merging multiple matching ones (higher + numbers are merged later, overriding the lower numbers) + schema: + type: integer +parent_task_id: + in: query + name: parent_task_id + description: Return tasks with specified parent task id (node_id:task_number). Set + to -1 to return all. + schema: + type: string +payloads: + in: query + name: payloads + description: Specifies if term payloads should be returned. + schema: + type: boolean +pipeline: + in: query + name: pipeline + description: The pipeline id to preprocess incoming documents with + schema: + type: string +positions: + in: query + name: positions + description: Specifies if term positions should be returned. + schema: + type: boolean +pre_filter_shard_size: + in: query + name: pre_filter_shard_size + description: A threshold that enforces a pre-filter roundtrip to prefilter search + shards based on query rewriting if the number of shards the search request expands + to exceeds the threshold. This filter roundtrip can limit the number of shards + significantly if for instance a shard can not match any documents based on its + rewrite method ie. if date filters are mandatory to match but the shard bounds + and the query are disjoint. + schema: + type: integer +preference: + in: query + name: preference + description: 'Specify the node or shard the operation should be performed on (default: + random)' + schema: + type: string +preserve_existing: + in: query + name: preserve_existing + description: Whether to update existing settings. If set to `true` existing settings + on an index remain unchanged, the default is `false` + schema: + type: boolean +pri: + in: query + name: pri + description: Set to true to return stats only for primary shards + schema: + type: boolean +profile: + in: query + name: profile + description: Specify whether to profile the query execution + schema: + type: boolean +q: + in: query + name: q + description: Query in the Lucene query string syntax + schema: + type: string +query: + in: query + name: query + description: Clear query caches + schema: + type: boolean +realtime: + in: query + name: realtime + description: Specify whether to perform the operation in realtime or search mode + schema: + type: boolean +refresh: + in: query + name: refresh + description: Should the affected indexes be refreshed? + schema: + type: boolean +request: + in: query + name: request + description: Clear request cache + schema: + type: boolean +request_cache: + in: query + name: request_cache + description: Specify if request cache should be used for this request or not, defaults + to index level setting + schema: + type: boolean +requests_per_second: + in: query + name: requests_per_second + description: The throttle to set on this request in sub-requests per second. -1 + means no throttle. + schema: + type: integer +require_alias: + in: query + name: require_alias + description: When true, requires destination to be an alias. Default is false + schema: + type: boolean +rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: Indicates whether hits.total should be rendered as an integer or an + object in the rest search response + schema: + type: boolean +retry_failed: + in: query + name: retry_failed + description: Retries allocation of shards that are blocked due to too many subsequent + allocation failures + schema: + type: boolean +retry_on_conflict: + in: query + name: retry_on_conflict + description: 'Specify how many times should the operation be retried when a conflict + occurs (default: 0)' + schema: + type: integer +rewrite: + in: query + name: rewrite + description: Provide a more detailed explanation showing the actual Lucene query + that will be executed. + schema: + type: boolean +routing: + in: query + name: routing + description: Specific routing value + schema: + type: string +s: + in: query + name: s + description: Comma-separated list of column names or column aliases to sort by + schema: + $ref: "../schemas/_common.yaml#/string_array" +scroll: + in: query + name: scroll + description: Control how long to keep the search context alive + schema: + $ref: "../schemas/_common.yaml#/time" +scroll_id: + in: query + name: scroll_id + description: The scroll ID for scrolled search + schema: + type: string +scroll_size: + in: query + name: scroll_size + description: Size on the scroll request powering the update by query + schema: + type: integer +search_timeout: + in: query + name: search_timeout + description: Explicit timeout for each search request. Defaults to no timeout. + schema: + $ref: "../schemas/_common.yaml#/time" +search_type: + in: query + name: search_type + description: Search operation type + schema: + type: string + enum: + - query_then_fetch + - query_and_fetch + - dfs_query_then_fetch + - dfs_query_and_fetch +seq_no_primary_term: + in: query + name: seq_no_primary_term + description: Specify whether to return sequence number and primary term of the last + modification of each hit + schema: + type: boolean +shards: + in: query + name: shards + description: Comma-separated list of shards to display + schema: + $ref: "../schemas/_common.yaml#/string_array" +size: + in: query + name: size + description: Deprecated, please use `max_docs` instead + schema: + type: integer +slices: + in: query + name: slices + description: The number of slices this task should be divided into. Defaults to + 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. + schema: + type: + - integer + - string +snapshots: + in: query + name: snapshots + description: 'Number of samples of thread stacktrace (default: 10)' + schema: + type: integer +sort: + in: query + name: sort + description: A comma-separated list of : pairs + schema: + $ref: "../schemas/_common.yaml#/string_array" +stats: + in: query + name: stats + description: Specific 'tag' of the request for logging and statistical purposes + schema: + $ref: "../schemas/_common.yaml#/string_array" +status: + in: query + name: status + description: A comma-separated list of statuses used to filter on shards to get + store information for + schema: + $ref: "../schemas/_common.yaml#/string_array" +stored_fields: + in: query + name: stored_fields + description: A comma-separated list of stored fields to return in the response + schema: + $ref: "../schemas/_common.yaml#/string_array" +suggest_field: + in: query + name: suggest_field + description: Specify which field to use for suggestions + schema: + type: string +suggest_mode: + in: query + name: suggest_mode + description: Specify suggest mode + schema: + type: string + enum: + - missing + - popular + - always +suggest_size: + in: query + name: suggest_size + description: How many suggestions to return in response + schema: + type: integer +suggest_text: + in: query + name: suggest_text + description: The source text for which the suggestions should be returned + schema: + type: string +term_statistics: + in: query + name: term_statistics + description: Specifies if total term frequency and document frequency should be + returned. + schema: + type: boolean +terminate_after: + in: query + name: terminate_after + description: The maximum count for each shard, upon reaching which the query execution + will terminate early + schema: + type: integer +threads: + in: query + name: threads + description: 'Specify the number of threads to provide information for (default: + 3)' + schema: + type: integer +time: + in: query + name: time + description: The unit in which to display time values + schema: + type: string + enum: + - d + - h + - m + - s + - ms + - micros + - nanos +timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: "../schemas/_common.yaml#/time" +track_scores: + in: query + name: track_scores + description: Whether to calculate and return scores even if they are not used for + sorting + schema: + type: boolean +track_total_hits: + in: query + name: track_total_hits + description: Indicate if the number of documents that match the query should be + tracked + schema: + type: boolean +ts: + in: query + name: ts + description: Set to false to disable timestamping + schema: + type: boolean +type: + in: query + name: type + description: 'The type to sample (default: cpu)' + schema: + type: string + enum: + - cpu + - wait + - block +typed_keys: + in: query + name: typed_keys + description: Specify whether aggregation and suggester names should be prefixed + by their respective types in the response + schema: + type: boolean +types: + in: query + name: types + description: A comma-separated list of document types for the `indexing` index metric + schema: + $ref: "../schemas/_common.yaml#/string_array" +v: + in: query + name: v + description: Verbose mode. Display column headers + schema: + type: boolean +verbose: + in: query + name: verbose + description: Includes detailed memory usage by Lucene. + schema: + type: boolean +verify: + in: query + name: verify + description: Whether to verify the repository after creation + schema: + type: boolean +version: + in: query + name: version + description: Explicit version number for concurrency control + schema: + type: integer +version_type: + in: query + name: version_type + description: Specific version type + schema: + type: string + enum: + - internal + - external + - external_gte + - force +wait_for_active_shards: + in: query + name: wait_for_active_shards + description: Sets the number of shard copies that must be active before proceeding + with the reindex operation. Defaults to 1, meaning the primary shard only. Set + to `all` for all shard copies, otherwise set to any non-negative value less than + or equal to the total number of copies for the shard (number of replicas + 1) + schema: + type: string +wait_for_completion: + in: query + name: wait_for_completion + description: 'Wait for the matching tasks to complete (default: false)' + schema: + type: boolean +wait_for_events: + in: query + name: wait_for_events + description: Wait until all currently queued events with the given priority are + processed + schema: + type: string + enum: + - immediate + - urgent + - high + - normal + - low + - languid +wait_for_metadata_version: + in: query + name: wait_for_metadata_version + description: Wait for the metadata version to be equal or greater than the specified + metadata version + schema: + type: integer +wait_for_no_initializing_shards: + in: query + name: wait_for_no_initializing_shards + description: Whether to wait until there are no initializing shards in the cluster + schema: + type: boolean +wait_for_no_relocating_shards: + in: query + name: wait_for_no_relocating_shards + description: Whether to wait until there are no relocating shards in the cluster + schema: + type: boolean +wait_for_nodes: + in: query + name: wait_for_nodes + description: Wait until the specified number of nodes is available + schema: + type: string +wait_for_removal: + in: query + name: wait_for_removal + description: Specifies whether to wait for all excluded nodes to be removed from + the cluster before clearing the voting configuration exclusions list. + schema: + type: boolean +wait_for_status: + in: query + name: wait_for_status + description: Wait until cluster is in a specific state + schema: + type: string + enum: + - green + - yellow + - red +wait_for_timeout: + in: query + name: wait_for_timeout + description: The maximum time to wait for wait_for_metadata_version before timing + out + schema: + $ref: "../schemas/_common.yaml#/time" +wait_if_ongoing: + in: query + name: wait_if_ongoing + description: If set to true the flush operation will block until the flush can be + executed if another flush operation is already executing. The default is true. + If set to false the flush will be skipped iff if another flush operation is already + running. + schema: + type: boolean +write_index_only: + in: query + name: write_index_only + description: When true, applies mappings only to the write index of an alias or + data stream + schema: + type: boolean diff --git a/openapi_spec/yaml/paths/(alias)._rollover.(new_index).yaml b/openapi_spec/yaml/paths/(alias)._rollover.(new_index).yaml new file mode 100644 index 00000000..a5ea2fa6 --- /dev/null +++ b/openapi_spec/yaml/paths/(alias)._rollover.(new_index).yaml @@ -0,0 +1,31 @@ +--- +post: + x-endpoint-group: indices.rollover + description: |- + Updates an alias to point to a new index when the existing index + is considered to be too large or too old. + parameters: + - in: path + name: alias + description: The name of the alias to rollover + required: true + schema: + type: string + - in: path + name: new_index + description: The name of the rollover index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/dry_run" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + requestBody: + description: The conditions that needs to be met for executing rollover + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(alias)._rollover.yaml b/openapi_spec/yaml/paths/(alias)._rollover.yaml new file mode 100644 index 00000000..e5392234 --- /dev/null +++ b/openapi_spec/yaml/paths/(alias)._rollover.yaml @@ -0,0 +1,25 @@ +--- +post: + x-endpoint-group: indices.rollover + description: |- + Updates an alias to point to a new index when the existing index + is considered to be too large or too old. + parameters: + - in: path + name: alias + description: The name of the alias to rollover + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/dry_run" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + requestBody: + description: The conditions that needs to be met for executing rollover + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._alias.(name).yaml b/openapi_spec/yaml/paths/(index)._alias.(name).yaml new file mode 100644 index 00000000..659d2a47 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._alias.(name).yaml @@ -0,0 +1,116 @@ +--- +put: + x-endpoint-group: indices.put_alias + description: Creates or updates an alias. + parameters: + - in: path + name: index + description: A comma-separated list of index names the alias should point to (supports + wildcards); use `_all` to perform the operation on all indices. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: The name of the alias to be created or updated + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The settings for the alias, such as `routing` or `filter` + required: false + content: + application/json: + schema: + type: object +post: + x-endpoint-group: indices.put_alias + description: Creates or updates an alias. + parameters: + - in: path + name: index + description: A comma-separated list of index names the alias should point to (supports + wildcards); use `_all` to perform the operation on all indices. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: The name of the alias to be created or updated + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The settings for the alias, such as `routing` or `filter` + required: false + content: + application/json: + schema: + type: object +head: + x-endpoint-group: indices.exists_alias + description: Returns information about whether a particular alias exists. + parameters: + - in: path + name: index + description: A comma-separated list of index names to filter aliases + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: A comma-separated list of alias names to return + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/local" +get: + x-endpoint-group: indices.get_alias + description: Returns an alias. + parameters: + - in: path + name: index + description: A comma-separated list of index names to filter aliases + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: A comma-separated list of alias names to return + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/local" +delete: + x-endpoint-group: indices.delete_alias + description: Deletes an alias. + parameters: + - in: path + name: index + description: A comma-separated list of index names (supports wildcards); use `_all` + for all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: A comma-separated list of aliases to delete (supports wildcards); + use `_all` to delete all aliases for the specified indices. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" diff --git a/openapi_spec/yaml/paths/(index)._alias.yaml b/openapi_spec/yaml/paths/(index)._alias.yaml new file mode 100644 index 00000000..0c5f8684 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._alias.yaml @@ -0,0 +1,15 @@ +--- +get: + x-endpoint-group: indices.get_alias + description: Returns an alias. + parameters: + - in: path + name: index + description: A comma-separated list of index names to filter aliases + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/(index)._aliases.(name).yaml b/openapi_spec/yaml/paths/(index)._aliases.(name).yaml new file mode 100644 index 00000000..dd7c126e --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._aliases.(name).yaml @@ -0,0 +1,76 @@ +--- +put: + x-endpoint-group: indices.put_alias + description: Creates or updates an alias. + parameters: + - in: path + name: index + description: A comma-separated list of index names the alias should point to (supports + wildcards); use `_all` to perform the operation on all indices. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: The name of the alias to be created or updated + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The settings for the alias, such as `routing` or `filter` + required: false + content: + application/json: + schema: + type: object +post: + x-endpoint-group: indices.put_alias + description: Creates or updates an alias. + parameters: + - in: path + name: index + description: A comma-separated list of index names the alias should point to (supports + wildcards); use `_all` to perform the operation on all indices. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: The name of the alias to be created or updated + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The settings for the alias, such as `routing` or `filter` + required: false + content: + application/json: + schema: + type: object +delete: + x-endpoint-group: indices.delete_alias + description: Deletes an alias. + parameters: + - in: path + name: index + description: A comma-separated list of index names (supports wildcards); use `_all` + for all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: A comma-separated list of aliases to delete (supports wildcards); + use `_all` to delete all aliases for the specified indices. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" diff --git a/openapi_spec/yaml/paths/(index)._analyze.yaml b/openapi_spec/yaml/paths/(index)._analyze.yaml new file mode 100644 index 00000000..0c0b1bdd --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._analyze.yaml @@ -0,0 +1,33 @@ +--- +get: + x-endpoint-group: indices.analyze + description: Performs the analysis process on a text and return the tokens breakdown + of the text. + parameters: + - in: path + name: index + description: The name of the index to scope the operation + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/index" +post: + x-endpoint-group: indices.analyze + description: Performs the analysis process on a text and return the tokens breakdown + of the text. + parameters: + - in: path + name: index + description: The name of the index to scope the operation + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/index" + requestBody: + description: Define analyzer/tokenizer parameters and the text on which the analysis + should be performed + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._block.(block).yaml b/openapi_spec/yaml/paths/(index)._block.(block).yaml new file mode 100644 index 00000000..21bb9abb --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._block.(block).yaml @@ -0,0 +1,23 @@ +--- +put: + x-endpoint-group: indices.add_block + description: Adds a block to an index. + parameters: + - in: path + name: index + description: A comma separated list of indices to add a block to + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: block + description: The block to add (one of read, write, read_only or metadata) + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/(index)._bulk.yaml b/openapi_spec/yaml/paths/(index)._bulk.yaml new file mode 100644 index 00000000..a77ded45 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._bulk.yaml @@ -0,0 +1,59 @@ +--- +post: + x-endpoint-group: bulk + description: Allows to perform multiple index/update/delete operations in a single + request. + parameters: + - in: path + name: index + description: Default index for items which don't provide one + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/pipeline" + - $ref: "../parameters/query.yaml#/require_alias" + requestBody: + description: The operation definition and data (action-data pairs), separated + by newlines + required: true + content: + application/json: + schema: + type: object +put: + x-endpoint-group: bulk + description: Allows to perform multiple index/update/delete operations in a single + request. + parameters: + - in: path + name: index + description: Default index for items which don't provide one + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/pipeline" + - $ref: "../parameters/query.yaml#/require_alias" + requestBody: + description: The operation definition and data (action-data pairs), separated + by newlines + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._cache.clear.yaml b/openapi_spec/yaml/paths/(index)._cache.clear.yaml new file mode 100644 index 00000000..2f192e1a --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._cache.clear.yaml @@ -0,0 +1,19 @@ +--- +post: + x-endpoint-group: indices.clear_cache + description: Clears all or specific caches for one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index name to limit the operation + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/fielddata" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/query" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/index" + - $ref: "../parameters/query.yaml#/request" diff --git a/openapi_spec/yaml/paths/(index)._clone.(target).yaml b/openapi_spec/yaml/paths/(index)._clone.(target).yaml new file mode 100644 index 00000000..e70aa8c1 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._clone.(target).yaml @@ -0,0 +1,55 @@ +--- +put: + x-endpoint-group: indices.clone + description: Clones an index + parameters: + - in: path + name: index + description: The name of the source index to clone + required: true + schema: + type: string + - in: path + name: target + description: The name of the target index to clone into + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + requestBody: + description: The configuration for the target index (`settings` and `aliases`) + required: false + content: + application/json: + schema: + type: object +post: + x-endpoint-group: indices.clone + description: Clones an index + parameters: + - in: path + name: index + description: The name of the source index to clone + required: true + schema: + type: string + - in: path + name: target + description: The name of the target index to clone into + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + requestBody: + description: The configuration for the target index (`settings` and `aliases`) + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._close.yaml b/openapi_spec/yaml/paths/(index)._close.yaml new file mode 100644 index 00000000..23c611e4 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._close.yaml @@ -0,0 +1,18 @@ +--- +post: + x-endpoint-group: indices.close + description: Closes an index. + parameters: + - in: path + name: index + description: A comma separated list of indices to close + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" diff --git a/openapi_spec/yaml/paths/(index)._count.yaml b/openapi_spec/yaml/paths/(index)._count.yaml new file mode 100644 index 00000000..79127729 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._count.yaml @@ -0,0 +1,56 @@ +--- +post: + x-endpoint-group: count + description: Returns number of documents matching a query. + parameters: + - in: path + name: index + description: A comma-separated list of indices to restrict the results + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/min_score" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/terminate_after" + requestBody: + description: A query to restrict the results specified with the Query DSL (optional) + required: false + content: + application/json: + schema: + type: object +get: + x-endpoint-group: count + description: Returns number of documents matching a query. + parameters: + - in: path + name: index + description: A comma-separated list of indices to restrict the results + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/min_score" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/terminate_after" diff --git a/openapi_spec/yaml/paths/(index)._create.(id).yaml b/openapi_spec/yaml/paths/(index)._create.(id).yaml new file mode 100644 index 00000000..f2c9d59b --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._create.(id).yaml @@ -0,0 +1,67 @@ +--- +put: + x-endpoint-group: create + description: |- + Creates a new document in the index. + + Returns a 409 response when a document with a same ID already exists in the index. + parameters: + - in: path + name: id + description: Document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + - $ref: "../parameters/query.yaml#/pipeline" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: create + description: |- + Creates a new document in the index. + + Returns a 409 response when a document with a same ID already exists in the index. + parameters: + - in: path + name: id + description: Document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + - $ref: "../parameters/query.yaml#/pipeline" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._delete_by_query.yaml b/openapi_spec/yaml/paths/(index)._delete_by_query.yaml new file mode 100644 index 00000000..c8805771 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._delete_by_query.yaml @@ -0,0 +1,52 @@ +--- +post: + x-endpoint-group: delete_by_query + description: Deletes documents matching the provided query. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/from" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/conflicts" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/search_timeout" + - $ref: "../parameters/query.yaml#/size" + - $ref: "../parameters/query.yaml#/max_docs" + - $ref: "../parameters/query.yaml#/sort" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/terminate_after" + - $ref: "../parameters/query.yaml#/stats" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/request_cache" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/scroll_size" + - $ref: "../parameters/query.yaml#/wait_for_completion" + - $ref: "../parameters/query.yaml#/requests_per_second" + - $ref: "../parameters/query.yaml#/slices" + requestBody: + description: The search definition using the Query DSL + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._doc.(id).yaml b/openapi_spec/yaml/paths/(index)._doc.(id).yaml new file mode 100644 index 00000000..2573d290 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._doc.(id).yaml @@ -0,0 +1,145 @@ +--- +get: + x-endpoint-group: get + description: Returns a document. + parameters: + - in: path + name: id + description: The document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" +delete: + x-endpoint-group: delete + description: Removes a document from the index. + parameters: + - in: path + name: id + description: The document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/if_seq_no" + - $ref: "../parameters/query.yaml#/if_primary_term" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" +put: + x-endpoint-group: index + description: Creates or updates a document in an index. + parameters: + - in: path + name: id + description: Document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/op_type" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + - $ref: "../parameters/query.yaml#/if_seq_no" + - $ref: "../parameters/query.yaml#/if_primary_term" + - $ref: "../parameters/query.yaml#/pipeline" + - $ref: "../parameters/query.yaml#/require_alias" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: index + description: Creates or updates a document in an index. + parameters: + - in: path + name: id + description: Document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/op_type" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + - $ref: "../parameters/query.yaml#/if_seq_no" + - $ref: "../parameters/query.yaml#/if_primary_term" + - $ref: "../parameters/query.yaml#/pipeline" + - $ref: "../parameters/query.yaml#/require_alias" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object +head: + x-endpoint-group: exists + description: Returns information about whether a document exists in an index. + parameters: + - in: path + name: id + description: The document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" diff --git a/openapi_spec/yaml/paths/(index)._doc.yaml b/openapi_spec/yaml/paths/(index)._doc.yaml new file mode 100644 index 00000000..526b799b --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._doc.yaml @@ -0,0 +1,29 @@ +--- +post: + x-endpoint-group: index + description: Creates or updates a document in an index. + parameters: + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/op_type" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + - $ref: "../parameters/query.yaml#/if_seq_no" + - $ref: "../parameters/query.yaml#/if_primary_term" + - $ref: "../parameters/query.yaml#/pipeline" + - $ref: "../parameters/query.yaml#/require_alias" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._explain.(id).yaml b/openapi_spec/yaml/paths/(index)._explain.(id).yaml new file mode 100644 index 00000000..604c465b --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._explain.(id).yaml @@ -0,0 +1,66 @@ +--- +get: + x-endpoint-group: explain + description: Returns information about why a specific matches (or doesn't match) + a query. + parameters: + - in: path + name: id + description: The document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" +post: + x-endpoint-group: explain + description: Returns information about why a specific matches (or doesn't match) + a query. + parameters: + - in: path + name: id + description: The document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + requestBody: + description: The query definition using the Query DSL + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._field_caps.yaml b/openapi_spec/yaml/paths/(index)._field_caps.yaml new file mode 100644 index 00000000..53b5d441 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._field_caps.yaml @@ -0,0 +1,42 @@ +--- +get: + x-endpoint-group: field_caps + description: Returns the information about the capabilities of fields among multiple + indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/include_unmapped" +post: + x-endpoint-group: field_caps + description: Returns the information about the capabilities of fields among multiple + indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/include_unmapped" + requestBody: + description: An index filter specified with the Query DSL + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._flush.yaml b/openapi_spec/yaml/paths/(index)._flush.yaml new file mode 100644 index 00000000..3b8e41fe --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._flush.yaml @@ -0,0 +1,33 @@ +--- +post: + x-endpoint-group: indices.flush + description: Performs the flush operation on one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + for all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/force" + - $ref: "../parameters/query.yaml#/wait_if_ongoing" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" +get: + x-endpoint-group: indices.flush + description: Performs the flush operation on one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + for all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/force" + - $ref: "../parameters/query.yaml#/wait_if_ongoing" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/(index)._forcemerge.yaml b/openapi_spec/yaml/paths/(index)._forcemerge.yaml new file mode 100644 index 00000000..2a7c6ff7 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._forcemerge.yaml @@ -0,0 +1,18 @@ +--- +post: + x-endpoint-group: indices.forcemerge + description: Performs the force merge operation on one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/flush" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/max_num_segments" + - $ref: "../parameters/query.yaml#/only_expunge_deletes" diff --git a/openapi_spec/yaml/paths/(index)._mapping.field.(fields).yaml b/openapi_spec/yaml/paths/(index)._mapping.field.(fields).yaml new file mode 100644 index 00000000..ace61779 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._mapping.field.(fields).yaml @@ -0,0 +1,22 @@ +--- +get: + x-endpoint-group: indices.get_field_mapping + description: Returns mapping for one or more fields. + parameters: + - in: path + name: index + description: A comma-separated list of index names + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: fields + description: A comma-separated list of fields + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/include_defaults" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/(index)._mapping.yaml b/openapi_spec/yaml/paths/(index)._mapping.yaml new file mode 100644 index 00000000..d53c154f --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._mapping.yaml @@ -0,0 +1,67 @@ +--- +get: + x-endpoint-group: indices.get_mapping + description: Returns mappings for one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" +put: + x-endpoint-group: indices.put_mapping + description: Updates the index mappings. + parameters: + - in: path + name: index + description: A comma-separated list of index names the mapping should be added + to (supports wildcards); use `_all` or omit to add the mapping on all indices. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/write_index_only" + requestBody: + description: The mapping definition + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: indices.put_mapping + description: Updates the index mappings. + parameters: + - in: path + name: index + description: A comma-separated list of index names the mapping should be added + to (supports wildcards); use `_all` or omit to add the mapping on all indices. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/write_index_only" + requestBody: + description: The mapping definition + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._mget.yaml b/openapi_spec/yaml/paths/(index)._mget.yaml new file mode 100644 index 00000000..a2b620e0 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._mget.yaml @@ -0,0 +1,45 @@ +--- +get: + x-endpoint-group: mget + description: Allows to get multiple documents in one request. + parameters: + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" +post: + x-endpoint-group: mget + description: Allows to get multiple documents in one request. + parameters: + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + requestBody: + description: Document identifiers; can be either `docs` (containing full document + information) or `ids` (when index is provided in the URL. + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._msearch.template.yaml b/openapi_spec/yaml/paths/(index)._msearch.template.yaml new file mode 100644 index 00000000..ef881022 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._msearch.template.yaml @@ -0,0 +1,39 @@ +--- +get: + x-endpoint-group: msearch_template + description: Allows to execute several search template operations in one request. + parameters: + - in: path + name: index + description: A comma-separated list of index names to use as default + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/max_concurrent_searches" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" +post: + x-endpoint-group: msearch_template + description: Allows to execute several search template operations in one request. + parameters: + - in: path + name: index + description: A comma-separated list of index names to use as default + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/max_concurrent_searches" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + requestBody: + description: The request definitions (metadata-search request definition pairs), + separated by newlines + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._msearch.yaml b/openapi_spec/yaml/paths/(index)._msearch.yaml new file mode 100644 index 00000000..cdaa44a3 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._msearch.yaml @@ -0,0 +1,43 @@ +--- +get: + x-endpoint-group: msearch + description: Allows to execute several search operations in one request. + parameters: + - in: path + name: index + description: A comma-separated list of index names to use as default + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/max_concurrent_searches" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/pre_filter_shard_size" + - $ref: "../parameters/query.yaml#/max_concurrent_shard_requests" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" +post: + x-endpoint-group: msearch + description: Allows to execute several search operations in one request. + parameters: + - in: path + name: index + description: A comma-separated list of index names to use as default + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/max_concurrent_searches" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/pre_filter_shard_size" + - $ref: "../parameters/query.yaml#/max_concurrent_shard_requests" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + requestBody: + description: The request definitions (metadata-search request definition pairs), + separated by newlines + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._mtermvectors.yaml b/openapi_spec/yaml/paths/(index)._mtermvectors.yaml new file mode 100644 index 00000000..db9bcf12 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._mtermvectors.yaml @@ -0,0 +1,53 @@ +--- +get: + x-endpoint-group: mtermvectors + description: Returns multiple termvectors in one request. + parameters: + - in: path + name: index + description: The index in which the document resides. + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/ids" + - $ref: "../parameters/query.yaml#/term_statistics" + - $ref: "../parameters/query.yaml#/field_statistics" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/offsets" + - $ref: "../parameters/query.yaml#/positions" + - $ref: "../parameters/query.yaml#/payloads" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" +post: + x-endpoint-group: mtermvectors + description: Returns multiple termvectors in one request. + parameters: + - in: path + name: index + description: The index in which the document resides. + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/ids" + - $ref: "../parameters/query.yaml#/term_statistics" + - $ref: "../parameters/query.yaml#/field_statistics" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/offsets" + - $ref: "../parameters/query.yaml#/positions" + - $ref: "../parameters/query.yaml#/payloads" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + requestBody: + description: Define ids, documents, parameters or a list of parameters per document + here. You must at least provide a list of document ids. See documentation. + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._open.yaml b/openapi_spec/yaml/paths/(index)._open.yaml new file mode 100644 index 00000000..65c60362 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._open.yaml @@ -0,0 +1,17 @@ +--- +post: + x-endpoint-group: indices.open + description: Opens an index. + parameters: + - in: path + name: index + description: A comma separated list of indices to open + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" diff --git a/openapi_spec/yaml/paths/(index)._rank_eval.yaml b/openapi_spec/yaml/paths/(index)._rank_eval.yaml new file mode 100644 index 00000000..ddaaf35d --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._rank_eval.yaml @@ -0,0 +1,41 @@ +--- +get: + x-endpoint-group: rank_eval + description: Allows to evaluate the quality of ranked search results over a set + of typical search queries + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/search_type" +post: + x-endpoint-group: rank_eval + description: Allows to evaluate the quality of ranked search results over a set + of typical search queries + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/search_type" + requestBody: + description: The ranking evaluation search definition, including search requests, + document ratings and ranking metric definition. + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._recovery.yaml b/openapi_spec/yaml/paths/(index)._recovery.yaml new file mode 100644 index 00000000..1b5590e3 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._recovery.yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: indices.recovery + description: Returns information about ongoing index shard recoveries. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/detailed" + - $ref: "../parameters/query.yaml#/active_only" diff --git a/openapi_spec/yaml/paths/(index)._refresh.yaml b/openapi_spec/yaml/paths/(index)._refresh.yaml new file mode 100644 index 00000000..6cdc81b4 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._refresh.yaml @@ -0,0 +1,29 @@ +--- +post: + x-endpoint-group: indices.refresh + description: Performs the refresh operation in one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" +get: + x-endpoint-group: indices.refresh + description: Performs the refresh operation in one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/(index)._search.point_in_time.yaml b/openapi_spec/yaml/paths/(index)._search.point_in_time.yaml new file mode 100644 index 00000000..9951ebdd --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._search.point_in_time.yaml @@ -0,0 +1,16 @@ +--- +post: + x-endpoint-group: create_pit + description: Creates point in time context. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/allow_partial_pit_creation" + - $ref: "../parameters/query.yaml#/keep_alive" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" diff --git a/openapi_spec/yaml/paths/(index)._search.template.yaml b/openapi_spec/yaml/paths/(index)._search.template.yaml new file mode 100644 index 00000000..dec73a7f --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._search.template.yaml @@ -0,0 +1,56 @@ +--- +get: + x-endpoint-group: search_template + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/profile" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" +post: + x-endpoint-group: search_template + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/profile" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + requestBody: + description: The search definition template and its params + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._search.yaml b/openapi_spec/yaml/paths/(index)._search.yaml new file mode 100644 index 00000000..87dd7eab --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._search.yaml @@ -0,0 +1,114 @@ +--- +get: + x-endpoint-group: search + description: Returns results matching a query. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/docvalue_fields" + - $ref: "../parameters/query.yaml#/from" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/size" + - $ref: "../parameters/query.yaml#/sort" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/terminate_after" + - $ref: "../parameters/query.yaml#/stats" + - $ref: "../parameters/query.yaml#/suggest_field" + - $ref: "../parameters/query.yaml#/suggest_mode" + - $ref: "../parameters/query.yaml#/suggest_size" + - $ref: "../parameters/query.yaml#/suggest_text" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/track_scores" + - $ref: "../parameters/query.yaml#/track_total_hits" + - $ref: "../parameters/query.yaml#/allow_partial_search_results" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/seq_no_primary_term" + - $ref: "../parameters/query.yaml#/request_cache" + - $ref: "../parameters/query.yaml#/batched_reduce_size" + - $ref: "../parameters/query.yaml#/max_concurrent_shard_requests" + - $ref: "../parameters/query.yaml#/pre_filter_shard_size" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" +post: + x-endpoint-group: search + description: Returns results matching a query. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/docvalue_fields" + - $ref: "../parameters/query.yaml#/from" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/size" + - $ref: "../parameters/query.yaml#/sort" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/terminate_after" + - $ref: "../parameters/query.yaml#/stats" + - $ref: "../parameters/query.yaml#/suggest_field" + - $ref: "../parameters/query.yaml#/suggest_mode" + - $ref: "../parameters/query.yaml#/suggest_size" + - $ref: "../parameters/query.yaml#/suggest_text" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/track_scores" + - $ref: "../parameters/query.yaml#/track_total_hits" + - $ref: "../parameters/query.yaml#/allow_partial_search_results" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/seq_no_primary_term" + - $ref: "../parameters/query.yaml#/request_cache" + - $ref: "../parameters/query.yaml#/batched_reduce_size" + - $ref: "../parameters/query.yaml#/max_concurrent_shard_requests" + - $ref: "../parameters/query.yaml#/pre_filter_shard_size" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + requestBody: + description: The search definition using the Query DSL + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._search_shards.yaml b/openapi_spec/yaml/paths/(index)._search_shards.yaml new file mode 100644 index 00000000..951203a9 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._search_shards.yaml @@ -0,0 +1,37 @@ +--- +get: + x-endpoint-group: search_shards + description: Returns information about the indices and shards that a search request + would be executed against. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" +post: + x-endpoint-group: search_shards + description: Returns information about the indices and shards that a search request + would be executed against. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/(index)._segments.yaml b/openapi_spec/yaml/paths/(index)._segments.yaml new file mode 100644 index 00000000..0e85c2b4 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._segments.yaml @@ -0,0 +1,16 @@ +--- +get: + x-endpoint-group: indices.segments + description: Provides low-level information about segments in a Lucene index. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/verbose" diff --git a/openapi_spec/yaml/paths/(index)._settings.(name).yaml b/openapi_spec/yaml/paths/(index)._settings.(name).yaml new file mode 100644 index 00000000..209244d2 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._settings.(name).yaml @@ -0,0 +1,26 @@ +--- +get: + x-endpoint-group: indices.get_settings + description: Returns settings for one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: name + description: The name of the settings that should be included + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/include_defaults" diff --git a/openapi_spec/yaml/paths/(index)._settings.yaml b/openapi_spec/yaml/paths/(index)._settings.yaml new file mode 100644 index 00000000..c4067842 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._settings.yaml @@ -0,0 +1,46 @@ +--- +put: + x-endpoint-group: indices.put_settings + description: Updates the index settings. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/preserve_existing" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/flat_settings" + requestBody: + description: The index settings to be updated + required: true + content: + application/json: + schema: + type: object +get: + x-endpoint-group: indices.get_settings + description: Returns settings for one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/include_defaults" diff --git a/openapi_spec/yaml/paths/(index)._shard_stores.yaml b/openapi_spec/yaml/paths/(index)._shard_stores.yaml new file mode 100644 index 00000000..d5c034fe --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._shard_stores.yaml @@ -0,0 +1,16 @@ +--- +get: + x-endpoint-group: indices.shard_stores + description: Provides store information for shard copies of indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/status" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/(index)._shrink.(target).yaml b/openapi_spec/yaml/paths/(index)._shrink.(target).yaml new file mode 100644 index 00000000..375f6417 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._shrink.(target).yaml @@ -0,0 +1,59 @@ +--- +put: + x-endpoint-group: indices.shrink + description: Allow to shrink an existing index into a new index with fewer primary + shards. + parameters: + - in: path + name: index + description: The name of the source index to shrink + required: true + schema: + type: string + - in: path + name: target + description: The name of the target index to shrink into + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/copy_settings" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + requestBody: + description: The configuration for the target index (`settings` and `aliases`) + required: false + content: + application/json: + schema: + type: object +post: + x-endpoint-group: indices.shrink + description: Allow to shrink an existing index into a new index with fewer primary + shards. + parameters: + - in: path + name: index + description: The name of the source index to shrink + required: true + schema: + type: string + - in: path + name: target + description: The name of the target index to shrink into + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/copy_settings" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + requestBody: + description: The configuration for the target index (`settings` and `aliases`) + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._source.(id).yaml b/openapi_spec/yaml/paths/(index)._source.(id).yaml new file mode 100644 index 00000000..d5c2b345 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._source.(id).yaml @@ -0,0 +1,51 @@ +--- +head: + x-endpoint-group: exists_source + description: Returns information about whether a document source exists in an index. + parameters: + - in: path + name: id + description: The document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" +get: + x-endpoint-group: get_source + description: Returns the source of a document. + parameters: + - in: path + name: id + description: The document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" diff --git a/openapi_spec/yaml/paths/(index)._split.(target).yaml b/openapi_spec/yaml/paths/(index)._split.(target).yaml new file mode 100644 index 00000000..c386c282 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._split.(target).yaml @@ -0,0 +1,59 @@ +--- +put: + x-endpoint-group: indices.split + description: Allows you to split an existing index into a new index with more primary + shards. + parameters: + - in: path + name: index + description: The name of the source index to split + required: true + schema: + type: string + - in: path + name: target + description: The name of the target index to split into + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/copy_settings" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + requestBody: + description: The configuration for the target index (`settings` and `aliases`) + required: false + content: + application/json: + schema: + type: object +post: + x-endpoint-group: indices.split + description: Allows you to split an existing index into a new index with more primary + shards. + parameters: + - in: path + name: index + description: The name of the source index to split + required: true + schema: + type: string + - in: path + name: target + description: The name of the target index to split into + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/copy_settings" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + requestBody: + description: The configuration for the target index (`settings` and `aliases`) + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._stats.(metric).yaml b/openapi_spec/yaml/paths/(index)._stats.(metric).yaml new file mode 100644 index 00000000..7a5110b6 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._stats.(metric).yaml @@ -0,0 +1,27 @@ +--- +get: + x-endpoint-group: indices.stats + description: Provides statistics on operations happening in an index. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: metric + description: Limit the information returned the specific metrics. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" + - $ref: "../parameters/query.yaml#/include_unloaded_segments" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/forbid_closed_indices" diff --git a/openapi_spec/yaml/paths/(index)._stats.yaml b/openapi_spec/yaml/paths/(index)._stats.yaml new file mode 100644 index 00000000..2315a49c --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._stats.yaml @@ -0,0 +1,21 @@ +--- +get: + x-endpoint-group: indices.stats + description: Provides statistics on operations happening in an index. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" + - $ref: "../parameters/query.yaml#/include_unloaded_segments" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/forbid_closed_indices" diff --git a/openapi_spec/yaml/paths/(index)._termvectors.(id).yaml b/openapi_spec/yaml/paths/(index)._termvectors.(id).yaml new file mode 100644 index 00000000..07d576ba --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._termvectors.(id).yaml @@ -0,0 +1,67 @@ +--- +get: + x-endpoint-group: termvectors + description: Returns information and statistics about terms in the fields of a particular + document. + parameters: + - in: path + name: index + description: The index in which the document resides. + required: true + schema: + type: string + - in: path + name: id + description: The id of the document, when not specified a doc param should be + supplied. + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/term_statistics" + - $ref: "../parameters/query.yaml#/field_statistics" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/offsets" + - $ref: "../parameters/query.yaml#/positions" + - $ref: "../parameters/query.yaml#/payloads" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" +post: + x-endpoint-group: termvectors + description: Returns information and statistics about terms in the fields of a particular + document. + parameters: + - in: path + name: index + description: The index in which the document resides. + required: true + schema: + type: string + - in: path + name: id + description: The id of the document, when not specified a doc param should be + supplied. + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/term_statistics" + - $ref: "../parameters/query.yaml#/field_statistics" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/offsets" + - $ref: "../parameters/query.yaml#/positions" + - $ref: "../parameters/query.yaml#/payloads" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + requestBody: + description: Define parameters and or supply a document to get termvectors for. + See documentation. + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._termvectors.yaml b/openapi_spec/yaml/paths/(index)._termvectors.yaml new file mode 100644 index 00000000..1fcf8e09 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._termvectors.yaml @@ -0,0 +1,53 @@ +--- +get: + x-endpoint-group: termvectors + description: Returns information and statistics about terms in the fields of a particular + document. + parameters: + - in: path + name: index + description: The index in which the document resides. + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/term_statistics" + - $ref: "../parameters/query.yaml#/field_statistics" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/offsets" + - $ref: "../parameters/query.yaml#/positions" + - $ref: "../parameters/query.yaml#/payloads" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" +post: + x-endpoint-group: termvectors + description: Returns information and statistics about terms in the fields of a particular + document. + parameters: + - in: path + name: index + description: The index in which the document resides. + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/term_statistics" + - $ref: "../parameters/query.yaml#/field_statistics" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/offsets" + - $ref: "../parameters/query.yaml#/positions" + - $ref: "../parameters/query.yaml#/payloads" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + requestBody: + description: Define parameters and or supply a document to get termvectors for. + See documentation. + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._update.(id).yaml b/openapi_spec/yaml/paths/(index)._update.(id).yaml new file mode 100644 index 00000000..4c07df78 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._update.(id).yaml @@ -0,0 +1,36 @@ +--- +post: + x-endpoint-group: update + description: Updates a document with a script or partial document. + parameters: + - in: path + name: id + description: Document ID + required: true + schema: + type: string + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/lang" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/retry_on_conflict" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/if_seq_no" + - $ref: "../parameters/query.yaml#/if_primary_term" + - $ref: "../parameters/query.yaml#/require_alias" + requestBody: + description: The request definition requires either `script` or partial `doc` + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._update_by_query.yaml b/openapi_spec/yaml/paths/(index)._update_by_query.yaml new file mode 100644 index 00000000..17b943ed --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._update_by_query.yaml @@ -0,0 +1,56 @@ +--- +post: + x-endpoint-group: update_by_query + description: |- + Performs an update on every document in the index without changing the source, + for example to pick up a mapping change. + parameters: + - in: path + name: index + description: A comma-separated list of index names to search; use `_all` or empty + string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/from" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/conflicts" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/pipeline" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/search_timeout" + - $ref: "../parameters/query.yaml#/size" + - $ref: "../parameters/query.yaml#/max_docs" + - $ref: "../parameters/query.yaml#/sort" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/terminate_after" + - $ref: "../parameters/query.yaml#/stats" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + - $ref: "../parameters/query.yaml#/request_cache" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/scroll_size" + - $ref: "../parameters/query.yaml#/wait_for_completion" + - $ref: "../parameters/query.yaml#/requests_per_second" + - $ref: "../parameters/query.yaml#/slices" + requestBody: + description: The search definition using the Query DSL + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index)._upgrade.yaml b/openapi_spec/yaml/paths/(index)._upgrade.yaml new file mode 100644 index 00000000..ead1baa3 --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._upgrade.yaml @@ -0,0 +1,31 @@ +--- +post: + x-endpoint-group: indices.upgrade + description: The _upgrade API is no longer useful and will be removed. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/wait_for_completion" + - $ref: "../parameters/query.yaml#/only_ancient_segments" +get: + x-endpoint-group: indices.get_upgrade + description: The _upgrade API is no longer useful and will be removed. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/(index)._validate.query.yaml b/openapi_spec/yaml/paths/(index)._validate.query.yaml new file mode 100644 index 00000000..123720aa --- /dev/null +++ b/openapi_spec/yaml/paths/(index)._validate.query.yaml @@ -0,0 +1,56 @@ +--- +get: + x-endpoint-group: indices.validate_query + description: Allows a user to validate a potentially expensive query without executing + it. + parameters: + - in: path + name: index + description: A comma-separated list of index names to restrict the operation; + use `_all` or empty string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/rewrite" + - $ref: "../parameters/query.yaml#/all_shards" +post: + x-endpoint-group: indices.validate_query + description: Allows a user to validate a potentially expensive query without executing + it. + parameters: + - in: path + name: index + description: A comma-separated list of index names to restrict the operation; + use `_all` or empty string to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/rewrite" + - $ref: "../parameters/query.yaml#/all_shards" + requestBody: + description: The query definition specified with the Query DSL + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/(index).yaml b/openapi_spec/yaml/paths/(index).yaml new file mode 100644 index 00000000..ec24da1a --- /dev/null +++ b/openapi_spec/yaml/paths/(index).yaml @@ -0,0 +1,72 @@ +--- +delete: + x-endpoint-group: indices.delete + description: Deletes an index. + parameters: + - in: path + name: index + description: A comma-separated list of indices to delete; use `_all` or `*` string + to delete all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" +get: + x-endpoint-group: indices.get + description: Returns information about one or more indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/include_defaults" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" +head: + x-endpoint-group: indices.exists + description: Returns information about whether a particular index exists. + parameters: + - in: path + name: index + description: A comma-separated list of index names + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/include_defaults" +put: + x-endpoint-group: indices.create + description: Creates an index with optional settings and mappings. + parameters: + - in: path + name: index + description: The name of the index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The configuration for the index (`settings` and `mappings`) + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_.yaml b/openapi_spec/yaml/paths/_.yaml new file mode 100644 index 00000000..6ae7c7aa --- /dev/null +++ b/openapi_spec/yaml/paths/_.yaml @@ -0,0 +1,9 @@ +--- +get: + x-endpoint-group: info + description: Returns basic information about the cluster. + parameters: [] +head: + x-endpoint-group: ping + description: Returns whether the cluster is running. + parameters: [] diff --git a/openapi_spec/yaml/paths/_alias.(name).yaml b/openapi_spec/yaml/paths/_alias.(name).yaml new file mode 100644 index 00000000..eeaf95ba --- /dev/null +++ b/openapi_spec/yaml/paths/_alias.(name).yaml @@ -0,0 +1,29 @@ +--- +head: + x-endpoint-group: indices.exists_alias + description: Returns information about whether a particular alias exists. + parameters: + - in: path + name: name + description: A comma-separated list of alias names to return + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/local" +get: + x-endpoint-group: indices.get_alias + description: Returns an alias. + parameters: + - in: path + name: name + description: A comma-separated list of alias names to return + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_alias.yaml b/openapi_spec/yaml/paths/_alias.yaml new file mode 100644 index 00000000..66d7fd40 --- /dev/null +++ b/openapi_spec/yaml/paths/_alias.yaml @@ -0,0 +1,9 @@ +--- +get: + x-endpoint-group: indices.get_alias + description: Returns an alias. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_aliases.yaml b/openapi_spec/yaml/paths/_aliases.yaml new file mode 100644 index 00000000..90616880 --- /dev/null +++ b/openapi_spec/yaml/paths/_aliases.yaml @@ -0,0 +1,15 @@ +--- +post: + x-endpoint-group: indices.update_aliases + description: Updates index aliases. + parameters: + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The definition of `actions` to perform + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_analyze.yaml b/openapi_spec/yaml/paths/_analyze.yaml new file mode 100644 index 00000000..14f9ac4a --- /dev/null +++ b/openapi_spec/yaml/paths/_analyze.yaml @@ -0,0 +1,21 @@ +--- +get: + x-endpoint-group: indices.analyze + description: Performs the analysis process on a text and return the tokens breakdown + of the text. + parameters: + - $ref: "../parameters/query.yaml#/index" +post: + x-endpoint-group: indices.analyze + description: Performs the analysis process on a text and return the tokens breakdown + of the text. + parameters: + - $ref: "../parameters/query.yaml#/index" + requestBody: + description: Define analyzer/tokenizer parameters and the text on which the analysis + should be performed + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_bulk.yaml b/openapi_spec/yaml/paths/_bulk.yaml new file mode 100644 index 00000000..25685841 --- /dev/null +++ b/openapi_spec/yaml/paths/_bulk.yaml @@ -0,0 +1,47 @@ +--- +post: + x-endpoint-group: bulk + description: Allows to perform multiple index/update/delete operations in a single + request. + parameters: + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/pipeline" + - $ref: "../parameters/query.yaml#/require_alias" + requestBody: + description: The operation definition and data (action-data pairs), separated + by newlines + required: true + content: + application/json: + schema: + type: object +put: + x-endpoint-group: bulk + description: Allows to perform multiple index/update/delete operations in a single + request. + parameters: + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/pipeline" + - $ref: "../parameters/query.yaml#/require_alias" + requestBody: + description: The operation definition and data (action-data pairs), separated + by newlines + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_cache.clear.yaml b/openapi_spec/yaml/paths/_cache.clear.yaml new file mode 100644 index 00000000..0aa9dee8 --- /dev/null +++ b/openapi_spec/yaml/paths/_cache.clear.yaml @@ -0,0 +1,13 @@ +--- +post: + x-endpoint-group: indices.clear_cache + description: Clears all or specific caches for one or more indices. + parameters: + - $ref: "../parameters/query.yaml#/fielddata" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/query" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/index" + - $ref: "../parameters/query.yaml#/request" diff --git a/openapi_spec/yaml/paths/_cat.aliases.(name).yaml b/openapi_spec/yaml/paths/_cat.aliases.(name).yaml new file mode 100644 index 00000000..609fc952 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.aliases.(name).yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: cat.aliases + description: Shows information about currently configured aliases to indices including + filter and routing infos. + parameters: + - in: path + name: name + description: A comma-separated list of alias names to return + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_cat.aliases.yaml b/openapi_spec/yaml/paths/_cat.aliases.yaml new file mode 100644 index 00000000..c2c9c5cb --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.aliases.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: cat.aliases + description: Shows information about currently configured aliases to indices including + filter and routing infos. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_cat.allocation.(node_id).yaml b/openapi_spec/yaml/paths/_cat.allocation.(node_id).yaml new file mode 100644 index 00000000..dbd1043a --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.allocation.(node_id).yaml @@ -0,0 +1,22 @@ +--- +get: + x-endpoint-group: cat.allocation + description: Provides a snapshot of how many shards are allocated to each data node + and how much disk space they are using. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.allocation.yaml b/openapi_spec/yaml/paths/_cat.allocation.yaml new file mode 100644 index 00000000..8260b3e1 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.allocation.yaml @@ -0,0 +1,15 @@ +--- +get: + x-endpoint-group: cat.allocation + description: Provides a snapshot of how many shards are allocated to each data node + and how much disk space they are using. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.cluster_manager.yaml b/openapi_spec/yaml/paths/_cat.cluster_manager.yaml new file mode 100644 index 00000000..3910e31e --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.cluster_manager.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: cat.cluster_manager + description: Returns information about the cluster-manager node. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.count.(index).yaml b/openapi_spec/yaml/paths/_cat.count.(index).yaml new file mode 100644 index 00000000..c43960b7 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.count.(index).yaml @@ -0,0 +1,17 @@ +--- +get: + x-endpoint-group: cat.count + description: Provides quick access to the document count of the entire cluster, + or individual indices. + parameters: + - in: path + name: index + description: A comma-separated list of index names to limit the returned information + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.count.yaml b/openapi_spec/yaml/paths/_cat.count.yaml new file mode 100644 index 00000000..57bfc9f1 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.count.yaml @@ -0,0 +1,11 @@ +--- +get: + x-endpoint-group: cat.count + description: Provides quick access to the document count of the entire cluster, + or individual indices. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.fielddata.(fields).yaml b/openapi_spec/yaml/paths/_cat.fielddata.(fields).yaml new file mode 100644 index 00000000..c3edfd51 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.fielddata.(fields).yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: cat.fielddata + description: Shows how much heap memory is currently being used by fielddata on + every data node in the cluster. + parameters: + - in: path + name: fields + description: A comma-separated list of fields to return the fielddata size + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" + - $ref: "../parameters/query.yaml#/fields" diff --git a/openapi_spec/yaml/paths/_cat.fielddata.yaml b/openapi_spec/yaml/paths/_cat.fielddata.yaml new file mode 100644 index 00000000..04597ef5 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.fielddata.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: cat.fielddata + description: Shows how much heap memory is currently being used by fielddata on + every data node in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" + - $ref: "../parameters/query.yaml#/fields" diff --git a/openapi_spec/yaml/paths/_cat.health.yaml b/openapi_spec/yaml/paths/_cat.health.yaml new file mode 100644 index 00000000..668925b4 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.health.yaml @@ -0,0 +1,12 @@ +--- +get: + x-endpoint-group: cat.health + description: Returns a concise representation of the cluster health. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/ts" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.indices.(index).yaml b/openapi_spec/yaml/paths/_cat.indices.(index).yaml new file mode 100644 index 00000000..9195a4b4 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.indices.(index).yaml @@ -0,0 +1,26 @@ +--- +get: + x-endpoint-group: cat.indices + description: 'Returns information about indices: number of primaries and replicas, + document counts, disk size, ...' + parameters: + - in: path + name: index + description: A comma-separated list of index names to limit the returned information + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/health" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/pri" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" + - $ref: "../parameters/query.yaml#/include_unloaded_segments" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_cat.indices.yaml b/openapi_spec/yaml/paths/_cat.indices.yaml new file mode 100644 index 00000000..cba4d0a5 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.indices.yaml @@ -0,0 +1,20 @@ +--- +get: + x-endpoint-group: cat.indices + description: 'Returns information about indices: number of primaries and replicas, + document counts, disk size, ...' + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/health" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/pri" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" + - $ref: "../parameters/query.yaml#/include_unloaded_segments" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_cat.master.yaml b/openapi_spec/yaml/paths/_cat.master.yaml new file mode 100644 index 00000000..3910e31e --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.master.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: cat.cluster_manager + description: Returns information about the cluster-manager node. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.nodeattrs.yaml b/openapi_spec/yaml/paths/_cat.nodeattrs.yaml new file mode 100644 index 00000000..c28f8352 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.nodeattrs.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: cat.nodeattrs + description: Returns information about custom node attributes. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.nodes.yaml b/openapi_spec/yaml/paths/_cat.nodes.yaml new file mode 100644 index 00000000..9159700d --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.nodes.yaml @@ -0,0 +1,16 @@ +--- +get: + x-endpoint-group: cat.nodes + description: Returns basic statistics about performance of cluster nodes. + parameters: + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/full_id" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.pending_tasks.yaml b/openapi_spec/yaml/paths/_cat.pending_tasks.yaml new file mode 100644 index 00000000..4c120c3b --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.pending_tasks.yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: cat.pending_tasks + description: Returns a concise representation of the cluster pending tasks. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.plugins.yaml b/openapi_spec/yaml/paths/_cat.plugins.yaml new file mode 100644 index 00000000..0810d29c --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.plugins.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: cat.plugins + description: Returns information about installed plugins across nodes node. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.recovery.(index).yaml b/openapi_spec/yaml/paths/_cat.recovery.(index).yaml new file mode 100644 index 00000000..5e8e4560 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.recovery.(index).yaml @@ -0,0 +1,22 @@ +--- +get: + x-endpoint-group: cat.recovery + description: Returns information about index shard recoveries, both on-going completed. + parameters: + - in: path + name: index + description: Comma-separated list or wildcard expression of index names to limit + the returned information + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/active_only" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/detailed" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/index" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.recovery.yaml b/openapi_spec/yaml/paths/_cat.recovery.yaml new file mode 100644 index 00000000..c7c0b725 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.recovery.yaml @@ -0,0 +1,15 @@ +--- +get: + x-endpoint-group: cat.recovery + description: Returns information about index shard recoveries, both on-going completed. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/active_only" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/detailed" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/index" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.repositories.yaml b/openapi_spec/yaml/paths/_cat.repositories.yaml new file mode 100644 index 00000000..ff4ce00f --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.repositories.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: cat.repositories + description: Returns information about snapshot repositories registered in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.segment_replication.(index).yaml b/openapi_spec/yaml/paths/_cat.segment_replication.(index).yaml new file mode 100644 index 00000000..f301ad26 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.segment_replication.(index).yaml @@ -0,0 +1,25 @@ +--- +get: + x-endpoint-group: cat.segment_replication + description: Returns information about both on-going and latest completed Segment + Replication events + parameters: + - in: path + name: index + description: Comma-separated list or wildcard expression of index names to limit + the returned information + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/active_only" + - $ref: "../parameters/query.yaml#/completed_only" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/detailed" + - $ref: "../parameters/query.yaml#/shards" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/index" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.segment_replication.yaml b/openapi_spec/yaml/paths/_cat.segment_replication.yaml new file mode 100644 index 00000000..02752aea --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.segment_replication.yaml @@ -0,0 +1,18 @@ +--- +get: + x-endpoint-group: cat.segment_replication + description: Returns information about both on-going and latest completed Segment + Replication events + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/active_only" + - $ref: "../parameters/query.yaml#/completed_only" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/detailed" + - $ref: "../parameters/query.yaml#/shards" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/index" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.segments.(index).yaml b/openapi_spec/yaml/paths/_cat.segments.(index).yaml new file mode 100644 index 00000000..38392e7e --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.segments.(index).yaml @@ -0,0 +1,20 @@ +--- +get: + x-endpoint-group: cat.segments + description: Provides low-level information about the segments in the shards of + an index. + parameters: + - in: path + name: index + description: A comma-separated list of index names to limit the returned information + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.segments.yaml b/openapi_spec/yaml/paths/_cat.segments.yaml new file mode 100644 index 00000000..a7c7417f --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.segments.yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: cat.segments + description: Provides low-level information about the segments in the shards of + an index. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.shards.(index).yaml b/openapi_spec/yaml/paths/_cat.shards.(index).yaml new file mode 100644 index 00000000..1a156ded --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.shards.(index).yaml @@ -0,0 +1,21 @@ +--- +get: + x-endpoint-group: cat.shards + description: Provides a detailed view of shard allocation on nodes. + parameters: + - in: path + name: index + description: A comma-separated list of index names to limit the returned information + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.shards.yaml b/openapi_spec/yaml/paths/_cat.shards.yaml new file mode 100644 index 00000000..ad8b16df --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.shards.yaml @@ -0,0 +1,15 @@ +--- +get: + x-endpoint-group: cat.shards + description: Provides a detailed view of shard allocation on nodes. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/bytes" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.snapshots.(repository).yaml b/openapi_spec/yaml/paths/_cat.snapshots.(repository).yaml new file mode 100644 index 00000000..f0a5ed20 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.snapshots.(repository).yaml @@ -0,0 +1,20 @@ +--- +get: + x-endpoint-group: cat.snapshots + description: Returns all snapshots in a specific repository. + parameters: + - in: path + name: repository + description: Name of repository from which to fetch the snapshot information + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.snapshots.yaml b/openapi_spec/yaml/paths/_cat.snapshots.yaml new file mode 100644 index 00000000..2be3549f --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.snapshots.yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: cat.snapshots + description: Returns all snapshots in a specific repository. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.tasks.yaml b/openapi_spec/yaml/paths/_cat.tasks.yaml new file mode 100644 index 00000000..ebfc1ec3 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.tasks.yaml @@ -0,0 +1,16 @@ +--- +get: + x-endpoint-group: cat.tasks + description: Returns information about the tasks currently executing on one or more + nodes in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/nodes" + - $ref: "../parameters/query.yaml#/actions" + - $ref: "../parameters/query.yaml#/detailed" + - $ref: "../parameters/query.yaml#/parent_task_id" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/time" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.templates.(name).yaml b/openapi_spec/yaml/paths/_cat.templates.(name).yaml new file mode 100644 index 00000000..c3ae5184 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.templates.(name).yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: cat.templates + description: Returns information about existing templates. + parameters: + - in: path + name: name + description: A pattern that returned template names must match + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.templates.yaml b/openapi_spec/yaml/paths/_cat.templates.yaml new file mode 100644 index 00000000..bfbda6eb --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.templates.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: cat.templates + description: Returns information about existing templates. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.thread_pool.(thread_pool_patterns).yaml b/openapi_spec/yaml/paths/_cat.thread_pool.(thread_pool_patterns).yaml new file mode 100644 index 00000000..2bc8c4ce --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.thread_pool.(thread_pool_patterns).yaml @@ -0,0 +1,23 @@ +--- +get: + x-endpoint-group: cat.thread_pool + description: |- + Returns cluster-wide thread pool statistics per node. + By default the active, queue and rejected statistics are returned for all thread pools. + parameters: + - in: path + name: thread_pool_patterns + description: A comma-separated list of regular-expressions to filter the thread + pools in the output + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/size" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.thread_pool.yaml b/openapi_spec/yaml/paths/_cat.thread_pool.yaml new file mode 100644 index 00000000..c0eaa22f --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.thread_pool.yaml @@ -0,0 +1,16 @@ +--- +get: + x-endpoint-group: cat.thread_pool + description: |- + Returns cluster-wide thread pool statistics per node. + By default the active, queue and rejected statistics are returned for all thread pools. + parameters: + - $ref: "../parameters/query.yaml#/format" + - $ref: "../parameters/query.yaml#/size" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/h" + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" + - $ref: "../parameters/query.yaml#/v" diff --git a/openapi_spec/yaml/paths/_cat.yaml b/openapi_spec/yaml/paths/_cat.yaml new file mode 100644 index 00000000..5821cfd8 --- /dev/null +++ b/openapi_spec/yaml/paths/_cat.yaml @@ -0,0 +1,7 @@ +--- +get: + x-endpoint-group: cat.help + description: Returns help for the Cat APIs. + parameters: + - $ref: "../parameters/query.yaml#/help" + - $ref: "../parameters/query.yaml#/s" diff --git a/openapi_spec/yaml/paths/_cluster.allocation.explain.yaml b/openapi_spec/yaml/paths/_cluster.allocation.explain.yaml new file mode 100644 index 00000000..6aaa9c4d --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.allocation.explain.yaml @@ -0,0 +1,21 @@ +--- +get: + x-endpoint-group: cluster.allocation_explain + description: Provides explanations for shard allocations in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/include_yes_decisions" + - $ref: "../parameters/query.yaml#/include_disk_info" +post: + x-endpoint-group: cluster.allocation_explain + description: Provides explanations for shard allocations in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/include_yes_decisions" + - $ref: "../parameters/query.yaml#/include_disk_info" + requestBody: + description: The index, shard, and primary flag to explain. Empty means 'explain + the first unassigned shard' + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).yaml b/openapi_spec/yaml/paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).yaml new file mode 100644 index 00000000..b673040d --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.decommission.awareness.(awareness_attribute_name).(awareness_attribute_value).yaml @@ -0,0 +1,17 @@ +--- +put: + x-endpoint-group: cluster.put_decommission_awareness + description: Decommissions an awareness attribute + parameters: + - in: path + name: awareness_attribute_name + description: Awareness attribute name + required: true + schema: + type: string + - in: path + name: awareness_attribute_value + description: Awareness attribute value + required: true + schema: + type: string diff --git a/openapi_spec/yaml/paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.yaml b/openapi_spec/yaml/paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.yaml new file mode 100644 index 00000000..e6f4a251 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.decommission.awareness.(awareness_attribute_name)._status.yaml @@ -0,0 +1,11 @@ +--- +get: + x-endpoint-group: cluster.get_decommission_awareness + description: Get details and status of decommissioned attribute + parameters: + - in: path + name: awareness_attribute_name + description: Awareness attribute name + required: true + schema: + type: string diff --git a/openapi_spec/yaml/paths/_cluster.decommission.awareness..yaml b/openapi_spec/yaml/paths/_cluster.decommission.awareness..yaml new file mode 100644 index 00000000..9d264b37 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.decommission.awareness..yaml @@ -0,0 +1,5 @@ +--- +delete: + x-endpoint-group: cluster.delete_decommission_awareness + description: Delete any existing decommission. + parameters: [] diff --git a/openapi_spec/yaml/paths/_cluster.health.(index).yaml b/openapi_spec/yaml/paths/_cluster.health.(index).yaml new file mode 100644 index 00000000..8c9f8ba8 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.health.(index).yaml @@ -0,0 +1,25 @@ +--- +get: + x-endpoint-group: cluster.health + description: Returns basic information about the health of the cluster. + parameters: + - in: path + name: index + description: Limit the information returned to a specific index + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/wait_for_nodes" + - $ref: "../parameters/query.yaml#/wait_for_events" + - $ref: "../parameters/query.yaml#/wait_for_no_relocating_shards" + - $ref: "../parameters/query.yaml#/wait_for_no_initializing_shards" + - $ref: "../parameters/query.yaml#/wait_for_status" + - $ref: "../parameters/query.yaml#/awareness_attribute" + - $ref: "../parameters/query.yaml#/ensure_node_commissioned" diff --git a/openapi_spec/yaml/paths/_cluster.health.yaml b/openapi_spec/yaml/paths/_cluster.health.yaml new file mode 100644 index 00000000..0a700f36 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.health.yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: cluster.health + description: Returns basic information about the health of the cluster. + parameters: + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/wait_for_nodes" + - $ref: "../parameters/query.yaml#/wait_for_events" + - $ref: "../parameters/query.yaml#/wait_for_no_relocating_shards" + - $ref: "../parameters/query.yaml#/wait_for_no_initializing_shards" + - $ref: "../parameters/query.yaml#/wait_for_status" + - $ref: "../parameters/query.yaml#/awareness_attribute" + - $ref: "../parameters/query.yaml#/ensure_node_commissioned" diff --git a/openapi_spec/yaml/paths/_cluster.nodes.(node_id).hot_threads.yaml b/openapi_spec/yaml/paths/_cluster.nodes.(node_id).hot_threads.yaml new file mode 100644 index 00000000..d8b8384b --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.nodes.(node_id).hot_threads.yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: nodes.hot_threads + description: Returns information about hot threads on each node in the cluster. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/interval" + - $ref: "../parameters/query.yaml#/snapshots" + - $ref: "../parameters/query.yaml#/threads" + - $ref: "../parameters/query.yaml#/ignore_idle_threads" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_cluster.nodes.(node_id).hotthreads.yaml b/openapi_spec/yaml/paths/_cluster.nodes.(node_id).hotthreads.yaml new file mode 100644 index 00000000..d8b8384b --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.nodes.(node_id).hotthreads.yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: nodes.hot_threads + description: Returns information about hot threads on each node in the cluster. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/interval" + - $ref: "../parameters/query.yaml#/snapshots" + - $ref: "../parameters/query.yaml#/threads" + - $ref: "../parameters/query.yaml#/ignore_idle_threads" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_cluster.nodes.hot_threads.yaml b/openapi_spec/yaml/paths/_cluster.nodes.hot_threads.yaml new file mode 100644 index 00000000..73cd6d2e --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.nodes.hot_threads.yaml @@ -0,0 +1,11 @@ +--- +get: + x-endpoint-group: nodes.hot_threads + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/interval" + - $ref: "../parameters/query.yaml#/snapshots" + - $ref: "../parameters/query.yaml#/threads" + - $ref: "../parameters/query.yaml#/ignore_idle_threads" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_cluster.nodes.hotthreads.yaml b/openapi_spec/yaml/paths/_cluster.nodes.hotthreads.yaml new file mode 100644 index 00000000..73cd6d2e --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.nodes.hotthreads.yaml @@ -0,0 +1,11 @@ +--- +get: + x-endpoint-group: nodes.hot_threads + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/interval" + - $ref: "../parameters/query.yaml#/snapshots" + - $ref: "../parameters/query.yaml#/threads" + - $ref: "../parameters/query.yaml#/ignore_idle_threads" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_cluster.pending_tasks.yaml b/openapi_spec/yaml/paths/_cluster.pending_tasks.yaml new file mode 100644 index 00000000..da4306ff --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.pending_tasks.yaml @@ -0,0 +1,10 @@ +--- +get: + x-endpoint-group: cluster.pending_tasks + description: |- + Returns a list of any cluster-level changes (e.g. create index, update mapping, + allocate or fail shard) which have not yet been executed. + parameters: + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" diff --git a/openapi_spec/yaml/paths/_cluster.reroute.yaml b/openapi_spec/yaml/paths/_cluster.reroute.yaml new file mode 100644 index 00000000..c5c2e2f5 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.reroute.yaml @@ -0,0 +1,20 @@ +--- +post: + x-endpoint-group: cluster.reroute + description: Allows to manually change the allocation of individual shards in the + cluster. + parameters: + - $ref: "../parameters/query.yaml#/dry_run" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/retry_failed" + - $ref: "../parameters/query.yaml#/metric" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + requestBody: + description: The definition of `commands` to perform (`move`, `cancel`, `allocate`) + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_cluster.routing.awareness.(attribute).weights.yaml b/openapi_spec/yaml/paths/_cluster.routing.awareness.(attribute).weights.yaml new file mode 100644 index 00000000..4ea9cf3a --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.routing.awareness.(attribute).weights.yaml @@ -0,0 +1,21 @@ +--- +put: + x-endpoint-group: cluster.put_weighted_routing + description: Updates weighted shard routing weights + parameters: + - in: path + name: attribute + description: Awareness attribute name + required: true + schema: + type: string +get: + x-endpoint-group: cluster.get_weighted_routing + description: Fetches weighted shard routing weights + parameters: + - in: path + name: attribute + description: Awareness attribute name + required: true + schema: + type: string diff --git a/openapi_spec/yaml/paths/_cluster.routing.awareness.weights.yaml b/openapi_spec/yaml/paths/_cluster.routing.awareness.weights.yaml new file mode 100644 index 00000000..5b2900dc --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.routing.awareness.weights.yaml @@ -0,0 +1,5 @@ +--- +delete: + x-endpoint-group: cluster.delete_weighted_routing + description: Delete weighted shard routing weights + parameters: [] diff --git a/openapi_spec/yaml/paths/_cluster.settings.yaml b/openapi_spec/yaml/paths/_cluster.settings.yaml new file mode 100644 index 00000000..b45b1786 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.settings.yaml @@ -0,0 +1,26 @@ +--- +put: + x-endpoint-group: cluster.put_settings + description: Updates the cluster settings. + parameters: + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + requestBody: + description: The settings to be updated. Can be either `transient` or `persistent` + (survives cluster restart). + required: true + content: + application/json: + schema: + type: object +get: + x-endpoint-group: cluster.get_settings + description: Returns cluster settings. + parameters: + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/include_defaults" diff --git a/openapi_spec/yaml/paths/_cluster.state.(metric).(index).yaml b/openapi_spec/yaml/paths/_cluster.state.(metric).(index).yaml new file mode 100644 index 00000000..fa8ae180 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.state.(metric).(index).yaml @@ -0,0 +1,27 @@ +--- +get: + x-endpoint-group: cluster.state + description: Returns a comprehensive information about the state of the cluster. + parameters: + - in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string + to perform the operation on all indices + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/wait_for_metadata_version" + - $ref: "../parameters/query.yaml#/wait_for_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_cluster.state.(metric).yaml b/openapi_spec/yaml/paths/_cluster.state.(metric).yaml new file mode 100644 index 00000000..2f3b3e1b --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.state.(metric).yaml @@ -0,0 +1,20 @@ +--- +get: + x-endpoint-group: cluster.state + description: Returns a comprehensive information about the state of the cluster. + parameters: + - in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/wait_for_metadata_version" + - $ref: "../parameters/query.yaml#/wait_for_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_cluster.state.yaml b/openapi_spec/yaml/paths/_cluster.state.yaml new file mode 100644 index 00000000..4b5a59ff --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.state.yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: cluster.state + description: Returns a comprehensive information about the state of the cluster. + parameters: + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/wait_for_metadata_version" + - $ref: "../parameters/query.yaml#/wait_for_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_cluster.stats.nodes.(node_id).yaml b/openapi_spec/yaml/paths/_cluster.stats.nodes.(node_id).yaml new file mode 100644 index 00000000..bf7f5393 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.stats.nodes.(node_id).yaml @@ -0,0 +1,15 @@ +--- +get: + x-endpoint-group: cluster.stats + description: Returns high-level overview of cluster statistics. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_cluster.stats.yaml b/openapi_spec/yaml/paths/_cluster.stats.yaml new file mode 100644 index 00000000..1283264d --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.stats.yaml @@ -0,0 +1,7 @@ +--- +get: + x-endpoint-group: cluster.stats + description: Returns high-level overview of cluster statistics. + parameters: + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_cluster.voting_config_exclusions.yaml b/openapi_spec/yaml/paths/_cluster.voting_config_exclusions.yaml new file mode 100644 index 00000000..c5e33770 --- /dev/null +++ b/openapi_spec/yaml/paths/_cluster.voting_config_exclusions.yaml @@ -0,0 +1,13 @@ +--- +post: + x-endpoint-group: cluster.post_voting_config_exclusions + description: Updates the cluster voting config exclusions by node ids or node names. + parameters: + - $ref: "../parameters/query.yaml#/node_ids" + - $ref: "../parameters/query.yaml#/node_names" + - $ref: "../parameters/query.yaml#/timeout" +delete: + x-endpoint-group: cluster.delete_voting_config_exclusions + description: Clears cluster voting config exclusions. + parameters: + - $ref: "../parameters/query.yaml#/wait_for_removal" diff --git a/openapi_spec/yaml/paths/_component_template.(name).yaml b/openapi_spec/yaml/paths/_component_template.(name).yaml new file mode 100644 index 00000000..8c237b80 --- /dev/null +++ b/openapi_spec/yaml/paths/_component_template.(name).yaml @@ -0,0 +1,81 @@ +--- +put: + x-endpoint-group: cluster.put_component_template + description: Creates or updates a component template + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The template definition + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: cluster.put_component_template + description: Creates or updates a component template + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The template definition + required: true + content: + application/json: + schema: + type: object +delete: + x-endpoint-group: cluster.delete_component_template + description: Deletes a component template + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" +head: + x-endpoint-group: cluster.exists_component_template + description: Returns information about whether a particular component template exist + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/local" +get: + x-endpoint-group: cluster.get_component_template + description: Returns one or more component templates + parameters: + - in: path + name: name + description: The comma separated names of the component templates + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_component_template.yaml b/openapi_spec/yaml/paths/_component_template.yaml new file mode 100644 index 00000000..fba769c6 --- /dev/null +++ b/openapi_spec/yaml/paths/_component_template.yaml @@ -0,0 +1,8 @@ +--- +get: + x-endpoint-group: cluster.get_component_template + description: Returns one or more component templates + parameters: + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_count.yaml b/openapi_spec/yaml/paths/_count.yaml new file mode 100644 index 00000000..a7f9014d --- /dev/null +++ b/openapi_spec/yaml/paths/_count.yaml @@ -0,0 +1,44 @@ +--- +post: + x-endpoint-group: count + description: Returns number of documents matching a query. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/min_score" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/terminate_after" + requestBody: + description: A query to restrict the results specified with the Query DSL (optional) + required: false + content: + application/json: + schema: + type: object +get: + x-endpoint-group: count + description: Returns number of documents matching a query. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/min_score" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/terminate_after" diff --git a/openapi_spec/yaml/paths/_dangling.(index_uuid).yaml b/openapi_spec/yaml/paths/_dangling.(index_uuid).yaml new file mode 100644 index 00000000..57e4b73f --- /dev/null +++ b/openapi_spec/yaml/paths/_dangling.(index_uuid).yaml @@ -0,0 +1,29 @@ +--- +post: + x-endpoint-group: dangling_indices.import_dangling_index + description: Imports the specified dangling index + parameters: + - in: path + name: index_uuid + description: The UUID of the dangling index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/accept_data_loss" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" +delete: + x-endpoint-group: dangling_indices.delete_dangling_index + description: Deletes the specified dangling index + parameters: + - in: path + name: index_uuid + description: The UUID of the dangling index + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/accept_data_loss" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" diff --git a/openapi_spec/yaml/paths/_dangling.yaml b/openapi_spec/yaml/paths/_dangling.yaml new file mode 100644 index 00000000..41187504 --- /dev/null +++ b/openapi_spec/yaml/paths/_dangling.yaml @@ -0,0 +1,5 @@ +--- +get: + x-endpoint-group: dangling_indices.list_dangling_indices + description: Returns all dangling indices. + parameters: [] diff --git a/openapi_spec/yaml/paths/_data_stream.(name)._stats.yaml b/openapi_spec/yaml/paths/_data_stream.(name)._stats.yaml new file mode 100644 index 00000000..f83d6c90 --- /dev/null +++ b/openapi_spec/yaml/paths/_data_stream.(name)._stats.yaml @@ -0,0 +1,12 @@ +--- +get: + x-endpoint-group: indices.data_streams_stats + description: Provides statistics on operations happening in a data stream. + parameters: + - in: path + name: name + description: A comma-separated list of data stream names; use `_all` or empty + string to perform the operation on all data streams + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" diff --git a/openapi_spec/yaml/paths/_data_stream.(name).yaml b/openapi_spec/yaml/paths/_data_stream.(name).yaml new file mode 100644 index 00000000..25e34633 --- /dev/null +++ b/openapi_spec/yaml/paths/_data_stream.(name).yaml @@ -0,0 +1,40 @@ +--- +delete: + x-endpoint-group: indices.delete_data_stream + description: Deletes a data stream. + parameters: + - in: path + name: name + description: A comma-separated list of data streams to delete; use `*` to delete + all data streams + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" +get: + x-endpoint-group: indices.get_data_stream + description: Returns data streams. + parameters: + - in: path + name: name + description: A comma-separated list of data streams to get; use `*` to get all + data streams + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" +put: + x-endpoint-group: indices.create_data_stream + description: Creates or updates a data stream + parameters: + - in: path + name: name + description: The name of the data stream + required: true + schema: + type: string + requestBody: + description: The data stream definition + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_data_stream._stats.yaml b/openapi_spec/yaml/paths/_data_stream._stats.yaml new file mode 100644 index 00000000..3759edce --- /dev/null +++ b/openapi_spec/yaml/paths/_data_stream._stats.yaml @@ -0,0 +1,5 @@ +--- +get: + x-endpoint-group: indices.data_streams_stats + description: Provides statistics on operations happening in a data stream. + parameters: [] diff --git a/openapi_spec/yaml/paths/_data_stream.yaml b/openapi_spec/yaml/paths/_data_stream.yaml new file mode 100644 index 00000000..611230cd --- /dev/null +++ b/openapi_spec/yaml/paths/_data_stream.yaml @@ -0,0 +1,5 @@ +--- +get: + x-endpoint-group: indices.get_data_stream + description: Returns data streams. + parameters: [] diff --git a/openapi_spec/yaml/paths/_delete_by_query.(task_id)._rethrottle.yaml b/openapi_spec/yaml/paths/_delete_by_query.(task_id)._rethrottle.yaml new file mode 100644 index 00000000..15fa9756 --- /dev/null +++ b/openapi_spec/yaml/paths/_delete_by_query.(task_id)._rethrottle.yaml @@ -0,0 +1,13 @@ +--- +post: + x-endpoint-group: delete_by_query_rethrottle + description: Changes the number of requests per second for a particular Delete By + Query operation. + parameters: + - in: path + name: task_id + description: The task id to rethrottle + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/requests_per_second" diff --git a/openapi_spec/yaml/paths/_field_caps.yaml b/openapi_spec/yaml/paths/_field_caps.yaml new file mode 100644 index 00000000..f329e485 --- /dev/null +++ b/openapi_spec/yaml/paths/_field_caps.yaml @@ -0,0 +1,28 @@ +--- +get: + x-endpoint-group: field_caps + description: Returns the information about the capabilities of fields among multiple + indices. + parameters: + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/include_unmapped" +post: + x-endpoint-group: field_caps + description: Returns the information about the capabilities of fields among multiple + indices. + parameters: + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/include_unmapped" + requestBody: + description: An index filter specified with the Query DSL + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_flush.yaml b/openapi_spec/yaml/paths/_flush.yaml new file mode 100644 index 00000000..76c79458 --- /dev/null +++ b/openapi_spec/yaml/paths/_flush.yaml @@ -0,0 +1,19 @@ +--- +post: + x-endpoint-group: indices.flush + description: Performs the flush operation on one or more indices. + parameters: + - $ref: "../parameters/query.yaml#/force" + - $ref: "../parameters/query.yaml#/wait_if_ongoing" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" +get: + x-endpoint-group: indices.flush + description: Performs the flush operation on one or more indices. + parameters: + - $ref: "../parameters/query.yaml#/force" + - $ref: "../parameters/query.yaml#/wait_if_ongoing" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_forcemerge.yaml b/openapi_spec/yaml/paths/_forcemerge.yaml new file mode 100644 index 00000000..77dd2f04 --- /dev/null +++ b/openapi_spec/yaml/paths/_forcemerge.yaml @@ -0,0 +1,11 @@ +--- +post: + x-endpoint-group: indices.forcemerge + description: Performs the force merge operation on one or more indices. + parameters: + - $ref: "../parameters/query.yaml#/flush" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/max_num_segments" + - $ref: "../parameters/query.yaml#/only_expunge_deletes" diff --git a/openapi_spec/yaml/paths/_index_template.(name).yaml b/openapi_spec/yaml/paths/_index_template.(name).yaml new file mode 100644 index 00000000..2976c0b1 --- /dev/null +++ b/openapi_spec/yaml/paths/_index_template.(name).yaml @@ -0,0 +1,83 @@ +--- +get: + x-endpoint-group: indices.get_index_template + description: Returns an index template. + parameters: + - in: path + name: name + description: The comma separated names of the index templates + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" +put: + x-endpoint-group: indices.put_index_template + description: Creates or updates an index template. + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/cause" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The template definition + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: indices.put_index_template + description: Creates or updates an index template. + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/cause" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The template definition + required: true + content: + application/json: + schema: + type: object +delete: + x-endpoint-group: indices.delete_index_template + description: Deletes an index template. + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" +head: + x-endpoint-group: indices.exists_index_template + description: Returns information about whether a particular index template exists. + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_index_template._simulate.(name).yaml b/openapi_spec/yaml/paths/_index_template._simulate.(name).yaml new file mode 100644 index 00000000..8432eca7 --- /dev/null +++ b/openapi_spec/yaml/paths/_index_template._simulate.(name).yaml @@ -0,0 +1,23 @@ +--- +post: + x-endpoint-group: indices.simulate_template + description: Simulate resolving the given template name or body + parameters: + - in: path + name: name + description: The name of the index template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/cause" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: New index template definition to be simulated, if no index template + name is specified + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_index_template._simulate.yaml b/openapi_spec/yaml/paths/_index_template._simulate.yaml new file mode 100644 index 00000000..ad7fffc7 --- /dev/null +++ b/openapi_spec/yaml/paths/_index_template._simulate.yaml @@ -0,0 +1,17 @@ +--- +post: + x-endpoint-group: indices.simulate_template + description: Simulate resolving the given template name or body + parameters: + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/cause" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: New index template definition to be simulated, if no index template + name is specified + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_index_template._simulate_index.(name).yaml b/openapi_spec/yaml/paths/_index_template._simulate_index.(name).yaml new file mode 100644 index 00000000..f7f10329 --- /dev/null +++ b/openapi_spec/yaml/paths/_index_template._simulate_index.(name).yaml @@ -0,0 +1,24 @@ +--- +post: + x-endpoint-group: indices.simulate_index_template + description: Simulate matching the given index name against the index templates + in the system + parameters: + - in: path + name: name + description: The name of the index (it must be a concrete index name) + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/cause" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: New index template definition, which will be included in the simulation, + as if it already exists in the system + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_index_template.yaml b/openapi_spec/yaml/paths/_index_template.yaml new file mode 100644 index 00000000..3c6a7a4c --- /dev/null +++ b/openapi_spec/yaml/paths/_index_template.yaml @@ -0,0 +1,9 @@ +--- +get: + x-endpoint-group: indices.get_index_template + description: Returns an index template. + parameters: + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_ingest.pipeline.(id)._simulate.yaml b/openapi_spec/yaml/paths/_ingest.pipeline.(id)._simulate.yaml new file mode 100644 index 00000000..f3e80438 --- /dev/null +++ b/openapi_spec/yaml/paths/_ingest.pipeline.(id)._simulate.yaml @@ -0,0 +1,30 @@ +--- +get: + x-endpoint-group: ingest.simulate + description: Allows to simulate a pipeline with example documents. + parameters: + - in: path + name: id + description: Pipeline ID + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/verbose" +post: + x-endpoint-group: ingest.simulate + description: Allows to simulate a pipeline with example documents. + parameters: + - in: path + name: id + description: Pipeline ID + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/verbose" + requestBody: + description: The simulate definition + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_ingest.pipeline.(id).yaml b/openapi_spec/yaml/paths/_ingest.pipeline.(id).yaml new file mode 100644 index 00000000..a3efd05e --- /dev/null +++ b/openapi_spec/yaml/paths/_ingest.pipeline.(id).yaml @@ -0,0 +1,46 @@ +--- +put: + x-endpoint-group: ingest.put_pipeline + description: Creates or updates a pipeline. + parameters: + - in: path + name: id + description: Pipeline ID + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + requestBody: + description: The ingest definition + required: true + content: + application/json: + schema: + type: object +delete: + x-endpoint-group: ingest.delete_pipeline + description: Deletes a pipeline. + parameters: + - in: path + name: id + description: Pipeline ID + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" +get: + x-endpoint-group: ingest.get_pipeline + description: Returns a pipeline. + parameters: + - in: path + name: id + description: Comma separated list of pipeline ids. Wildcards supported + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" diff --git a/openapi_spec/yaml/paths/_ingest.pipeline._simulate.yaml b/openapi_spec/yaml/paths/_ingest.pipeline._simulate.yaml new file mode 100644 index 00000000..9581591a --- /dev/null +++ b/openapi_spec/yaml/paths/_ingest.pipeline._simulate.yaml @@ -0,0 +1,18 @@ +--- +get: + x-endpoint-group: ingest.simulate + description: Allows to simulate a pipeline with example documents. + parameters: + - $ref: "../parameters/query.yaml#/verbose" +post: + x-endpoint-group: ingest.simulate + description: Allows to simulate a pipeline with example documents. + parameters: + - $ref: "../parameters/query.yaml#/verbose" + requestBody: + description: The simulate definition + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_ingest.pipeline.yaml b/openapi_spec/yaml/paths/_ingest.pipeline.yaml new file mode 100644 index 00000000..0d0157a7 --- /dev/null +++ b/openapi_spec/yaml/paths/_ingest.pipeline.yaml @@ -0,0 +1,7 @@ +--- +get: + x-endpoint-group: ingest.get_pipeline + description: Returns a pipeline. + parameters: + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" diff --git a/openapi_spec/yaml/paths/_ingest.processor.grok.yaml b/openapi_spec/yaml/paths/_ingest.processor.grok.yaml new file mode 100644 index 00000000..c8d27785 --- /dev/null +++ b/openapi_spec/yaml/paths/_ingest.processor.grok.yaml @@ -0,0 +1,5 @@ +--- +get: + x-endpoint-group: ingest.processor_grok + description: Returns a list of the built-in patterns. + parameters: [] diff --git a/openapi_spec/yaml/paths/_mapping.field.(fields).yaml b/openapi_spec/yaml/paths/_mapping.field.(fields).yaml new file mode 100644 index 00000000..91041279 --- /dev/null +++ b/openapi_spec/yaml/paths/_mapping.field.(fields).yaml @@ -0,0 +1,16 @@ +--- +get: + x-endpoint-group: indices.get_field_mapping + description: Returns mapping for one or more fields. + parameters: + - in: path + name: fields + description: A comma-separated list of fields + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/include_defaults" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_mapping.yaml b/openapi_spec/yaml/paths/_mapping.yaml new file mode 100644 index 00000000..fa36eb5a --- /dev/null +++ b/openapi_spec/yaml/paths/_mapping.yaml @@ -0,0 +1,11 @@ +--- +get: + x-endpoint-group: indices.get_mapping + description: Returns mappings for one or more indices. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_mget.yaml b/openapi_spec/yaml/paths/_mget.yaml new file mode 100644 index 00000000..0e451204 --- /dev/null +++ b/openapi_spec/yaml/paths/_mget.yaml @@ -0,0 +1,33 @@ +--- +get: + x-endpoint-group: mget + description: Allows to get multiple documents in one request. + parameters: + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" +post: + x-endpoint-group: mget + description: Allows to get multiple documents in one request. + parameters: + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + requestBody: + description: Document identifiers; can be either `docs` (containing full document + information) or `ids` (when index is provided in the URL. + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_msearch.template.yaml b/openapi_spec/yaml/paths/_msearch.template.yaml new file mode 100644 index 00000000..04dd924d --- /dev/null +++ b/openapi_spec/yaml/paths/_msearch.template.yaml @@ -0,0 +1,27 @@ +--- +get: + x-endpoint-group: msearch_template + description: Allows to execute several search template operations in one request. + parameters: + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/max_concurrent_searches" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" +post: + x-endpoint-group: msearch_template + description: Allows to execute several search template operations in one request. + parameters: + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/max_concurrent_searches" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + requestBody: + description: The request definitions (metadata-search request definition pairs), + separated by newlines + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_msearch.yaml b/openapi_spec/yaml/paths/_msearch.yaml new file mode 100644 index 00000000..9b66ce3f --- /dev/null +++ b/openapi_spec/yaml/paths/_msearch.yaml @@ -0,0 +1,31 @@ +--- +get: + x-endpoint-group: msearch + description: Allows to execute several search operations in one request. + parameters: + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/max_concurrent_searches" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/pre_filter_shard_size" + - $ref: "../parameters/query.yaml#/max_concurrent_shard_requests" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" +post: + x-endpoint-group: msearch + description: Allows to execute several search operations in one request. + parameters: + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/max_concurrent_searches" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/pre_filter_shard_size" + - $ref: "../parameters/query.yaml#/max_concurrent_shard_requests" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + requestBody: + description: The request definitions (metadata-search request definition pairs), + separated by newlines + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_mtermvectors.yaml b/openapi_spec/yaml/paths/_mtermvectors.yaml new file mode 100644 index 00000000..3d00fffa --- /dev/null +++ b/openapi_spec/yaml/paths/_mtermvectors.yaml @@ -0,0 +1,41 @@ +--- +get: + x-endpoint-group: mtermvectors + description: Returns multiple termvectors in one request. + parameters: + - $ref: "../parameters/query.yaml#/ids" + - $ref: "../parameters/query.yaml#/term_statistics" + - $ref: "../parameters/query.yaml#/field_statistics" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/offsets" + - $ref: "../parameters/query.yaml#/positions" + - $ref: "../parameters/query.yaml#/payloads" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" +post: + x-endpoint-group: mtermvectors + description: Returns multiple termvectors in one request. + parameters: + - $ref: "../parameters/query.yaml#/ids" + - $ref: "../parameters/query.yaml#/term_statistics" + - $ref: "../parameters/query.yaml#/field_statistics" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/offsets" + - $ref: "../parameters/query.yaml#/positions" + - $ref: "../parameters/query.yaml#/payloads" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/realtime" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/version_type" + requestBody: + description: Define ids, documents, parameters or a list of parameters per document + here. You must at least provide a list of document ids. See documentation. + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_nodes.(metric).yaml b/openapi_spec/yaml/paths/_nodes.(metric).yaml new file mode 100644 index 00000000..09963be9 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(metric).yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: nodes.info + description: Returns information about nodes in the cluster. + parameters: + - in: path + name: metric + description: A comma-separated list of metrics you wish returned. Leave empty + to return all. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).(metric).yaml b/openapi_spec/yaml/paths/_nodes.(node_id).(metric).yaml new file mode 100644 index 00000000..78dfe0db --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).(metric).yaml @@ -0,0 +1,22 @@ +--- +get: + x-endpoint-group: nodes.info + description: Returns information about nodes in the cluster. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: metric + description: A comma-separated list of metrics you wish returned. Leave empty + to return all. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).hot_threads.yaml b/openapi_spec/yaml/paths/_nodes.(node_id).hot_threads.yaml new file mode 100644 index 00000000..d8b8384b --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).hot_threads.yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: nodes.hot_threads + description: Returns information about hot threads on each node in the cluster. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/interval" + - $ref: "../parameters/query.yaml#/snapshots" + - $ref: "../parameters/query.yaml#/threads" + - $ref: "../parameters/query.yaml#/ignore_idle_threads" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).hotthreads.yaml b/openapi_spec/yaml/paths/_nodes.(node_id).hotthreads.yaml new file mode 100644 index 00000000..d8b8384b --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).hotthreads.yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: nodes.hot_threads + description: Returns information about hot threads on each node in the cluster. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/interval" + - $ref: "../parameters/query.yaml#/snapshots" + - $ref: "../parameters/query.yaml#/threads" + - $ref: "../parameters/query.yaml#/ignore_idle_threads" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).reload_secure_settings.yaml b/openapi_spec/yaml/paths/_nodes.(node_id).reload_secure_settings.yaml new file mode 100644 index 00000000..e5270b84 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).reload_secure_settings.yaml @@ -0,0 +1,20 @@ +--- +post: + x-endpoint-group: nodes.reload_secure_settings + description: Reloads secure settings. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs to span the reload/reinit call. + Should stay empty because reloading usually involves all cluster nodes. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" + requestBody: + description: An object containing the password for the opensearch keystore + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).stats.(metric).(index_metric).yaml b/openapi_spec/yaml/paths/_nodes.(node_id).stats.(metric).(index_metric).yaml new file mode 100644 index 00000000..dff90c82 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).stats.(metric).(index_metric).yaml @@ -0,0 +1,34 @@ +--- +get: + x-endpoint-group: nodes.stats + description: Returns statistical information about nodes in the cluster. + parameters: + - in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: index_metric + description: Limit the information returned for `indices` metric to the specific + index metrics. Isn't used if `indices` (or `all`) metric isn't specified. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/types" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).stats.(metric).yaml b/openapi_spec/yaml/paths/_nodes.(node_id).stats.(metric).yaml new file mode 100644 index 00000000..39a2a124 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).stats.(metric).yaml @@ -0,0 +1,27 @@ +--- +get: + x-endpoint-group: nodes.stats + description: Returns statistical information about nodes in the cluster. + parameters: + - in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/types" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).stats.yaml b/openapi_spec/yaml/paths/_nodes.(node_id).stats.yaml new file mode 100644 index 00000000..dc2f82f0 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).stats.yaml @@ -0,0 +1,21 @@ +--- +get: + x-endpoint-group: nodes.stats + description: Returns statistical information about nodes in the cluster. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/types" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).usage.(metric).yaml b/openapi_spec/yaml/paths/_nodes.(node_id).usage.(metric).yaml new file mode 100644 index 00000000..2142f8cc --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).usage.(metric).yaml @@ -0,0 +1,20 @@ +--- +get: + x-endpoint-group: nodes.usage + description: Returns low-level information about REST actions usage on nodes. + parameters: + - in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).usage.yaml b/openapi_spec/yaml/paths/_nodes.(node_id).usage.yaml new file mode 100644 index 00000000..154fbc58 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).usage.yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: nodes.usage + description: Returns low-level information about REST actions usage on nodes. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.(node_id).yaml b/openapi_spec/yaml/paths/_nodes.(node_id).yaml new file mode 100644 index 00000000..3547bc65 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.(node_id).yaml @@ -0,0 +1,15 @@ +--- +get: + x-endpoint-group: nodes.info + description: Returns information about nodes in the cluster. + parameters: + - in: path + name: node_id + description: A comma-separated list of node IDs or names to limit the returned + information; use `_local` to return information from the node you're connecting + to, leave empty to get information from all nodes + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.hot_threads.yaml b/openapi_spec/yaml/paths/_nodes.hot_threads.yaml new file mode 100644 index 00000000..73cd6d2e --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.hot_threads.yaml @@ -0,0 +1,11 @@ +--- +get: + x-endpoint-group: nodes.hot_threads + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/interval" + - $ref: "../parameters/query.yaml#/snapshots" + - $ref: "../parameters/query.yaml#/threads" + - $ref: "../parameters/query.yaml#/ignore_idle_threads" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.hotthreads.yaml b/openapi_spec/yaml/paths/_nodes.hotthreads.yaml new file mode 100644 index 00000000..73cd6d2e --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.hotthreads.yaml @@ -0,0 +1,11 @@ +--- +get: + x-endpoint-group: nodes.hot_threads + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/interval" + - $ref: "../parameters/query.yaml#/snapshots" + - $ref: "../parameters/query.yaml#/threads" + - $ref: "../parameters/query.yaml#/ignore_idle_threads" + - $ref: "../parameters/query.yaml#/type" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.reload_secure_settings.yaml b/openapi_spec/yaml/paths/_nodes.reload_secure_settings.yaml new file mode 100644 index 00000000..bb76cb39 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.reload_secure_settings.yaml @@ -0,0 +1,13 @@ +--- +post: + x-endpoint-group: nodes.reload_secure_settings + description: Reloads secure settings. + parameters: + - $ref: "../parameters/query.yaml#/timeout" + requestBody: + description: An object containing the password for the opensearch keystore + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_nodes.stats.(metric).(index_metric).yaml b/openapi_spec/yaml/paths/_nodes.stats.(metric).(index_metric).yaml new file mode 100644 index 00000000..2f838040 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.stats.(metric).(index_metric).yaml @@ -0,0 +1,26 @@ +--- +get: + x-endpoint-group: nodes.stats + description: Returns statistical information about nodes in the cluster. + parameters: + - in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - in: path + name: index_metric + description: Limit the information returned for `indices` metric to the specific + index metrics. Isn't used if `indices` (or `all`) metric isn't specified. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/types" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" diff --git a/openapi_spec/yaml/paths/_nodes.stats.(metric).yaml b/openapi_spec/yaml/paths/_nodes.stats.(metric).yaml new file mode 100644 index 00000000..a12c1b08 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.stats.(metric).yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: nodes.stats + description: Returns statistical information about nodes in the cluster. + parameters: + - in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/types" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" diff --git a/openapi_spec/yaml/paths/_nodes.stats.yaml b/openapi_spec/yaml/paths/_nodes.stats.yaml new file mode 100644 index 00000000..62c4cfd7 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.stats.yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: nodes.stats + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/types" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" diff --git a/openapi_spec/yaml/paths/_nodes.usage.(metric).yaml b/openapi_spec/yaml/paths/_nodes.usage.(metric).yaml new file mode 100644 index 00000000..76fcbe1f --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.usage.(metric).yaml @@ -0,0 +1,12 @@ +--- +get: + x-endpoint-group: nodes.usage + description: Returns low-level information about REST actions usage on nodes. + parameters: + - in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.usage.yaml b/openapi_spec/yaml/paths/_nodes.usage.yaml new file mode 100644 index 00000000..ab682c8e --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.usage.yaml @@ -0,0 +1,6 @@ +--- +get: + x-endpoint-group: nodes.usage + description: Returns low-level information about REST actions usage on nodes. + parameters: + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_nodes.yaml b/openapi_spec/yaml/paths/_nodes.yaml new file mode 100644 index 00000000..81a144f9 --- /dev/null +++ b/openapi_spec/yaml/paths/_nodes.yaml @@ -0,0 +1,7 @@ +--- +get: + x-endpoint-group: nodes.info + description: Returns information about nodes in the cluster. + parameters: + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_rank_eval.yaml b/openapi_spec/yaml/paths/_rank_eval.yaml new file mode 100644 index 00000000..9ac4ec0f --- /dev/null +++ b/openapi_spec/yaml/paths/_rank_eval.yaml @@ -0,0 +1,27 @@ +--- +get: + x-endpoint-group: rank_eval + description: Allows to evaluate the quality of ranked search results over a set + of typical search queries + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/search_type" +post: + x-endpoint-group: rank_eval + description: Allows to evaluate the quality of ranked search results over a set + of typical search queries + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/search_type" + requestBody: + description: The ranking evaluation search definition, including search requests, + document ratings and ranking metric definition. + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_recovery.yaml b/openapi_spec/yaml/paths/_recovery.yaml new file mode 100644 index 00000000..63d282bf --- /dev/null +++ b/openapi_spec/yaml/paths/_recovery.yaml @@ -0,0 +1,7 @@ +--- +get: + x-endpoint-group: indices.recovery + description: Returns information about ongoing index shard recoveries. + parameters: + - $ref: "../parameters/query.yaml#/detailed" + - $ref: "../parameters/query.yaml#/active_only" diff --git a/openapi_spec/yaml/paths/_refresh.yaml b/openapi_spec/yaml/paths/_refresh.yaml new file mode 100644 index 00000000..fa2b61b6 --- /dev/null +++ b/openapi_spec/yaml/paths/_refresh.yaml @@ -0,0 +1,15 @@ +--- +post: + x-endpoint-group: indices.refresh + description: Performs the refresh operation in one or more indices. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" +get: + x-endpoint-group: indices.refresh + description: Performs the refresh operation in one or more indices. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_reindex.(task_id)._rethrottle.yaml b/openapi_spec/yaml/paths/_reindex.(task_id)._rethrottle.yaml new file mode 100644 index 00000000..99b6d045 --- /dev/null +++ b/openapi_spec/yaml/paths/_reindex.(task_id)._rethrottle.yaml @@ -0,0 +1,13 @@ +--- +post: + x-endpoint-group: reindex_rethrottle + description: Changes the number of requests per second for a particular Reindex + operation. + parameters: + - in: path + name: task_id + description: The task id to rethrottle + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/requests_per_second" diff --git a/openapi_spec/yaml/paths/_reindex.yaml b/openapi_spec/yaml/paths/_reindex.yaml new file mode 100644 index 00000000..e7d60cd4 --- /dev/null +++ b/openapi_spec/yaml/paths/_reindex.yaml @@ -0,0 +1,24 @@ +--- +post: + x-endpoint-group: reindex + description: |- + Allows to copy documents from one index to another, optionally filtering the source + documents by a query, changing the destination index settings, or fetching the + documents from a remote cluster. + parameters: + - $ref: "../parameters/query.yaml#/refresh" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/wait_for_active_shards" + - $ref: "../parameters/query.yaml#/wait_for_completion" + - $ref: "../parameters/query.yaml#/requests_per_second" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/slices" + - $ref: "../parameters/query.yaml#/max_docs" + requestBody: + description: The search definition using the Query DSL and the prototype for the + index request. + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_remote.info.yaml b/openapi_spec/yaml/paths/_remote.info.yaml new file mode 100644 index 00000000..465751aa --- /dev/null +++ b/openapi_spec/yaml/paths/_remote.info.yaml @@ -0,0 +1,5 @@ +--- +get: + x-endpoint-group: cluster.remote_info + description: Returns the information about configured remote clusters. + parameters: [] diff --git a/openapi_spec/yaml/paths/_remotestore._restore.yaml b/openapi_spec/yaml/paths/_remotestore._restore.yaml new file mode 100644 index 00000000..65a9f261 --- /dev/null +++ b/openapi_spec/yaml/paths/_remotestore._restore.yaml @@ -0,0 +1,14 @@ +--- +post: + x-endpoint-group: remote_store.restore + description: Restores from remote store. + parameters: + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_completion" + requestBody: + description: A comma separated list of index IDs + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_render.template.(id).yaml b/openapi_spec/yaml/paths/_render.template.(id).yaml new file mode 100644 index 00000000..559c2e32 --- /dev/null +++ b/openapi_spec/yaml/paths/_render.template.(id).yaml @@ -0,0 +1,28 @@ +--- +get: + x-endpoint-group: render_search_template + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - in: path + name: id + description: The id of the stored search template + required: true + schema: + type: string +post: + x-endpoint-group: render_search_template + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - in: path + name: id + description: The id of the stored search template + required: true + schema: + type: string + requestBody: + description: The search definition template and its params + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_render.template.yaml b/openapi_spec/yaml/paths/_render.template.yaml new file mode 100644 index 00000000..9b1dbf4a --- /dev/null +++ b/openapi_spec/yaml/paths/_render.template.yaml @@ -0,0 +1,16 @@ +--- +get: + x-endpoint-group: render_search_template + description: Allows to use the Mustache language to pre-render a search definition. + parameters: [] +post: + x-endpoint-group: render_search_template + description: Allows to use the Mustache language to pre-render a search definition. + parameters: [] + requestBody: + description: The search definition template and its params + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_resolve.index.(name).yaml b/openapi_spec/yaml/paths/_resolve.index.(name).yaml new file mode 100644 index 00000000..c88ce4fa --- /dev/null +++ b/openapi_spec/yaml/paths/_resolve.index.(name).yaml @@ -0,0 +1,12 @@ +--- +get: + x-endpoint-group: indices.resolve_index + description: Returns information about any matching indices, aliases, and data streams + parameters: + - in: path + name: name + description: A comma-separated list of names or wildcard expressions + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_script_context.yaml b/openapi_spec/yaml/paths/_script_context.yaml new file mode 100644 index 00000000..96d9f402 --- /dev/null +++ b/openapi_spec/yaml/paths/_script_context.yaml @@ -0,0 +1,5 @@ +--- +get: + x-endpoint-group: get_script_context + description: Returns all script contexts. + parameters: [] diff --git a/openapi_spec/yaml/paths/_script_language.yaml b/openapi_spec/yaml/paths/_script_language.yaml new file mode 100644 index 00000000..6d300e91 --- /dev/null +++ b/openapi_spec/yaml/paths/_script_language.yaml @@ -0,0 +1,5 @@ +--- +get: + x-endpoint-group: get_script_languages + description: Returns available script types, languages and contexts + parameters: [] diff --git a/openapi_spec/yaml/paths/_scripts.(id).(context).yaml b/openapi_spec/yaml/paths/_scripts.(id).(context).yaml new file mode 100644 index 00000000..1c5fa9fa --- /dev/null +++ b/openapi_spec/yaml/paths/_scripts.(id).(context).yaml @@ -0,0 +1,55 @@ +--- +put: + x-endpoint-group: put_script + description: Creates or updates a script. + parameters: + - in: path + name: id + description: Script ID + required: true + schema: + type: string + - in: path + name: context + description: Script context + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/context" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: put_script + description: Creates or updates a script. + parameters: + - in: path + name: id + description: Script ID + required: true + schema: + type: string + - in: path + name: context + description: Script context + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/context" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_scripts.(id).yaml b/openapi_spec/yaml/paths/_scripts.(id).yaml new file mode 100644 index 00000000..9a49fa33 --- /dev/null +++ b/openapi_spec/yaml/paths/_scripts.(id).yaml @@ -0,0 +1,68 @@ +--- +delete: + x-endpoint-group: delete_script + description: Deletes a script. + parameters: + - in: path + name: id + description: Script ID + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" +get: + x-endpoint-group: get_script + description: Returns a script. + parameters: + - in: path + name: id + description: Script ID + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" +put: + x-endpoint-group: put_script + description: Creates or updates a script. + parameters: + - in: path + name: id + description: Script ID + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/context" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: put_script + description: Creates or updates a script. + parameters: + - in: path + name: id + description: Script ID + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/context" + requestBody: + description: The document + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_scripts.painless._execute.yaml b/openapi_spec/yaml/paths/_scripts.painless._execute.yaml new file mode 100644 index 00000000..bfe5adb2 --- /dev/null +++ b/openapi_spec/yaml/paths/_scripts.painless._execute.yaml @@ -0,0 +1,16 @@ +--- +get: + x-endpoint-group: scripts_painless_execute + description: Allows an arbitrary script to be executed and a result to be returned + parameters: [] +post: + x-endpoint-group: scripts_painless_execute + description: Allows an arbitrary script to be executed and a result to be returned + parameters: [] + requestBody: + description: The script to execute + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_search.point_in_time._all.yaml b/openapi_spec/yaml/paths/_search.point_in_time._all.yaml new file mode 100644 index 00000000..c27070f5 --- /dev/null +++ b/openapi_spec/yaml/paths/_search.point_in_time._all.yaml @@ -0,0 +1,9 @@ +--- +delete: + x-endpoint-group: delete_all_pits + description: Deletes all active point in time searches. + parameters: [] +get: + x-endpoint-group: get_all_pits + description: Lists all active point in time searches. + parameters: [] diff --git a/openapi_spec/yaml/paths/_search.point_in_time.yaml b/openapi_spec/yaml/paths/_search.point_in_time.yaml new file mode 100644 index 00000000..8e59caad --- /dev/null +++ b/openapi_spec/yaml/paths/_search.point_in_time.yaml @@ -0,0 +1,5 @@ +--- +delete: + x-endpoint-group: delete_pit + description: Deletes one or more point in time searches based on the IDs passed. + parameters: [] diff --git a/openapi_spec/yaml/paths/_search.scroll.(scroll_id).yaml b/openapi_spec/yaml/paths/_search.scroll.(scroll_id).yaml new file mode 100644 index 00000000..67a06675 --- /dev/null +++ b/openapi_spec/yaml/paths/_search.scroll.(scroll_id).yaml @@ -0,0 +1,49 @@ +--- +delete: + x-endpoint-group: clear_scroll + description: Explicitly clears the search context for a scroll. + parameters: + - in: path + name: scroll_id + description: A comma-separated list of scroll IDs to clear + required: true + deprecated: true + schema: + $ref: "../schemas/_common.yaml#/string_array" +get: + x-endpoint-group: scroll + description: Allows to retrieve a large numbers of results from a single search + request. + parameters: + - in: path + name: scroll_id + description: The scroll ID + required: true + deprecated: true + schema: + type: string + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/scroll_id" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" +post: + x-endpoint-group: scroll + description: Allows to retrieve a large numbers of results from a single search + request. + parameters: + - in: path + name: scroll_id + description: The scroll ID + required: true + deprecated: true + schema: + type: string + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/scroll_id" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + requestBody: + description: The scroll ID if not passed by URL or query parameter. + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_search.scroll.yaml b/openapi_spec/yaml/paths/_search.scroll.yaml new file mode 100644 index 00000000..5e3978cc --- /dev/null +++ b/openapi_spec/yaml/paths/_search.scroll.yaml @@ -0,0 +1,28 @@ +--- +delete: + x-endpoint-group: clear_scroll + description: Explicitly clears the search context for a scroll. + parameters: [] +get: + x-endpoint-group: scroll + description: Allows to retrieve a large numbers of results from a single search + request. + parameters: + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/scroll_id" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" +post: + x-endpoint-group: scroll + description: Allows to retrieve a large numbers of results from a single search + request. + parameters: + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/scroll_id" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + requestBody: + description: The scroll ID if not passed by URL or query parameter. + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_search.template.yaml b/openapi_spec/yaml/paths/_search.template.yaml new file mode 100644 index 00000000..da9ec28c --- /dev/null +++ b/openapi_spec/yaml/paths/_search.template.yaml @@ -0,0 +1,42 @@ +--- +get: + x-endpoint-group: search_template + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/profile" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" +post: + x-endpoint-group: search_template + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/profile" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + requestBody: + description: The search definition template and its params + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_search.yaml b/openapi_spec/yaml/paths/_search.yaml new file mode 100644 index 00000000..4f790fc6 --- /dev/null +++ b/openapi_spec/yaml/paths/_search.yaml @@ -0,0 +1,100 @@ +--- +get: + x-endpoint-group: search + description: Returns results matching a query. + parameters: + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/docvalue_fields" + - $ref: "../parameters/query.yaml#/from" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/size" + - $ref: "../parameters/query.yaml#/sort" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/terminate_after" + - $ref: "../parameters/query.yaml#/stats" + - $ref: "../parameters/query.yaml#/suggest_field" + - $ref: "../parameters/query.yaml#/suggest_mode" + - $ref: "../parameters/query.yaml#/suggest_size" + - $ref: "../parameters/query.yaml#/suggest_text" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/track_scores" + - $ref: "../parameters/query.yaml#/track_total_hits" + - $ref: "../parameters/query.yaml#/allow_partial_search_results" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/seq_no_primary_term" + - $ref: "../parameters/query.yaml#/request_cache" + - $ref: "../parameters/query.yaml#/batched_reduce_size" + - $ref: "../parameters/query.yaml#/max_concurrent_shard_requests" + - $ref: "../parameters/query.yaml#/pre_filter_shard_size" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" +post: + x-endpoint-group: search + description: Returns results matching a query. + parameters: + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/ccs_minimize_roundtrips" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/stored_fields" + - $ref: "../parameters/query.yaml#/docvalue_fields" + - $ref: "../parameters/query.yaml#/from" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/ignore_throttled" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/scroll" + - $ref: "../parameters/query.yaml#/search_type" + - $ref: "../parameters/query.yaml#/size" + - $ref: "../parameters/query.yaml#/sort" + - $ref: "../parameters/query.yaml#/_source" + - $ref: "../parameters/query.yaml#/_source_excludes" + - $ref: "../parameters/query.yaml#/_source_includes" + - $ref: "../parameters/query.yaml#/terminate_after" + - $ref: "../parameters/query.yaml#/stats" + - $ref: "../parameters/query.yaml#/suggest_field" + - $ref: "../parameters/query.yaml#/suggest_mode" + - $ref: "../parameters/query.yaml#/suggest_size" + - $ref: "../parameters/query.yaml#/suggest_text" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/track_scores" + - $ref: "../parameters/query.yaml#/track_total_hits" + - $ref: "../parameters/query.yaml#/allow_partial_search_results" + - $ref: "../parameters/query.yaml#/typed_keys" + - $ref: "../parameters/query.yaml#/version" + - $ref: "../parameters/query.yaml#/seq_no_primary_term" + - $ref: "../parameters/query.yaml#/request_cache" + - $ref: "../parameters/query.yaml#/batched_reduce_size" + - $ref: "../parameters/query.yaml#/max_concurrent_shard_requests" + - $ref: "../parameters/query.yaml#/pre_filter_shard_size" + - $ref: "../parameters/query.yaml#/rest_total_hits_as_int" + requestBody: + description: The search definition using the Query DSL + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_search_shards.yaml b/openapi_spec/yaml/paths/_search_shards.yaml new file mode 100644 index 00000000..215c7d90 --- /dev/null +++ b/openapi_spec/yaml/paths/_search_shards.yaml @@ -0,0 +1,23 @@ +--- +get: + x-endpoint-group: search_shards + description: Returns information about the indices and shards that a search request + would be executed against. + parameters: + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" +post: + x-endpoint-group: search_shards + description: Returns information about the indices and shards that a search request + would be executed against. + parameters: + - $ref: "../parameters/query.yaml#/preference" + - $ref: "../parameters/query.yaml#/routing" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_segments.yaml b/openapi_spec/yaml/paths/_segments.yaml new file mode 100644 index 00000000..7c7b7fb0 --- /dev/null +++ b/openapi_spec/yaml/paths/_segments.yaml @@ -0,0 +1,9 @@ +--- +get: + x-endpoint-group: indices.segments + description: Provides low-level information about segments in a Lucene index. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/verbose" diff --git a/openapi_spec/yaml/paths/_settings.(name).yaml b/openapi_spec/yaml/paths/_settings.(name).yaml new file mode 100644 index 00000000..1d6344fb --- /dev/null +++ b/openapi_spec/yaml/paths/_settings.(name).yaml @@ -0,0 +1,19 @@ +--- +get: + x-endpoint-group: indices.get_settings + description: Returns settings for one or more indices. + parameters: + - in: path + name: name + description: The name of the settings that should be included + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/include_defaults" diff --git a/openapi_spec/yaml/paths/_settings.yaml b/openapi_spec/yaml/paths/_settings.yaml new file mode 100644 index 00000000..ff2b1a55 --- /dev/null +++ b/openapi_spec/yaml/paths/_settings.yaml @@ -0,0 +1,32 @@ +--- +put: + x-endpoint-group: indices.put_settings + description: Updates the index settings. + parameters: + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/preserve_existing" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/flat_settings" + requestBody: + description: The index settings to be updated + required: true + content: + application/json: + schema: + type: object +get: + x-endpoint-group: indices.get_settings + description: Returns settings for one or more indices. + parameters: + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/local" + - $ref: "../parameters/query.yaml#/include_defaults" diff --git a/openapi_spec/yaml/paths/_shard_stores.yaml b/openapi_spec/yaml/paths/_shard_stores.yaml new file mode 100644 index 00000000..38ebe901 --- /dev/null +++ b/openapi_spec/yaml/paths/_shard_stores.yaml @@ -0,0 +1,9 @@ +--- +get: + x-endpoint-group: indices.shard_stores + description: Provides store information for shard copies of indices. + parameters: + - $ref: "../parameters/query.yaml#/status" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).yaml b/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).yaml new file mode 100644 index 00000000..77e7d6eb --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._clone.(target_snapshot).yaml @@ -0,0 +1,33 @@ +--- +put: + x-endpoint-group: snapshot.clone + description: Clones indices from one snapshot into another snapshot in the same + repository. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - in: path + name: snapshot + description: The name of the snapshot to clone from + required: true + schema: + type: string + - in: path + name: target_snapshot + description: The name of the cloned snapshot to create + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The snapshot clone definition + required: true + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._restore.yaml b/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._restore.yaml new file mode 100644 index 00000000..3719b8d2 --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._restore.yaml @@ -0,0 +1,27 @@ +--- +post: + x-endpoint-group: snapshot.restore + description: Restores a snapshot. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - in: path + name: snapshot + description: A snapshot name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_completion" + requestBody: + description: Details of what to restore + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._status.yaml b/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._status.yaml new file mode 100644 index 00000000..cad0e3d0 --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot)._status.yaml @@ -0,0 +1,20 @@ +--- +get: + x-endpoint-group: snapshot.status + description: Returns information about the status of a snapshot. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - in: path + name: snapshot + description: A comma-separated list of snapshot names + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" diff --git a/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot).yaml b/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot).yaml new file mode 100644 index 00000000..5654986d --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.(repository).(snapshot).yaml @@ -0,0 +1,91 @@ +--- +put: + x-endpoint-group: snapshot.create + description: Creates a snapshot in a repository. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - in: path + name: snapshot + description: A snapshot name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_completion" + requestBody: + description: The snapshot definition + required: false + content: + application/json: + schema: + type: object +post: + x-endpoint-group: snapshot.create + description: Creates a snapshot in a repository. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - in: path + name: snapshot + description: A snapshot name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/wait_for_completion" + requestBody: + description: The snapshot definition + required: false + content: + application/json: + schema: + type: object +get: + x-endpoint-group: snapshot.get + description: Returns information about a snapshot. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - in: path + name: snapshot + description: A comma-separated list of snapshot names + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/verbose" +delete: + x-endpoint-group: snapshot.delete + description: Deletes a snapshot. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - in: path + name: snapshot + description: A snapshot name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" diff --git a/openapi_spec/yaml/paths/_snapshot.(repository)._cleanup.yaml b/openapi_spec/yaml/paths/_snapshot.(repository)._cleanup.yaml new file mode 100644 index 00000000..f586c2a3 --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.(repository)._cleanup.yaml @@ -0,0 +1,14 @@ +--- +post: + x-endpoint-group: snapshot.cleanup_repository + description: Removes stale data from repository. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_snapshot.(repository)._status.yaml b/openapi_spec/yaml/paths/_snapshot.(repository)._status.yaml new file mode 100644 index 00000000..e3c383f8 --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.(repository)._status.yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: snapshot.status + description: Returns information about the status of a snapshot. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" diff --git a/openapi_spec/yaml/paths/_snapshot.(repository)._verify.yaml b/openapi_spec/yaml/paths/_snapshot.(repository)._verify.yaml new file mode 100644 index 00000000..8510f6e4 --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.(repository)._verify.yaml @@ -0,0 +1,14 @@ +--- +post: + x-endpoint-group: snapshot.verify_repository + description: Verifies a repository. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_snapshot.(repository).yaml b/openapi_spec/yaml/paths/_snapshot.(repository).yaml new file mode 100644 index 00000000..91484fea --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.(repository).yaml @@ -0,0 +1,70 @@ +--- +get: + x-endpoint-group: snapshot.get_repository + description: Returns information about a repository. + parameters: + - in: path + name: repository + description: A comma-separated list of repository names + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" +put: + x-endpoint-group: snapshot.create_repository + description: Creates a repository. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/verify" + requestBody: + description: The repository definition + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: snapshot.create_repository + description: Creates a repository. + parameters: + - in: path + name: repository + description: A repository name + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/verify" + requestBody: + description: The repository definition + required: true + content: + application/json: + schema: + type: object +delete: + x-endpoint-group: snapshot.delete_repository + description: Deletes a repository. + parameters: + - in: path + name: repository + description: Name of the snapshot repository to unregister. Wildcard (`*`) patterns + are supported. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_snapshot._status.yaml b/openapi_spec/yaml/paths/_snapshot._status.yaml new file mode 100644 index 00000000..8efe6584 --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot._status.yaml @@ -0,0 +1,8 @@ +--- +get: + x-endpoint-group: snapshot.status + description: Returns information about the status of a snapshot. + parameters: + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/ignore_unavailable" diff --git a/openapi_spec/yaml/paths/_snapshot.yaml b/openapi_spec/yaml/paths/_snapshot.yaml new file mode 100644 index 00000000..6f197648 --- /dev/null +++ b/openapi_spec/yaml/paths/_snapshot.yaml @@ -0,0 +1,8 @@ +--- +get: + x-endpoint-group: snapshot.get_repository + description: Returns information about a repository. + parameters: + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_stats.(metric).yaml b/openapi_spec/yaml/paths/_stats.(metric).yaml new file mode 100644 index 00000000..9362eaf0 --- /dev/null +++ b/openapi_spec/yaml/paths/_stats.(metric).yaml @@ -0,0 +1,20 @@ +--- +get: + x-endpoint-group: indices.stats + description: Provides statistics on operations happening in an index. + parameters: + - in: path + name: metric + description: Limit the information returned the specific metrics. + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" + - $ref: "../parameters/query.yaml#/include_unloaded_segments" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/forbid_closed_indices" diff --git a/openapi_spec/yaml/paths/_stats.yaml b/openapi_spec/yaml/paths/_stats.yaml new file mode 100644 index 00000000..92623676 --- /dev/null +++ b/openapi_spec/yaml/paths/_stats.yaml @@ -0,0 +1,14 @@ +--- +get: + x-endpoint-group: indices.stats + description: Provides statistics on operations happening in an index. + parameters: + - $ref: "../parameters/query.yaml#/completion_fields" + - $ref: "../parameters/query.yaml#/fielddata_fields" + - $ref: "../parameters/query.yaml#/fields" + - $ref: "../parameters/query.yaml#/groups" + - $ref: "../parameters/query.yaml#/level" + - $ref: "../parameters/query.yaml#/include_segment_file_sizes" + - $ref: "../parameters/query.yaml#/include_unloaded_segments" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/forbid_closed_indices" diff --git a/openapi_spec/yaml/paths/_tasks.(task_id)._cancel.yaml b/openapi_spec/yaml/paths/_tasks.(task_id)._cancel.yaml new file mode 100644 index 00000000..d35c4347 --- /dev/null +++ b/openapi_spec/yaml/paths/_tasks.(task_id)._cancel.yaml @@ -0,0 +1,15 @@ +--- +post: + x-endpoint-group: tasks.cancel + description: Cancels a task, if it can be cancelled through an API. + parameters: + - in: path + name: task_id + description: Cancel the task with specified task id (node_id:task_number) + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/nodes" + - $ref: "../parameters/query.yaml#/actions" + - $ref: "../parameters/query.yaml#/parent_task_id" + - $ref: "../parameters/query.yaml#/wait_for_completion" diff --git a/openapi_spec/yaml/paths/_tasks.(task_id).yaml b/openapi_spec/yaml/paths/_tasks.(task_id).yaml new file mode 100644 index 00000000..41d59dfc --- /dev/null +++ b/openapi_spec/yaml/paths/_tasks.(task_id).yaml @@ -0,0 +1,13 @@ +--- +get: + x-endpoint-group: tasks.get + description: Returns information about a task. + parameters: + - in: path + name: task_id + description: Return the task with specified id (node_id:task_number) + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/wait_for_completion" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_tasks._cancel.yaml b/openapi_spec/yaml/paths/_tasks._cancel.yaml new file mode 100644 index 00000000..097610b3 --- /dev/null +++ b/openapi_spec/yaml/paths/_tasks._cancel.yaml @@ -0,0 +1,9 @@ +--- +post: + x-endpoint-group: tasks.cancel + description: Cancels a task, if it can be cancelled through an API. + parameters: + - $ref: "../parameters/query.yaml#/nodes" + - $ref: "../parameters/query.yaml#/actions" + - $ref: "../parameters/query.yaml#/parent_task_id" + - $ref: "../parameters/query.yaml#/wait_for_completion" diff --git a/openapi_spec/yaml/paths/_tasks.yaml b/openapi_spec/yaml/paths/_tasks.yaml new file mode 100644 index 00000000..532847d3 --- /dev/null +++ b/openapi_spec/yaml/paths/_tasks.yaml @@ -0,0 +1,12 @@ +--- +get: + x-endpoint-group: tasks.list + description: Returns a list of tasks. + parameters: + - $ref: "../parameters/query.yaml#/nodes" + - $ref: "../parameters/query.yaml#/actions" + - $ref: "../parameters/query.yaml#/detailed" + - $ref: "../parameters/query.yaml#/parent_task_id" + - $ref: "../parameters/query.yaml#/wait_for_completion" + - $ref: "../parameters/query.yaml#/group_by" + - $ref: "../parameters/query.yaml#/timeout" diff --git a/openapi_spec/yaml/paths/_template.(name).yaml b/openapi_spec/yaml/paths/_template.(name).yaml new file mode 100644 index 00000000..0976367e --- /dev/null +++ b/openapi_spec/yaml/paths/_template.(name).yaml @@ -0,0 +1,83 @@ +--- +put: + x-endpoint-group: indices.put_template + description: Creates or updates an index template. + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/order" + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The template definition + required: true + content: + application/json: + schema: + type: object +post: + x-endpoint-group: indices.put_template + description: Creates or updates an index template. + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/order" + - $ref: "../parameters/query.yaml#/create" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + requestBody: + description: The template definition + required: true + content: + application/json: + schema: + type: object +get: + x-endpoint-group: indices.get_template + description: Returns an index template. + parameters: + - in: path + name: name + description: The comma separated names of the index templates + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" +delete: + x-endpoint-group: indices.delete_template + description: Deletes an index template. + parameters: + - in: path + name: name + description: The name of the template + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/timeout" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" +head: + x-endpoint-group: indices.exists_template + description: Returns information about whether a particular index template exists. + parameters: + - in: path + name: name + description: The comma separated names of the index templates + required: true + schema: + $ref: "../schemas/_common.yaml#/string_array" + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_template.yaml b/openapi_spec/yaml/paths/_template.yaml new file mode 100644 index 00000000..39fc1361 --- /dev/null +++ b/openapi_spec/yaml/paths/_template.yaml @@ -0,0 +1,9 @@ +--- +get: + x-endpoint-group: indices.get_template + description: Returns an index template. + parameters: + - $ref: "../parameters/query.yaml#/flat_settings" + - $ref: "../parameters/query.yaml#/master_timeout" + - $ref: "../parameters/query.yaml#/cluster_manager_timeout" + - $ref: "../parameters/query.yaml#/local" diff --git a/openapi_spec/yaml/paths/_update_by_query.(task_id)._rethrottle.yaml b/openapi_spec/yaml/paths/_update_by_query.(task_id)._rethrottle.yaml new file mode 100644 index 00000000..90175d14 --- /dev/null +++ b/openapi_spec/yaml/paths/_update_by_query.(task_id)._rethrottle.yaml @@ -0,0 +1,13 @@ +--- +post: + x-endpoint-group: update_by_query_rethrottle + description: Changes the number of requests per second for a particular Update By + Query operation. + parameters: + - in: path + name: task_id + description: The task id to rethrottle + required: true + schema: + type: string + - $ref: "../parameters/query.yaml#/requests_per_second" diff --git a/openapi_spec/yaml/paths/_upgrade.yaml b/openapi_spec/yaml/paths/_upgrade.yaml new file mode 100644 index 00000000..77597be2 --- /dev/null +++ b/openapi_spec/yaml/paths/_upgrade.yaml @@ -0,0 +1,17 @@ +--- +post: + x-endpoint-group: indices.upgrade + description: The _upgrade API is no longer useful and will be removed. + parameters: + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/wait_for_completion" + - $ref: "../parameters/query.yaml#/only_ancient_segments" +get: + x-endpoint-group: indices.get_upgrade + description: The _upgrade API is no longer useful and will be removed. + parameters: + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" diff --git a/openapi_spec/yaml/paths/_validate.query.yaml b/openapi_spec/yaml/paths/_validate.query.yaml new file mode 100644 index 00000000..d002a9ef --- /dev/null +++ b/openapi_spec/yaml/paths/_validate.query.yaml @@ -0,0 +1,42 @@ +--- +get: + x-endpoint-group: indices.validate_query + description: Allows a user to validate a potentially expensive query without executing + it. + parameters: + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/rewrite" + - $ref: "../parameters/query.yaml#/all_shards" +post: + x-endpoint-group: indices.validate_query + description: Allows a user to validate a potentially expensive query without executing + it. + parameters: + - $ref: "../parameters/query.yaml#/explain" + - $ref: "../parameters/query.yaml#/ignore_unavailable" + - $ref: "../parameters/query.yaml#/allow_no_indices" + - $ref: "../parameters/query.yaml#/expand_wildcards" + - $ref: "../parameters/query.yaml#/q" + - $ref: "../parameters/query.yaml#/analyzer" + - $ref: "../parameters/query.yaml#/analyze_wildcard" + - $ref: "../parameters/query.yaml#/default_operator" + - $ref: "../parameters/query.yaml#/df" + - $ref: "../parameters/query.yaml#/lenient" + - $ref: "../parameters/query.yaml#/rewrite" + - $ref: "../parameters/query.yaml#/all_shards" + requestBody: + description: The query definition specified with the Query DSL + required: false + content: + application/json: + schema: + type: object diff --git a/openapi_spec/yaml/schemas/_common.yaml b/openapi_spec/yaml/schemas/_common.yaml new file mode 100644 index 00000000..c6a992d1 --- /dev/null +++ b/openapi_spec/yaml/schemas/_common.yaml @@ -0,0 +1,9 @@ +--- +time: + type: string + pattern: "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" +string_array: + type: array + items: + type: string + minItems: 1 diff --git a/utils/generate-api.py b/utils/generate-api.py index 07a620ee..45422b2e 100644 --- a/utils/generate-api.py +++ b/utils/generate-api.py @@ -25,18 +25,12 @@ # specific language governing permissions and limitations # under the License. - -import contextlib -import io import json import os import re -import shutil -import sys -import tempfile -import zipfile from functools import lru_cache -from itertools import chain +from itertools import chain, groupby +from operator import itemgetter from pathlib import Path import black @@ -51,6 +45,8 @@ SEPARATOR = " # AUTO-GENERATED-API-DEFINITIONS #" # global substitutions for python keywords SUBSTITUTIONS = {"type": "doc_type", "from": "from_"} + + # api path(s) BRANCH_NAME = "7.x" CODE_ROOT = Path(__file__).absolute().parent.parent @@ -333,67 +329,198 @@ def to_python(self): ) -@contextlib.contextmanager -def download_artifact(version): - # Download the list of all artifacts for a version - # and find the latest build URL for 'rest-resources-zip-*.zip' - resp = http.request( - "GET", f"https://artifacts-api.elastic.co/v1/versions/{version}" - ) - packages = json.loads(resp.data)["version"]["builds"][0]["projects"][ - "opensearchpy" - ]["packages"] - for package in packages: - if re.match(r"^rest-resources-zip-.*\.zip$", package): - zip_url = packages[package]["url"] - break - else: - raise RuntimeError( - "Could not find the package 'rest-resources-zip-*.zip' in build" - ) - - # Download the .jar file and unzip only the API - # .json files into a temporary directory - resp = http.request("GET", zip_url) - - tmp = Path(tempfile.mkdtemp()) - zip = zipfile.ZipFile(io.BytesIO(resp.data)) - for name in zip.namelist(): - if not name.endswith(".json") or name == "schema.json": - continue - with (tmp / name.replace("rest-api-spec/api/", "")).open("wb") as f: - f.write(zip.read(name)) - - yield tmp - shutil.rmtree(tmp) - - -def read_modules(version): +def read_modules(): modules = {} - with download_artifact(version) as path: - for f in sorted(os.listdir(path)): - name, ext = f.rsplit(".", 1) + # Load the OpenAPI specification file and other JSON files. + with open("openapi_spec/json/opensearch.openapi.json", "r") as file: + data = json.load(file) + with open("openapi_spec/json/parameters/query.json", "r") as query_file: + query_data = json.load(query_file) + with open("openapi_spec/json/schemas/_common.json", "r") as common_file: + common_data = json.load(common_file) + + list_of_dicts = [] - if ext != "json" or name == "_common": - continue - - with open(path / f) as api_def: - api = json.load(api_def)[name] + # Merge the contents of each file referenced in the "paths" key + for path in data["paths"]: + if "$ref" in data["paths"][path]: + ref_path = data["paths"][path]["$ref"] + ref_file = os.path.join(os.path.dirname(file.name), ref_path) + + with open(ref_file, "r") as ref: + api_file = json.load(ref) + + data["paths"][path].update(api_file) + data["paths"][path].pop("$ref") + + for x in data["paths"][path]: + data["paths"][path][x].update({"path": path, "method": x}) + list_of_dicts.append(data["paths"][path][x]) + + # Update parameters in each endpoint + for p in list_of_dicts: + if "parameters" in p: + parameters = p["parameters"] + params = [] + parts = [] + + # Iterate over the list of parameters and update them + for x in parameters: + if "$ref" in x: + param_ref = x["$ref"].split("#/", 1)[1] + + if param_ref in query_data: + s = query_data[param_ref] + + if "$ref" in s["schema"]: + schema_ref = s["schema"]["$ref"].split("#/", 1)[1] + + if schema_ref in common_data: + s["schema"] = common_data[schema_ref] + + params.append(s) + + elif "schema" in x: + if "$ref" in x["schema"]: + schema_path_ref = x["schema"]["$ref"].split("#/", 1)[1] + + if schema_path_ref in common_data: + x["schema"] = common_data[schema_path_ref] + params.append(x) + else: + params.append(x) + + # Iterate over the list of updated parameters to separate "parts" from "params" + k = params.copy() + for q in k: + if q["in"] == "path": + parts.append(q) + params.remove(q) + + # Convert "params" and "parts" into the structure required for generator. + params_new = {} + parts_new = {} + + for m in params: + A = dict(type=m["schema"]["type"], description=m["description"]) + if "enum" in m["schema"]: + A.update({"type": "enum"}) + A.update({"options": m["schema"]["enum"]}) + + if "deprecated" in m: + A.update({"deprecated": m["deprecated"]}) + params_new.update({m["name"]: A}) + + # Removing the deprecated "type" + if "type" in params_new: + params_new.pop("type") + + if bool(params_new): + p.update({"params": params_new}) + + p.pop("parameters") + + for n in parts: + B = dict(type=n["schema"]["type"], description=n["description"]) + if "deprecated" in n: + B.update({"deprecated": n["deprecated"]}) + + deprecated_new = {} + if "x-deprecation-version" in n: + deprecated_new.update({"version": n["x-deprecation-version"]}) + if "x-deprecation-description" in n: + deprecated_new.update( + {"description": n["x-deprecation-description"]} + ) + + parts_new.update({n["name"]: B}) + + if bool(parts_new): + p.update({"parts": parts_new}) + # Sort the input list by the value of the "x-endpoint-group" key + list_of_dicts = sorted(list_of_dicts, key=itemgetter("x-endpoint-group")) + + # Group the input list by the value of the "x-endpoint-group" key + for key, value in groupby(list_of_dicts, key=itemgetter("x-endpoint-group")): + api = {} + + # Extract the namespace and name from the 'x-endpoint-group' + if "." in key: + namespace, name = key.rsplit(".", 1) + else: namespace = "__init__" - if "." in name: - namespace, name = name.rsplit(".", 1) + name = key + + # Group the data in the current group by the "path" key + paths = [] + for key2, value2 in groupby(value, key=itemgetter("path")): + # Extract the HTTP methods from the data in the current subgroup + methods = [] + parts_final = {} + for z in value2: + methods.append(z["method"].upper()) + + # Update 'api' dictionary + if "documentation" not in api: + documentation = {"description": z["description"]} + api.update({"documentation": documentation}) + + if "params" not in api and "params" in z: + api.update({"params": z["params"]}) + + if "body" not in api and "requestBody" in z: + body = { + "description": z["requestBody"]["description"], + "required": z["requestBody"]["required"], + } + api.update({"body": body}) + + if "parts" in z: + parts_final.update(z["parts"]) + + if "POST" in methods or "PUT" in methods: + api.update( + { + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + } + } + ) + else: + api.update( + { + "stability": "stable", + "visibility": "public", + "headers": {"accept": ["application/json"]} + } + ) - # The data_frame API has been changed to transform. - if namespace == "data_frame_transform_deprecated": - continue + if bool(deprecated_new) and bool(parts_final): + paths.append( + { + "path": key2, + "methods": methods, + "parts": parts_final, + "deprecated": deprecated_new, + } + ) + elif bool(parts_final): + paths.append({"path": key2, "methods": methods, "parts": parts_final}) + else: + paths.append({"path": key2, "methods": methods}) + + api.update({"url": {"paths": paths}}) - if namespace not in modules: - modules[namespace] = Module(namespace) + if namespace not in modules: + modules[namespace] = Module(namespace) - modules[namespace].add(API(namespace, name, api)) - modules[namespace].pyi.add(API(namespace, name, api, is_pyi=True)) + modules[namespace].add(API(namespace, name, api)) + modules[namespace].pyi.add(API(namespace, name, api, is_pyi=True)) return modules @@ -432,5 +559,4 @@ def dump_modules(modules): if __name__ == "__main__": - version = sys.argv[1] - dump_modules(read_modules(version)) + dump_modules(read_modules()) diff --git a/utils/templates/base b/utils/templates/base index 028fce3e..ac490dd4 100644 --- a/utils/templates/base +++ b/utils/templates/base @@ -5,6 +5,7 @@ {% if api.description %} {{ api.description|replace("\n", " ")|wordwrap(wrapstring="\n ") }} {% endif %} + {% if api.doc_url %} `<{{ api.doc_url }}>`_