@elastic/schemas 0.4.3 → 0.4.5

package/src/es/json/ingest.get_pipeline.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.get_pipeline","type":"object","properties":{"id":{"type":"string","description":"Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"summary":{"type":"boolean","description":"Return pipelines without their definitions","x-found-in":"query"}},"description":"Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.get_pipeline","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"summary":{"type":"boolean","description":"Return pipelines without their definitions","x-found-in":"query"},"id":{"type":"string","description":"Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.","x-found-in":"path"}},"description":"Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline."}

package/src/es/json/ingest.put_geoip_database.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.put_geoip_database","type":"object","properties":{"id":{"type":"string","description":"ID of the database configuration to create or update.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"type":"string","description":"The provider-assigned name of the IP geolocation database to download.","x-found-in":"body"},"maxmind":{"$ref":"./ingest._types.json#/$defs/ingest._types__Maxmind","description":"The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.","x-found-in":"body"}},"required":["id","name","maxmind"],"description":"Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.put_geoip_database","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"type":"string","description":"The provider-assigned name of the IP geolocation database to download.","x-found-in":"body"},"maxmind":{"$ref":"./ingest._types.json#/$defs/ingest._types__Maxmind","description":"The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.","x-found-in":"body"},"id":{"type":"string","description":"ID of the database configuration to create or update.","x-found-in":"path"}},"required":["id","name","maxmind"],"description":"Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API."}

package/src/es/json/ingest.put_ip_location_database.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.put_ip_location_database","type":"object","properties":{"id":{"type":"string","description":"The database configuration identifier.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.","x-found-in":"query"}},"required":["id"],"description":"Create or update an IP geolocation database configuration."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.put_ip_location_database","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.","x-found-in":"query"},"configuration":{"$ref":"./ingest._types.json#/$defs/ingest._types__DatabaseConfiguration","x-found-in":"body"},"id":{"type":"string","description":"The database configuration identifier.","x-found-in":"path"}},"required":["id"],"description":"Create or update an IP geolocation database configuration."}

package/src/es/json/ingest.put_pipeline.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.put_pipeline","type":"object","properties":{"id":{"type":"string","description":"ID of the ingest pipeline to create or update.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"if_version":{"type":"number","description":"Required version for optimistic concurrency control for pipeline updates","x-found-in":"query"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.","x-found-in":"body"},"description":{"type":"string","description":"Description of the ingest pipeline.","x-found-in":"body"},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.","x-found-in":"body"},"processors":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.","x-found-in":"body"},"version":{"type":"number","description":"Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.","x-found-in":"body"},"deprecated":{"type":"boolean","description":"Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.","x-found-in":"body"},"field_access_pattern":{"$ref":"./ingest._types.json#/$defs/ingest._types__FieldAccessPattern","description":"Controls how processors in this pipeline should read and write data on a document's source.","x-found-in":"body"}},"required":["id"],"description":"Create or update a pipeline.\n\nChanges made using this API take effect immediately."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.put_pipeline","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"if_version":{"type":"number","description":"Required version for optimistic concurrency control for pipeline updates","x-found-in":"query"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.","x-found-in":"body"},"description":{"type":"string","description":"Description of the ingest pipeline.","x-found-in":"body"},"on_failure":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.","x-found-in":"body"},"processors":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__ProcessorContainer"},"description":"Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.","x-found-in":"body"},"version":{"type":"number","description":"Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.","x-found-in":"body"},"deprecated":{"type":"boolean","description":"Marks this ingest pipeline as deprecated.\nWhen a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.","x-found-in":"body"},"field_access_pattern":{"$ref":"./ingest._types.json#/$defs/ingest._types__FieldAccessPattern","description":"Controls how processors in this pipeline should read and write data on a document's source.","x-found-in":"body"},"id":{"type":"string","description":"ID of the ingest pipeline to create or update.","x-found-in":"path"}},"required":["id"],"description":"Create or update a pipeline.\n\nChanges made using this API take effect immediately."}

package/src/es/json/ingest.simulate.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.simulate","type":"object","properties":{"id":{"type":"string","description":"The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.","x-found-in":"path"},"verbose":{"type":"boolean","description":"If `true`, the response includes output data for each processor in the executed pipeline.","x-found-in":"query"},"docs":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__Document"},"description":"Sample documents to test in the pipeline.","x-found-in":"body"},"pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__Pipeline","description":"The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.","x-found-in":"body"}},"required":["docs"],"description":"Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ingest.simulate","type":"object","properties":{"verbose":{"type":"boolean","description":"If `true`, the response includes output data for each processor in the executed pipeline.","x-found-in":"query"},"docs":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__Document"},"description":"Sample documents to test in the pipeline.","x-found-in":"body"},"pipeline":{"$ref":"./ingest._types.json#/$defs/ingest._types__Pipeline","description":"The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.","x-found-in":"body"},"id":{"type":"string","description":"The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.","x-found-in":"path"}},"required":["docs"],"description":"Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request."}

package/src/es/json/license._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"license._types__LicenseStatus":{"enum":["active","valid","invalid","expired"]},"license._types__LicenseType":{"enum":["missing","trial","basic","standard","dev","silver","gold","platinum","enterprise"]},"license._types__License":{"type":"object","properties":{"expiry_date_in_millis":{},"issue_date_in_millis":{},"start_date_in_millis":{},"issued_to":{"type":"string"},"issuer":{"type":"string"},"max_nodes":{"oneOf":[{"type":"number"},{"type":"null"}]},"max_resource_units":{"type":"number"},"signature":{"type":"string"},"type":{"$ref":"./license._types.json#/$defs/license._types__LicenseType"},"uid":{"type":"string"}},"required":["expiry_date_in_millis","issue_date_in_millis","issued_to","issuer","signature","type","uid"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"license._types__LicenseStatus":{"enum":["active","valid","invalid","expired"]},"license._types__LicenseType":{"enum":["missing","trial","basic","standard","dev","silver","gold","platinum","enterprise"]},"license._types__License":{"type":"object","properties":{"expiry_date_in_millis":{},"issue_date_in_millis":{},"start_date_in_millis":{},"issued_to":{"type":"string"},"issuer":{"type":"string"},"max_nodes":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_resource_units":{"type":"number"},"signature":{"type":"string"},"type":{"$ref":"./license._types.json#/$defs/license._types__LicenseType"},"uid":{"type":"string"}},"required":["expiry_date_in_millis","issue_date_in_millis","issued_to","issuer","signature","type","uid"]}}}

package/src/es/json/license.get.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"license.get__LicenseInformation":{"type":"object","properties":{"expiry_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The date and time the license expires in ISO 8601 format."},"expiry_date_in_millis":{"description":"The date and time the license expires in milliseconds since the Unix epoch."},"issue_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The date and time the license was issued in ISO 8601 format."},"issue_date_in_millis":{"description":"The date and time the license was issued in milliseconds since the Unix epoch."},"issued_to":{"type":"string","description":"The name of the customer or organization that received the license."},"issuer":{"type":"string","description":"The name of the organization that issued the license."},"max_nodes":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"The maximum number of nodes the license allows."},"max_resource_units":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"The maximum number of resource units the license allows (for enterprise licenses only)."},"status":{"$ref":"./license._types.json#/$defs/license._types__LicenseStatus","description":"The status of the license. For example,active, valid, invalid, or expired."},"type":{"$ref":"./license._types.json#/$defs/license._types__LicenseType","description":"The type of the license. For example, trial, basic, gold, platinum, or enterprise."},"uid":{"type":"string","description":"The unique identifier of the license."},"start_date_in_millis":{"description":"The date and time the license was started in milliseconds since the Unix epoch."}},"required":["issue_date","issue_date_in_millis","issued_to","issuer","max_nodes","status","type","uid","start_date_in_millis"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"license.get__LicenseInformation":{"type":"object","properties":{"expiry_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The date and time the license expires in ISO 8601 format."},"expiry_date_in_millis":{"description":"The date and time the license expires in milliseconds since the Unix epoch."},"issue_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The date and time the license was issued in ISO 8601 format."},"issue_date_in_millis":{"description":"The date and time the license was issued in milliseconds since the Unix epoch."},"issued_to":{"type":"string","description":"The name of the customer or organization that received the license."},"issuer":{"type":"string","description":"The name of the organization that issued the license."},"max_nodes":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The maximum number of nodes the license allows."},"max_resource_units":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The maximum number of resource units the license allows (for enterprise licenses only)."},"status":{"$ref":"./license._types.json#/$defs/license._types__LicenseStatus","description":"The status of the license. For example,active, valid, invalid, or expired."},"type":{"$ref":"./license._types.json#/$defs/license._types__LicenseType","description":"The type of the license. For example, trial, basic, gold, platinum, or enterprise."},"uid":{"type":"string","description":"The unique identifier of the license."},"start_date_in_millis":{"description":"The date and time the license was started in milliseconds since the Unix epoch."}},"required":["issue_date","issue_date_in_millis","issued_to","issuer","max_nodes","status","type","uid","start_date_in_millis"]}}}

package/src/es/json/license.post_start_basic.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"license.post_start_basic","type":"object","properties":{"acknowledged":{"type":"boolean"},"basic_was_started":{"type":"boolean"},"error_message":{"type":"string"},"type":{"$ref":"./license._types.json#/$defs/license._types__LicenseType"},"acknowledge":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}},"required":["acknowledged","basic_was_started"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"license.post_start_basic","type":"object","properties":{"acknowledged":{"type":"boolean"},"basic_was_started":{"type":"boolean"},"error_message":{"type":"string"},"type":{"$ref":"./license._types.json#/$defs/license._types__LicenseType"},"acknowledge":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}},"required":["acknowledged","basic_was_started"]}

package/src/es/json/logstash.put_pipeline.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"logstash.put_pipeline","type":"object","properties":{"id":{"type":"string","description":"An identifier for the pipeline.\nPipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers.","x-found-in":"path"}},"required":["id"],"description":"Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"logstash.put_pipeline","type":"object","properties":{"pipeline":{"$ref":"./logstash._types.json#/$defs/logstash._types__Pipeline","x-found-in":"body"},"id":{"type":"string","description":"An identifier for the pipeline.\nPipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers.","x-found-in":"path"}},"required":["id"],"description":"Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced."}

package/src/es/json/mget.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"mget","type":"object","properties":{"index":{"type":"string","description":"Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.","x-found-in":"path"},"preference":{"type":"string","description":"Specifies the node or shard the operation should be performed on. Random by default.","x-found-in":"query"},"realtime":{"type":"boolean","description":"If `true`, the request is real-time as opposed to near-real-time.","x-found-in":"query"},"refresh":{"type":"boolean","description":"If `true`, the request refreshes relevant shards before retrieving documents.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"Custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam","description":"True or false to return the `_source` field or not, or a list of fields to return.","x-found-in":"query"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.","x-found-in":"query"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"If `true`, retrieves the document fields stored in the index rather than the document `_source`.","x-found-in":"query"},"docs":{"type":"array","items":{"$ref":"./_global.mget.json#/$defs/_global.mget__Operation"},"description":"The documents you want to retrieve. Required if no index is specified in the request URI.","x-found-in":"body"},"ids":{"$ref":"./_types.json#/$defs/_types__Ids","description":"The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.","x-found-in":"body"}},"description":"Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"mget","type":"object","properties":{"preference":{"type":"string","description":"Specifies the node or shard the operation should be performed on. Random by default.","x-found-in":"query"},"realtime":{"type":"boolean","description":"If `true`, the request is real-time as opposed to near-real-time.","x-found-in":"query"},"refresh":{"type":"boolean","description":"If `true`, the request refreshes relevant shards before retrieving documents.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"Custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam","description":"True or false to return the `_source` field or not, or a list of fields to return.","x-found-in":"query"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.","x-found-in":"query"},"stored_fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"If `true`, retrieves the document fields stored in the index rather than the document `_source`.","x-found-in":"query"},"docs":{"type":"array","items":{"$ref":"./_global.mget.json#/$defs/_global.mget__Operation"},"description":"The documents you want to retrieve. Required if no index is specified in the request URI.","x-found-in":"body"},"ids":{"$ref":"./_types.json#/$defs/_types__Ids","description":"The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.","x-found-in":"body"},"index":{"type":"string","description":"Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.","x-found-in":"path"}},"description":"Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions."}