@elastic/schemas 0.5.1 → 0.6.0

package/src/es/json/search_mvt.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_mvt","description":"Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n  * A feature containing a bounding box. By default, this is the bounding box of the tile.\n  * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n  * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`.\nFor example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `<zoom>` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1  | 4                  | 0  | 122             | 30.5           |\n| 2  | 16                 | 0  | 122             | 7.625          |\n| 3  | 64                 | 1  | 842             | 13.15625       |\n| 4  | 256                | 1  | 842             | 3.2890625      |\n| 5  | 1024               | 2  | 5882            | 5.744140625    |\n| 6  | 4096               | 2  | 5882            | 1.436035156    |\n| 7  | 16384              | 3  | 41162           | 2.512329102    |\n| 8  | 65536              | 3  | 41162           | 0.6280822754   |\n| 9  | 262144             | 4  | 288122          | 1.099098206    |\n| 10 | 1048576            | 4  | 288122          | 0.2747745514   |\n| 11 | 4194304            | 5  | 2016842         | 0.4808526039   |\n| 12 | 16777216           | 6  | 14117882        | 0.8414913416   |\n| 13 | 67108864           | 6  | 14117882        | 0.2103728354   |\n| 14 | 268435456          | 7  | 98825162        | 0.3681524172   |\n| 15 | 1073741824         | 8  | 691776122       | 0.644266719    |\n| 16 | 4294967296         | 8  | 691776122       | 0.1610666797   |\n| 17 | 17179869184        | 9  | 4842432842      | 0.2818666889   |\n| 18 | 68719476736        | 10 | 33897029882     | 0.4932667053   |\n| 19 | 274877906944       | 11 | 237279209162    | 0.8632167343   |\n| 20 | 1099511627776      | 11 | 237279209162    | 0.2158041836   |\n| 21 | 4398046511104      | 12 | 1660954464122   | 0.3776573213   |\n| 22 | 17592186044416     | 13 | 11626681248842  | 0.6609003122   |\n| 23 | 70368744177664     | 13 | 11626681248842  | 0.165225078    |\n| 24 | 281474976710656    | 14 | 81386768741882  | 0.2891438866   |\n| 25 | 1125899906842620   | 15 | 569707381193162 | 0.5060018015   |\n| 26 | 4503599627370500   | 15 | 569707381193162 | 0.1265004504   |\n| 27 | 18014398509482000  | 15 | 569707381193162 | 0.03162511259  |\n| 28 | 72057594037927900  | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.\n\nLearn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide.","x-api":{"id":"search_mvt","name":"search-mvt","namespace":null},"x-method":"POST","x-path":"/{index}/_mvt/{field}/{zoom}/{x}/{y}","x-urls":[{"path":"/{index}/_mvt/{field}/{zoom}/{x}/{y}","methods":["POST","GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"exact_bounds":{"type":"boolean","description":"If `false`, the meta layer's feature is the bounding box of the tile.\nIf `true`, the meta layer's feature is a bounding box resulting from a\n`geo_bounds` aggregation. The aggregation runs on <field> values that intersect\nthe `<zoom>/<x>/<y>` tile with `wrap_longitude` set to `false`. The resulting\nbounding box may be larger than the vector tile.","x-found-in":"body"},"extent":{"type":"number","description":"The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.","x-found-in":"body"},"grid_agg":{"$ref":"./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridAggregationType","description":"The aggregation used to create a grid for the `field`.","x-found-in":"body"},"grid_precision":{"type":"number","description":"Additional zoom levels available through the aggs layer. For example, if `<zoom>` is `7`\nand `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.","x-found-in":"body"},"grid_type":{"$ref":"./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridType","description":"Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.","x-found-in":"body"},"size":{"type":"number","description":"The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.","x-found-in":"body"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.","x-found-in":"body"},"with_labels":{"type":"boolean","description":"If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.","x-found-in":"body"},"aggs":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.","x-found-in":"body"},"buffer":{"type":"number","description":"The size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.","x-found-in":"body"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The query DSL used to filter documents for the search.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `<cluster>:<target>` syntax.","x-found-in":"path"},"field":{"type":"string","description":"A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.","x-found-in":"path"},"zoom":{"type":"number","description":"The zoom level of the vector tile to search. It accepts `0` to `29`.","x-found-in":"path"},"x":{"type":"number","description":"The X coordinate for the vector tile to search.","x-found-in":"path"},"y":{"type":"number","description":"The Y coordinate for the vector tile to search.","x-found-in":"path"}},"required":["index","field","zoom","x","y"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_mvt","description":"Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n  * A feature containing a bounding box. By default, this is the bounding box of the tile.\n  * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n  * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`.\nFor example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `<zoom>` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1  | 4                  | 0  | 122             | 30.5           |\n| 2  | 16                 | 0  | 122             | 7.625          |\n| 3  | 64                 | 1  | 842             | 13.15625       |\n| 4  | 256                | 1  | 842             | 3.2890625      |\n| 5  | 1024               | 2  | 5882            | 5.744140625    |\n| 6  | 4096               | 2  | 5882            | 1.436035156    |\n| 7  | 16384              | 3  | 41162           | 2.512329102    |\n| 8  | 65536              | 3  | 41162           | 0.6280822754   |\n| 9  | 262144             | 4  | 288122          | 1.099098206    |\n| 10 | 1048576            | 4  | 288122          | 0.2747745514   |\n| 11 | 4194304            | 5  | 2016842         | 0.4808526039   |\n| 12 | 16777216           | 6  | 14117882        | 0.8414913416   |\n| 13 | 67108864           | 6  | 14117882        | 0.2103728354   |\n| 14 | 268435456          | 7  | 98825162        | 0.3681524172   |\n| 15 | 1073741824         | 8  | 691776122       | 0.644266719    |\n| 16 | 4294967296         | 8  | 691776122       | 0.1610666797   |\n| 17 | 17179869184        | 9  | 4842432842      | 0.2818666889   |\n| 18 | 68719476736        | 10 | 33897029882     | 0.4932667053   |\n| 19 | 274877906944       | 11 | 237279209162    | 0.8632167343   |\n| 20 | 1099511627776      | 11 | 237279209162    | 0.2158041836   |\n| 21 | 4398046511104      | 12 | 1660954464122   | 0.3776573213   |\n| 22 | 17592186044416     | 13 | 11626681248842  | 0.6609003122   |\n| 23 | 70368744177664     | 13 | 11626681248842  | 0.165225078    |\n| 24 | 281474976710656    | 14 | 81386768741882  | 0.2891438866   |\n| 25 | 1125899906842620   | 15 | 569707381193162 | 0.5060018015   |\n| 26 | 4503599627370500   | 15 | 569707381193162 | 0.1265004504   |\n| 27 | 18014398509482000  | 15 | 569707381193162 | 0.03162511259  |\n| 28 | 72057594037927900  | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.\n\nLearn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide.","x-api":{"id":"search_mvt","name":"search-mvt","namespace":null},"x-method":"POST","x-path":"/{index}/_mvt/{field}/{zoom}/{x}/{y}","x-urls":[{"path":"/{index}/_mvt/{field}/{zoom}/{x}/{y}","methods":["POST","GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"x-response-type":["application/vnd.mapbox-vector-tile"],"type":"object","properties":{"exact_bounds":{"type":"boolean","description":"If `false`, the meta layer's feature is the bounding box of the tile.\nIf `true`, the meta layer's feature is a bounding box resulting from a\n`geo_bounds` aggregation. The aggregation runs on <field> values that intersect\nthe `<zoom>/<x>/<y>` tile with `wrap_longitude` set to `false`. The resulting\nbounding box may be larger than the vector tile.","x-found-in":"body"},"extent":{"type":"number","description":"The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.","x-found-in":"body"},"grid_agg":{"$ref":"./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridAggregationType","description":"The aggregation used to create a grid for the `field`.","x-found-in":"body"},"grid_precision":{"type":"number","description":"Additional zoom levels available through the aggs layer. For example, if `<zoom>` is `7`\nand `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.","x-found-in":"body"},"grid_type":{"$ref":"./_global.search_mvt._types.json#/$defs/_global.search_mvt._types__GridType","description":"Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.","x-found-in":"body"},"size":{"type":"number","description":"The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.","x-found-in":"body"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits","description":"The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.","x-found-in":"body"},"with_labels":{"type":"boolean","description":"If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.","x-found-in":"body"},"aggs":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"},"description":"Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.","x-found-in":"body"},"buffer":{"type":"number","description":"The size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.","x-found-in":"body"},"fields":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.","x-found-in":"body"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The query DSL used to filter documents for the search.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A list of indices, data streams, or aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.\nTo search a remote cluster, use the `<cluster>:<target>` syntax.","x-found-in":"path"},"field":{"type":"string","description":"A field that contains the geospatial data to return.\nIt must be a `geo_point` or `geo_shape` field.\nThe field must have doc values enabled. It cannot be a nested field.\n\nNOTE: Vector tiles do not natively support geometry collections.\nFor `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection.\nThis behavior may change in a future release.","x-found-in":"path"},"zoom":{"type":"number","description":"The zoom level of the vector tile to search. It accepts `0` to `29`.","x-found-in":"path"},"x":{"type":"number","description":"The X coordinate for the vector tile to search.","x-found-in":"path"},"y":{"type":"number","description":"The Y coordinate for the vector tile to search.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["index","field","zoom","x","y"]}

package/src/es/json/search_shards.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_shards","description":"Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.","x-api":{"id":"search_shards","name":"search-shards","namespace":null},"x-method":"GET","x-path":"/{index}/_search_shards","x-urls":[{"path":"/_search_shards","methods":["GET","POST"]},{"path":"/{index}/_search_shards","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request retrieves information from the local node only.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIT can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A 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"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_shards","description":"Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.","x-api":{"id":"search_shards","name":"search-shards","namespace":null},"x-method":"GET","x-path":"/{index}/_search_shards","x-urls":[{"path":"/_search_shards","methods":["GET","POST"]},{"path":"/{index}/_search_shards","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"local":{"type":"boolean","description":"If `true`, the request retrieves information from the local node only.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIT can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A 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"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/search_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_template","description":"Run a search with a search template.","x-api":{"id":"search_template","name":"search-template","namespace":null},"x-method":"GET","x-path":"/{index}/_search/template","x-urls":[{"path":"/_search/template","methods":["GET","POST"]},{"path":"/{index}/_search/template","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.","x-found-in":"body"},"ignore_throttled":{"type":"boolean","description":"If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.","x-found-in":"query","x-deprecated":{"since":"7.16.0"}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"profile":{"type":"boolean","description":"If `true`, the query execution is profiled.","x-found-in":"body"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies how long a consistent view of the index\nshould be maintained for scrolled search.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.","x-found-in":"query","x-availability":{"stack":{"since":"7.0.0"},"serverless":{}}},"typed_keys":{"type":"boolean","description":"If `true`, the response prefixes aggregation and suggester names with their respective types.","x-found-in":"query"},"id":{"type":"string","description":"The ID of the search template to use. If no `source` is specified,\nthis parameter is required.","x-found-in":"body"},"params":{"type":"object","additionalProperties":{},"description":"Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.","x-found-in":"body"},"source":{"$ref":"./_types.json#/$defs/_types__ScriptSource","description":"An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"search_template","description":"Run a search with a search template.","x-api":{"id":"search_template","name":"search-template","namespace":null},"x-method":"GET","x-path":"/{index}/_search/template","x-urls":[{"path":"/_search/template","methods":["GET","POST"]},{"path":"/{index}/_search/template","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ccs_minimize_roundtrips":{"type":"boolean","description":"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.","x-found-in":"body"},"ignore_throttled":{"type":"boolean","description":"If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.","x-found-in":"query","x-deprecated":{"since":"7.16.0"}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"profile":{"type":"boolean","description":"If `true`, the query execution is profiled.","x-found-in":"body"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies how long a consistent view of the index\nshould be maintained for scrolled search.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation.","x-found-in":"query"},"rest_total_hits_as_int":{"type":"boolean","description":"If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.","x-found-in":"query","x-availability":{"stack":{"since":"7.0.0"},"serverless":{}}},"typed_keys":{"type":"boolean","description":"If `true`, the response prefixes aggregation and suggester names with their respective types.","x-found-in":"query"},"id":{"type":"string","description":"The ID of the search template to use. If no `source` is specified,\nthis parameter is required.","x-found-in":"body"},"params":{"type":"object","additionalProperties":{},"description":"Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.","x-found-in":"body"},"source":{"$ref":"./_types.json#/$defs/_types__ScriptSource","description":"An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/searchable_snapshots.cache_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.cache_stats","description":"Get cache statistics.\n\nGet statistics about the shared cache for partially mounted indices.","x-api":{"id":"searchable-snapshots.cache_stats","name":"cache-stats","namespace":"searchable-snapshots"},"x-method":"GET","x-path":"/_searchable_snapshots/{node_id}/cache/stats","x-urls":[{"path":"/_searchable_snapshots/cache/stats","methods":["GET"]},{"path":"/_searchable_snapshots/{node_id}/cache/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.13.0","stability":"experimental"}},"type":"object","properties":{"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"The names of the nodes in the cluster to target.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.cache_stats","description":"Get cache statistics.\n\nGet statistics about the shared cache for partially mounted indices.","x-api":{"id":"searchable-snapshots.cache_stats","name":"cache-stats","namespace":"searchable-snapshots"},"x-method":"GET","x-path":"/_searchable_snapshots/{node_id}/cache/stats","x-urls":[{"path":"/_searchable_snapshots/cache/stats","methods":["GET"]},{"path":"/_searchable_snapshots/{node_id}/cache/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.13.0","stability":"experimental"}},"type":"object","properties":{"node_id":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"The names of the nodes in the cluster to target.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/searchable_snapshots.clear_cache.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.clear_cache","description":"Clear the cache.\n\nClear indices and data streams from the shared cache for partially mounted indices.","x-api":{"id":"searchable-snapshots.clear_cache","name":"clear-cache","namespace":"searchable-snapshots"},"x-method":"POST","x-path":"/{index}/_searchable_snapshots/cache/clear","x-urls":[{"path":"/_searchable_snapshots/cache/clear","methods":["POST"]},{"path":"/{index}/_searchable_snapshots/cache/clear","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"experimental"}},"type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Whether to expand wildcard expression to concrete indices that are open, closed or both","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to clear from the cache.\nIt supports wildcards (`*`).","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.clear_cache","description":"Clear the cache.\n\nClear indices and data streams from the shared cache for partially mounted indices.","x-api":{"id":"searchable-snapshots.clear_cache","name":"clear-cache","namespace":"searchable-snapshots"},"x-method":"POST","x-path":"/{index}/_searchable_snapshots/cache/clear","x-urls":[{"path":"/_searchable_snapshots/cache/clear","methods":["POST"]},{"path":"/{index}/_searchable_snapshots/cache/clear","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"experimental"}},"type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Whether to expand wildcard expression to concrete indices that are open, closed or both","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to clear from the cache.\nIt supports wildcards (`*`).","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/searchable_snapshots.mount.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.mount","description":"Mount a snapshot.\n\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.","x-api":{"id":"searchable-snapshots.mount","name":"mount","namespace":"searchable-snapshots"},"x-method":"POST","x-path":"/_snapshot/{repository}/{snapshot}/_mount","x-urls":[{"path":"/_snapshot/{repository}/{snapshot}/_mount","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until the operation is complete.","x-found-in":"query"},"storage":{"$ref":"./searchable_snapshots.mount.json#/$defs/searchable_snapshots.mount__StorageOption","description":"The mount option for the searchable snapshot index.\nFor further information on mount options, refer to: [Mount options](https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots#searchable-snapshot-mount-storage-options)","x-found-in":"query"},"index":{"type":"string","description":"The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.","x-found-in":"body"},"renamed_index":{"type":"string","description":"The name of the index that will be created.","x-found-in":"body"},"index_settings":{"type":"object","additionalProperties":{},"description":"The settings that should be added to the index when it is mounted.","x-found-in":"body"},"ignore_index_settings":{"type":"array","items":{"type":"string"},"description":"The names of settings that should be removed from the index when it is mounted.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the repository containing the snapshot of the index to mount.","x-found-in":"path"},"snapshot":{"type":"string","description":"The name of the snapshot of the index to mount.","x-found-in":"path"}},"required":["repository","snapshot","index"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.mount","description":"Mount a snapshot.\n\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.","x-api":{"id":"searchable-snapshots.mount","name":"mount","namespace":"searchable-snapshots"},"x-method":"POST","x-path":"/_snapshot/{repository}/{snapshot}/_mount","x-urls":[{"path":"/_snapshot/{repository}/{snapshot}/_mount","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until the operation is complete.","x-found-in":"query"},"storage":{"$ref":"./searchable_snapshots.mount.json#/$defs/searchable_snapshots.mount__StorageOption","description":"The mount option for the searchable snapshot index.\nFor further information on mount options, refer to: [Mount options](https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots#searchable-snapshot-mount-storage-options)","x-found-in":"query"},"index":{"type":"string","description":"The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.","x-found-in":"body"},"renamed_index":{"type":"string","description":"The name of the index that will be created.","x-found-in":"body"},"index_settings":{"type":"object","additionalProperties":{},"description":"The settings that should be added to the index when it is mounted.","x-found-in":"body"},"ignore_index_settings":{"type":"array","items":{"type":"string"},"description":"The names of settings that should be removed from the index when it is mounted.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the repository containing the snapshot of the index to mount.","x-found-in":"path"},"snapshot":{"type":"string","description":"The name of the snapshot of the index to mount.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["repository","snapshot","index"]}

package/src/es/json/searchable_snapshots.stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.stats","description":"Get searchable snapshot statistics.","x-api":{"id":"searchable-snapshots.stats","name":"stats","namespace":"searchable-snapshots"},"x-method":"GET","x-path":"/{index}/_searchable_snapshots/stats","x-urls":[{"path":"/_searchable_snapshots/stats","methods":["GET"]},{"path":"/{index}/_searchable_snapshots/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"}},"type":"object","properties":{"level":{"$ref":"./searchable_snapshots._types.json#/$defs/searchable_snapshots._types__StatsLevel","description":"Return stats aggregated at cluster, index or shard level","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams and indices to retrieve statistics for.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.stats","description":"Get searchable snapshot statistics.","x-api":{"id":"searchable-snapshots.stats","name":"stats","namespace":"searchable-snapshots"},"x-method":"GET","x-path":"/{index}/_searchable_snapshots/stats","x-urls":[{"path":"/_searchable_snapshots/stats","methods":["GET"]},{"path":"/{index}/_searchable_snapshots/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"}},"type":"object","properties":{"level":{"$ref":"./searchable_snapshots._types.json#/$defs/searchable_snapshots._types__StatsLevel","description":"Return stats aggregated at cluster, index or shard level","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams and indices to retrieve statistics for.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/security._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security._types__GrantType":{"enum":["password","access_token"]},"security._types__UserProfileWithMetadata":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"last_synchronized":{"type":"number"},"_doc":{"$ref":"./security._types.json#/$defs/security._types__UserProfileHitMetadata"}},"required":["uid","user","data","labels","last_synchronized","_doc"]},"security._types__UserProfileUser":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"realm_name":{"type":"string"},"realm_domain":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"}},"required":["realm_name","roles","username"]},"security._types__UserProfileHitMetadata":{"type":"object","properties":{"_primary_term":{"type":"number"},"_seq_no":{"type":"number"}},"required":["_primary_term","_seq_no"]},"security._types__CredentialManagedBy":{"enum":["cloud","elasticsearch"]},"security._types__RealmInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"security._types__BulkError":{"type":"object","properties":{"count":{"type":"number","description":"The number of errors"},"details":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"description":"Details about the errors, keyed by role name"}},"required":["count","details"]},"security._types__RoleDescriptor":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}}},"security._types__ClusterPrivilege":{"anyOf":[{"enum":["all","cancel_task","create_snapshot","cross_cluster_replication","cross_cluster_search","delegate_pki","grant_api_key","manage","manage_api_key","manage_autoscaling","manage_behavioral_analytics","manage_ccr","manage_data_frame_transforms","manage_data_stream_global_retention","manage_enrich","manage_esql","manage_ilm","manage_index_templates","manage_inference","manage_ingest_pipelines","manage_logstash_pipelines","manage_ml","manage_oidc","manage_own_api_key","manage_pipeline","manage_reindex","manage_rollup","manage_saml","manage_search_application","manage_search_query_rules","manage_search_synonyms","manage_security","manage_service_account","manage_slm","manage_token","manage_transform","manage_user_profile","manage_watcher","monitor","monitor_data_frame_transforms","monitor_data_stream_global_retention","monitor_enrich","monitor_esql","monitor_inference","monitor_ml","monitor_reindex","monitor_rollup","monitor_snapshot","monitor_stats","monitor_text_structure","monitor_transform","monitor_watcher","none","post_behavioral_analytics_event","read_ccr","read_fleet_secrets","read_ilm","read_pipeline","read_security","read_slm","transport_client","write_connector_secrets","write_fleet_secrets","read_project_routing","manage_project_routing"]},{"type":"string"}]},"security._types__IndicesPrivileges":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names","privileges"]},"security._types__FieldSecurity":{"type":"object","properties":{"except":{"$ref":"./_types.json#/$defs/_types__Fields"},"grant":{"$ref":"./_types.json#/$defs/_types__Fields"}}},"security._types__IndexPrivilege":{"anyOf":[{"enum":["all","auto_configure","create","create_doc","create_index","create_view","cross_cluster_replication","cross_cluster_replication_internal","delete","delete_index","delete_view","index","maintenance","manage","manage_data_stream_lifecycle","manage_follow_index","manage_ilm","manage_leader_index","manage_view","monitor","none","read","read_cross_cluster","read_view_metadata","view_index_metadata","write"]},{"type":"string"}]},"security._types__IndicesPrivilegesQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateQuery"}],"description":"While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts."},"security._types__RoleTemplateQuery":{"type":"object","properties":{"template":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateScript","description":"When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter."}}},"security._types__RoleTemplateScript":{"type":"object","properties":{"source":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateInlineQuery"},"id":{"type":"string","description":"The `id` for a stored script."},"params":{"type":"object","additionalProperties":{},"description":"Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time."},"lang":{"$ref":"./_types.json#/$defs/_types__ScriptLanguage","description":"Specifies the language the script is written in."},"options":{"type":"object","additionalProperties":{"type":"string"}}}},"security._types__RoleTemplateInlineQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"}]},"security._types__RemoteIndicesPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["clusters","names","privileges"],"description":"The subset of index level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivilege"},"description":"The cluster level privileges that owners of the role have on the remote cluster."}},"required":["clusters","privileges"],"description":"The subset of cluster level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivilege":{"enum":["monitor_enrich","monitor_stats"]},"security._types__GlobalPrivilege":{"type":"object","properties":{"application":{"$ref":"./security._types.json#/$defs/security._types__ApplicationGlobalUserPrivileges"},"data_source":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivileges"},"description":"A list of data source privilege entries, used to grant access to ES|QL data sources.","x-availability":{"stack":{"since":"9.5.0"}}}},"required":["application"]},"security._types__ApplicationGlobalUserPrivileges":{"type":"object","properties":{"manage":{"$ref":"./security._types.json#/$defs/security._types__ManageUserPrivileges"}},"required":["manage"]},"security._types__ManageUserPrivileges":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"string"}}},"required":["applications"]},"security._types__DataSourcePrivileges":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"},"description":"A list of data source names or wildcard patterns to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivilege"},"description":"The data source privileges that owners of the role have for the specified data sources."}},"required":["names","privileges"]},"security._types__DataSourcePrivilege":{"anyOf":[{"enum":["create","delete","read_metadata","read","manage"]},{"type":"string"}]},"security._types__ApplicationPrivileges":{"type":"object","properties":{"application":{"type":"string","description":"The name of the application to which this entry applies."},"privileges":{"type":"array","items":{"type":"string"},"description":"A list of strings, where each element is the name of an application privilege or action."},"resources":{"type":"array","items":{"type":"string"},"description":"A list resources to which the privileges are applied."}},"required":["application","privileges","resources"]},"security._types__Restriction":{"type":"object","properties":{"workflows":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RestrictionWorkflow"},"description":"A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor."}},"required":["workflows"]},"security._types__RestrictionWorkflow":{"anyOf":[{"enum":["search_application_query"]},{"type":"string"}]},"security._types__ClusterNode":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"security._types__Access":{"type":"object","properties":{"replication":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ReplicationAccess"},"description":"A list of indices permission entries for cross-cluster replication."},"search":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__SearchAccess"},"description":"A list of indices permission entries for cross-cluster search."}}},"security._types__ReplicationAccess":{"type":"object","properties":{"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"allow_restricted_indices":{"type":"boolean","description":"This needs to be set to true if the patterns in the names field should cover system indices."}},"required":["names"]},"security._types__SearchAccess":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names"]},"security._types__ApiKey":{"type":"object","properties":{"id":{"type":"string","description":"Id for the API key"},"name":{"type":"string","description":"Name of the API key."},"type":{"$ref":"./security._types.json#/$defs/security._types__ApiKeyType","description":"The type of the API key (e.g. `rest` or `cross_cluster`).","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"creation":{"description":"Creation time for the API key in milliseconds."},"expiration":{"description":"Expiration time for the API key in milliseconds."},"invalidated":{"type":"boolean","description":"Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`."},"invalidation":{"description":"If the key has been invalidated, invalidation time in milliseconds.","x-availability":{"stack":{"since":"8.12.0"},"serverless":{}}},"username":{"type":"string","description":"Principal for which this API key was created"},"realm":{"type":"string","description":"Realm name of the principal for which this API key was created."},"realm_type":{"type":"string","description":"Realm type of the principal for which this API key was created","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Metadata of the API key","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions."},"limited_by":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}},"description":"The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.","x-availability":{"stack":{"since":"8.5.0"},"serverless":{}}},"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"certificate_identity":{"type":"string","description":"The certificate identity associated with a cross-cluster API key.\nRestricts the API key to connections authenticated by a specific TLS certificate.\nOnly applicable to cross-cluster API keys.","x-availability":{"stack":{"since":"9.3.0"}}},"profile_uid":{"type":"string","description":"The profile uid for the API key owner principal, if requested and if it exists","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Sorting values when using the `sort` parameter with the `security.query_api_keys` API."}},"required":["id","name","type","creation","invalidated","username","realm","metadata"]},"security._types__ApiKeyType":{"enum":["rest","cross_cluster"]},"security._types__RoleTemplate":{"type":"object","properties":{"format":{"$ref":"./security._types.json#/$defs/security._types__TemplateFormat"},"template":{"$ref":"./_types.json#/$defs/_types__Script"}},"required":["template"]},"security._types__TemplateFormat":{"enum":["string","json"]},"security._types__RoleMapping":{"type":"object","properties":{"enabled":{"type":"boolean"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"}},"rules":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"required":["enabled","metadata","rules"]},"security._types__RoleMappingRule":{"type":"object","properties":{"any":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"all":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"field":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__FieldValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}]}},"except":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}}},"security._types__RoleDescriptorRead":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}},"required":["cluster","indices"]},"security._types__SecuritySettings":{"type":"object","properties":{"index":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings"}}},"security._types__NodeSecurityStats":{"type":"object","properties":{"roles":{"$ref":"./security._types.json#/$defs/security._types__RolesStats","description":"Role statistics."}},"required":["roles"]},"security._types__RolesStats":{"type":"object","properties":{"dls":{"$ref":"./xpack.usage.json#/$defs/xpack.usage__SecurityRolesDls","description":"Document-level security (DLS) statistics."}},"required":["dls"]},"security._types__User":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"profile_uid":{"type":"string"}},"required":["metadata","roles","username","enabled"]},"security._types__UserIndicesPrivileges":{"type":"object","properties":{"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["names","privileges","allow_restricted_indices"]},"security._types__RemoteUserIndicesPrivileges":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"string"}},"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["clusters","names","privileges","allow_restricted_indices"]},"security._types__CreatedStatus":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"]},"security._types__UserProfile":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"}},"required":["uid","user","data","labels"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security._types__GrantType":{"enum":["password","access_token"]},"security._types__UserProfileWithMetadata":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"last_synchronized":{"type":"number"},"_doc":{"$ref":"./security._types.json#/$defs/security._types__UserProfileHitMetadata"}},"required":["uid","user","data","labels","last_synchronized","_doc"]},"security._types__UserProfileUser":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"realm_name":{"type":"string"},"realm_domain":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"}},"required":["realm_name","roles","username"]},"security._types__UserProfileHitMetadata":{"type":"object","properties":{"_primary_term":{"type":"number"},"_seq_no":{"type":"number"}},"required":["_primary_term","_seq_no"]},"security._types__CredentialManagedBy":{"enum":["cloud","elasticsearch"]},"security._types__RealmInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"security._types__BulkError":{"type":"object","properties":{"count":{"type":"number","description":"The number of errors"},"details":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"description":"Details about the errors, keyed by role name"}},"required":["count","details"]},"security._types__RoleDescriptor":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}}},"security._types__ClusterPrivilege":{"anyOf":[{"enum":["all","cancel_task","create_snapshot","cross_cluster_replication","cross_cluster_search","delegate_pki","grant_api_key","manage","manage_api_key","manage_autoscaling","manage_behavioral_analytics","manage_ccr","manage_data_frame_transforms","manage_data_stream_global_retention","manage_enrich","manage_esql","manage_ilm","manage_index_templates","manage_inference","manage_ingest_pipelines","manage_logstash_pipelines","manage_ml","manage_oidc","manage_own_api_key","manage_pipeline","manage_reindex","manage_rollup","manage_saml","manage_search_application","manage_search_query_rules","manage_search_synonyms","manage_security","manage_service_account","manage_slm","manage_token","manage_transform","manage_user_profile","manage_watcher","monitor","monitor_data_frame_transforms","monitor_data_stream_global_retention","monitor_enrich","monitor_esql","monitor_inference","monitor_ml","monitor_reindex","monitor_rollup","monitor_snapshot","monitor_stats","monitor_text_structure","monitor_transform","monitor_watcher","none","post_behavioral_analytics_event","read_ccr","read_fleet_secrets","read_ilm","read_pipeline","read_security","read_slm","transport_client","write_connector_secrets","write_fleet_secrets","read_project_routing","manage_project_routing"]},{"type":"string"}]},"security._types__IndicesPrivileges":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names","privileges"]},"security._types__FieldSecurity":{"type":"object","properties":{"except":{"$ref":"./_types.json#/$defs/_types__Fields"},"grant":{"$ref":"./_types.json#/$defs/_types__Fields"}}},"security._types__IndexPrivilege":{"anyOf":[{"enum":["all","auto_configure","create","create_doc","create_index","create_view","cross_cluster_replication","cross_cluster_replication_internal","delete","delete_index","delete_view","index","maintenance","manage","manage_data_stream_lifecycle","manage_follow_index","manage_ilm","manage_leader_index","manage_view","monitor","none","read","read_cross_cluster","read_view_metadata","view_index_metadata","write"]},{"type":"string"}]},"security._types__IndicesPrivilegesQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateQuery"}],"description":"While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts."},"security._types__RoleTemplateQuery":{"type":"object","properties":{"template":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateScript","description":"When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter."}}},"security._types__RoleTemplateScript":{"type":"object","properties":{"source":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateInlineQuery"},"id":{"type":"string","description":"The `id` for a stored script."},"params":{"type":"object","additionalProperties":{},"description":"Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time."},"lang":{"$ref":"./_types.json#/$defs/_types__ScriptLanguage","description":"Specifies the language the script is written in."},"options":{"type":"object","additionalProperties":{"type":"string"}}}},"security._types__RoleTemplateInlineQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"}]},"security._types__RemoteIndicesPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["clusters","names","privileges"],"description":"The subset of index level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivilege"},"description":"The cluster level privileges that owners of the role have on the remote cluster."}},"required":["clusters","privileges"],"description":"The subset of cluster level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivilege":{"enum":["monitor_enrich","monitor_stats"]},"security._types__GlobalPrivilege":{"type":"object","properties":{"application":{"$ref":"./security._types.json#/$defs/security._types__ApplicationGlobalUserPrivileges"},"data_source":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivileges"},"description":"A list of data source privilege entries, used to grant access to ES|QL data sources.","x-availability":{"stack":{"since":"9.5.0"}}}},"required":["application"]},"security._types__ApplicationGlobalUserPrivileges":{"type":"object","properties":{"manage":{"$ref":"./security._types.json#/$defs/security._types__ManageUserPrivileges"}},"required":["manage"]},"security._types__ManageUserPrivileges":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"string"}}},"required":["applications"]},"security._types__DataSourcePrivileges":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"},"description":"A list of data source names or wildcard patterns to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivilege"},"description":"The data source privileges that owners of the role have for the specified data sources."}},"required":["names","privileges"]},"security._types__DataSourcePrivilege":{"anyOf":[{"enum":["create","delete","read_metadata","read","manage"]},{"type":"string"}]},"security._types__ApplicationPrivileges":{"type":"object","properties":{"application":{"type":"string","description":"The name of the application to which this entry applies."},"privileges":{"type":"array","items":{"type":"string"},"description":"A list of strings, where each element is the name of an application privilege or action."},"resources":{"type":"array","items":{"type":"string"},"description":"A list resources to which the privileges are applied."}},"required":["application","privileges","resources"]},"security._types__Restriction":{"type":"object","properties":{"workflows":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RestrictionWorkflow"},"description":"A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor."}},"required":["workflows"]},"security._types__RestrictionWorkflow":{"anyOf":[{"enum":["search_application_query"]},{"type":"string"}]},"security._types__ClusterNode":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"security._types__Access":{"type":"object","properties":{"replication":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ReplicationAccess"},"description":"A list of indices permission entries for cross-cluster replication."},"search":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__SearchAccess"},"description":"A list of indices permission entries for cross-cluster search."}}},"security._types__ReplicationAccess":{"type":"object","properties":{"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"allow_restricted_indices":{"type":"boolean","description":"This needs to be set to true if the patterns in the names field should cover system indices."}},"required":["names"]},"security._types__SearchAccess":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names"]},"security._types__ApiKey":{"type":"object","properties":{"id":{"type":"string","description":"Id for the API key"},"name":{"type":"string","description":"Name of the API key."},"type":{"$ref":"./security._types.json#/$defs/security._types__ApiKeyType","description":"The type of the API key (e.g. `rest` or `cross_cluster`).","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"creation":{"description":"Creation time for the API key in milliseconds."},"expiration":{"description":"Expiration time for the API key in milliseconds."},"invalidated":{"type":"boolean","description":"Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`."},"invalidation":{"description":"If the key has been invalidated, invalidation time in milliseconds.","x-availability":{"stack":{"since":"8.12.0"},"serverless":{}}},"username":{"type":"string","description":"Principal for which this API key was created"},"realm":{"type":"string","description":"Realm name of the principal for which this API key was created."},"realm_type":{"type":"string","description":"Realm type of the principal for which this API key was created","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Metadata of the API key","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions."},"limited_by":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}},"description":"The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.","x-availability":{"stack":{"since":"8.5.0"},"serverless":{}}},"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"certificate_identity":{"type":"string","description":"The certificate identity associated with a cross-cluster API key.\nRestricts the API key to connections authenticated by a specific TLS certificate.\nOnly applicable to cross-cluster API keys.","x-availability":{"stack":{"since":"9.3.0"}}},"profile_uid":{"type":"string","description":"The profile uid for the API key owner principal, if requested and if it exists","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Sorting values when using the `sort` parameter with the `security.query_api_keys` API."}},"required":["id","name","type","creation","invalidated","username","realm","metadata"]},"security._types__ApiKeyType":{"enum":["rest","cross_cluster"]},"security._types__RoleTemplate":{"type":"object","properties":{"format":{"$ref":"./security._types.json#/$defs/security._types__TemplateFormat"},"template":{"$ref":"./_types.json#/$defs/_types__Script"}},"required":["template"]},"security._types__TemplateFormat":{"enum":["string","json"]},"security._types__RoleMapping":{"type":"object","properties":{"enabled":{"type":"boolean"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"}},"rules":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"required":["enabled","metadata","rules"]},"security._types__RoleMappingRule":{"type":"object","properties":{"any":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"all":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"field":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__FieldValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}]},"minProperties":1,"maxProperties":1},"except":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}}},"security._types__RoleDescriptorRead":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}},"required":["cluster","indices"]},"security._types__SecuritySettings":{"type":"object","properties":{"index":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings"}}},"security._types__NodeSecurityStats":{"type":"object","properties":{"roles":{"$ref":"./security._types.json#/$defs/security._types__RolesStats","description":"Role statistics."}},"required":["roles"]},"security._types__RolesStats":{"type":"object","properties":{"dls":{"$ref":"./xpack.usage.json#/$defs/xpack.usage__SecurityRolesDls","description":"Document-level security (DLS) statistics."}},"required":["dls"]},"security._types__User":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"profile_uid":{"type":"string"}},"required":["metadata","roles","username","enabled"]},"security._types__UserIndicesPrivileges":{"type":"object","properties":{"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["names","privileges","allow_restricted_indices"]},"security._types__RemoteUserIndicesPrivileges":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"string"}},"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["clusters","names","privileges","allow_restricted_indices"]},"security._types__CreatedStatus":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"]},"security._types__UserProfile":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"}},"required":["uid","user","data","labels"]}}}

package/src/es/json/security.activate_user_profile.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.activate_user_profile","description":"Activate a user profile.\n\nCreate or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields.","x-api":{"id":"security.activate_user_profile","name":"activate-user-profile","namespace":"security"},"x-method":"POST","x-path":"/_security/profile/_activate","x-urls":[{"path":"/_security/profile/_activate","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"access_token":{"type":"string","description":"The user's Elasticsearch access token or JWT.\nBoth `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"grant_type":{"$ref":"./security._types.json#/$defs/security._types__GrantType","description":"The type of grant.","x-found-in":"body"},"password":{"type":"string","description":"The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"username":{"type":"string","description":"The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"}},"required":["grant_type"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.activate_user_profile","description":"Activate a user profile.\n\nCreate or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields.","x-api":{"id":"security.activate_user_profile","name":"activate-user-profile","namespace":"security"},"x-method":"POST","x-path":"/_security/profile/_activate","x-urls":[{"path":"/_security/profile/_activate","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"access_token":{"type":"string","description":"The user's Elasticsearch access token or JWT.\nBoth `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"grant_type":{"$ref":"./security._types.json#/$defs/security._types__GrantType","description":"The type of grant.","x-found-in":"body"},"password":{"type":"string","description":"The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"username":{"type":"string","description":"The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["grant_type"]}

package/src/es/json/security.authenticate.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.authenticate","description":"Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.","x-api":{"id":"security.authenticate","name":"authenticate","namespace":"security"},"x-method":"GET","x-path":"/_security/_authenticate","x-urls":[{"path":"/_security/_authenticate","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.authenticate","description":"Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.","x-api":{"id":"security.authenticate","name":"authenticate","namespace":"security"},"x-method":"GET","x-path":"/_security/_authenticate","x-urls":[{"path":"/_security/_authenticate","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/security.bulk_delete_role.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_delete_role","description":"Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.","x-api":{"id":"security.bulk_delete_role","name":"bulk-delete-role","namespace":"security"},"x-method":"DELETE","x-path":"/_security/role","x-urls":[{"path":"/_security/role","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.","x-found-in":"query"},"names":{"type":"array","items":{"type":"string"},"description":"An array of role names to delete","x-found-in":"body"}},"required":["names"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_delete_role","description":"Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.","x-api":{"id":"security.bulk_delete_role","name":"bulk-delete-role","namespace":"security"},"x-method":"DELETE","x-path":"/_security/role","x-urls":[{"path":"/_security/role","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.","x-found-in":"query"},"names":{"type":"array","items":{"type":"string"},"description":"An array of role names to delete","x-found-in":"body"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["names"]}

package/src/es/json/security.bulk_put_role.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_put_role","description":"Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.","x-api":{"id":"security.bulk_put_role","name":"bulk-put-role","namespace":"security"},"x-method":"POST","x-path":"/_security/role","x-urls":[{"path":"/_security/role","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.","x-found-in":"query"},"roles":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"A dictionary of role name to RoleDescriptor objects to add or update","x-found-in":"body"}},"required":["roles"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_put_role","description":"Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.","x-api":{"id":"security.bulk_put_role","name":"bulk-put-role","namespace":"security"},"x-method":"POST","x-path":"/_security/role","x-urls":[{"path":"/_security/role","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.","x-found-in":"query"},"roles":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"A dictionary of role name to RoleDescriptor objects to add or update","x-found-in":"body"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["roles"]}

package/src/es/json/security.bulk_update_api_keys.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_update_api_keys","description":"Bulk update API keys.\n\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.","x-api":{"id":"security.bulk_update_api_keys","name":"bulk-update-api-keys","namespace":"security"},"x-method":"POST","x-path":"/_security/api_key/_bulk_update","x-urls":[{"path":"/_security/api_key/_bulk_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.5.0","stability":"stable","visibility":"public"}},"type":"object","properties":{"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.","x-found-in":"body"},"ids":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The API key identifiers.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.","x-found-in":"body"},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.","x-found-in":"body"}},"required":["ids"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_update_api_keys","description":"Bulk update API keys.\n\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.","x-api":{"id":"security.bulk_update_api_keys","name":"bulk-update-api-keys","namespace":"security"},"x-method":"POST","x-path":"/_security/api_key/_bulk_update","x-urls":[{"path":"/_security/api_key/_bulk_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.5.0","stability":"stable","visibility":"public"}},"type":"object","properties":{"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.","x-found-in":"body"},"ids":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The API key identifiers.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.","x-found-in":"body"},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.","x-found-in":"body"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["ids"]}

package/src/es/json/security.change_password.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.change_password","description":"Change passwords.\n\nChange the passwords of users in the native realm and built-in users.","x-api":{"id":"security.change_password","name":"change-password","namespace":"security"},"x-method":"PUT","x-path":"/_security/user/{username}/_password","x-urls":[{"path":"/_security/user/{username}/_password","methods":["PUT","POST"]},{"path":"/_security/user/_password","methods":["PUT","POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.","x-found-in":"query"},"password":{"type":"string","description":"The new password value. Passwords must be at least 6 characters long.","x-found-in":"body"},"password_hash":{"type":"string","description":"A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.","x-found-in":"body"},"username":{"type":"string","description":"The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.change_password","description":"Change passwords.\n\nChange the passwords of users in the native realm and built-in users.","x-api":{"id":"security.change_password","name":"change-password","namespace":"security"},"x-method":"PUT","x-path":"/_security/user/{username}/_password","x-urls":[{"path":"/_security/user/{username}/_password","methods":["PUT","POST"]},{"path":"/_security/user/_password","methods":["PUT","POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.","x-found-in":"query"},"password":{"type":"string","description":"The new password value. Passwords must be at least 6 characters long.","x-found-in":"body"},"password_hash":{"type":"string","description":"A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.","x-found-in":"body"},"username":{"type":"string","description":"The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/security.clear_api_key_cache.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_api_key_cache","description":"Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.","x-api":{"id":"security.clear_api_key_cache","name":"clear-api-key-cache","namespace":"security"},"x-method":"POST","x-path":"/_security/api_key/{ids}/_clear_cache","x-urls":[{"path":"/_security/api_key/{ids}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"ids":{"$ref":"./_types.json#/$defs/_types__Ids","description":"Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.","x-found-in":"path"}},"required":["ids"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_api_key_cache","description":"Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.","x-api":{"id":"security.clear_api_key_cache","name":"clear-api-key-cache","namespace":"security"},"x-method":"POST","x-path":"/_security/api_key/{ids}/_clear_cache","x-urls":[{"path":"/_security/api_key/{ids}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"ids":{"$ref":"./_types.json#/$defs/_types__Ids","description":"Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["ids"]}

package/src/es/json/security.clear_api_key_cache.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_api_key_cache","x-api":{"id":"security.clear_api_key_cache","name":"clear-api-key-cache","namespace":"security"},"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_api_key_cache","x-api":{"id":"security.clear_api_key_cache","name":"clear-api-key-cache","namespace":"security"},"type":"object","properties":{"_nodes":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","x-codegen-name":"node_stats"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["_nodes","cluster_name","nodes"]}

package/src/es/json/security.clear_cached_privileges.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_privileges","description":"Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.","x-api":{"id":"security.clear_cached_privileges","name":"clear-cached-privileges","namespace":"security"},"x-method":"POST","x-path":"/_security/privilege/{application}/_clear_cache","x-urls":[{"path":"/_security/privilege/{application}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"application":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of applications.\nTo clear all applications, use an asterism (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["application"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_privileges","description":"Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.","x-api":{"id":"security.clear_cached_privileges","name":"clear-cached-privileges","namespace":"security"},"x-method":"POST","x-path":"/_security/privilege/{application}/_clear_cache","x-urls":[{"path":"/_security/privilege/{application}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"application":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of applications.\nTo clear all applications, use an asterism (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["application"]}

package/src/es/json/security.clear_cached_privileges.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_privileges","x-api":{"id":"security.clear_cached_privileges","name":"clear-cached-privileges","namespace":"security"},"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_privileges","x-api":{"id":"security.clear_cached_privileges","name":"clear-cached-privileges","namespace":"security"},"type":"object","properties":{"_nodes":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","x-codegen-name":"node_stats"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["_nodes","cluster_name","nodes"]}

package/src/es/json/security.clear_cached_realms.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_realms","description":"Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.","x-api":{"id":"security.clear_cached_realms","name":"clear-cached-realms","namespace":"security"},"x-method":"POST","x-path":"/_security/realm/{realms}/_clear_cache","x-urls":[{"path":"/_security/realm/{realms}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"usernames":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.","x-found-in":"query"},"realms":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["realms"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_realms","description":"Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.","x-api":{"id":"security.clear_cached_realms","name":"clear-cached-realms","namespace":"security"},"x-method":"POST","x-path":"/_security/realm/{realms}/_clear_cache","x-urls":[{"path":"/_security/realm/{realms}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"usernames":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.","x-found-in":"query"},"realms":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["realms"]}

package/src/es/json/security.clear_cached_realms.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_realms","x-api":{"id":"security.clear_cached_realms","name":"clear-cached-realms","namespace":"security"},"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_realms","x-api":{"id":"security.clear_cached_realms","name":"clear-cached-realms","namespace":"security"},"type":"object","properties":{"_nodes":{"$ref":"./_types.json#/$defs/_types__NodeStatistics","x-codegen-name":"node_stats"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["_nodes","cluster_name","nodes"]}