Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
769 changes: 418 additions & 351 deletions src/ApiGenerator/RestSpecification/Core/root.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"close_point_in_time":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time.html",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html",
"description":"Close a point in time"
},
"stability":"stable",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"ml.delete_trained_model":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-inference.html",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html",
"description":"Deletes an existing trained inference model that is currently not referenced by an ingest pipeline."
},
"stability":"experimental",
"url":{
"paths":[
{
"path":"/_ml/inference/{model_id}",
"path":"/_ml/trained_models/{model_id}",
"methods":[
"DELETE"
],
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"ml.get_trained_models":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference.html",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html",
"description":"Retrieves configuration information for a trained inference model."
},
"stability":"experimental",
"url":{
"paths":[
{
"path":"/_ml/inference/{model_id}",
"path":"/_ml/trained_models/{model_id}",
"methods":[
"GET"
],
Expand All @@ -20,7 +20,7 @@
}
},
{
"path":"/_ml/inference",
"path":"/_ml/trained_models",
"methods":[
"GET"
]
Expand All @@ -39,6 +39,13 @@
"required":false,
"description":"A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none."
},
"include_model_definition":{
"type":"boolean",
"required":false,
"description":"Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false.",
"default":false,
"deprecated": true
},
"decompress_definition":{
"type":"boolean",
"required":false,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"ml.get_trained_models_stats":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference-stats.html",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html",
"description":"Retrieves usage information for trained inference models."
},
"stability":"experimental",
"url":{
"paths":[
{
"path":"/_ml/inference/{model_id}/_stats",
"path":"/_ml/trained_models/{model_id}/_stats",
"methods":[
"GET"
],
Expand All @@ -20,7 +20,7 @@
}
},
{
"path":"/_ml/inference/_stats",
"path":"/_ml/trained_models/_stats",
"methods":[
"GET"
]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"ml.put_trained_model":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-inference.html",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html",
"description":"Creates an inference trained model."
},
"stability":"experimental",
"url":{
"paths":[
{
"path":"/_ml/inference/{model_id}",
"path":"/_ml/trained_models/{model_id}",
"methods":[
"PUT"
],
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"open_point_in_time":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time.html",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html",
"description":"Open a point in time that can be used in subsequent searches"
},
"stability":"stable",
Expand Down
1,031 changes: 568 additions & 463 deletions src/ApiGenerator/RestSpecification/XPack/root.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"security.clear_api_key_cache":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html",
"description":"Clear a subset or all entries from the API key cache."
},
"stability":"stable",
"url":{
"paths":[
{
"path":"/_security/api_key/{ids}/_clear_cache",
"methods":[
"POST"
],
"parts":{
"ids":{
"type":"list",
"description":"A comma-separated list of IDs of API keys to clear from the cache"
}
}
}
]
},
"params":{}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
],
"parts":{
"name":{
"type":"string",
"description":"Role name"
"type":"list",
"description":"A comma-separated list of role names"
}
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
],
"parts":{
"name":{
"type":"string",
"description":"Role-Mapping name"
"type":"list",
"description":"A comma-separated list of role-mapping names"
}
}
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"security.grant_api_key":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html",
"description":"Creates an API key on behalf of another user."
},
"stability":"stable",
"url":{
"paths":[
{
"path":"/_security/api_key/grant",
"methods":[
"POST"
]
}
]
},
"params":{
"refresh":{
"type":"enum",
"options":[
"true",
"false",
"wait_for"
],
"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."
}
},
"body":{
"description":"The api key request to create an API key",
"required":true
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ public class DeleteModelSnapshotRequestParameters : RequestParameters<DeleteMode
public override bool SupportsBody => false;
}

///<summary>Request options for DeleteTrainedModel <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-inference.html</para></summary>
///<summary>Request options for DeleteTrainedModel <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html</para></summary>
public class DeleteTrainedModelRequestParameters : RequestParameters<DeleteTrainedModelRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE;
Expand Down Expand Up @@ -607,7 +607,7 @@ public class GetAnomalyRecordsRequestParameters : RequestParameters<GetAnomalyRe
public override bool SupportsBody => true;
}

///<summary>Request options for GetTrainedModels <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference.html</para></summary>
///<summary>Request options for GetTrainedModels <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html</para></summary>
public class GetTrainedModelsRequestParameters : RequestParameters<GetTrainedModelsRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
Expand Down Expand Up @@ -650,6 +650,17 @@ public string Include
set => Q("include", value);
}

///<summary>
/// Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults
/// to false.
///</summary>
[Obsolete("Scheduled to be removed in 8.0, deprecated")]
public bool? IncludeModelDefinition
{
get => Q<bool? >("include_model_definition");
set => Q("include_model_definition", value);
}

///<summary>specifies a max number of trained models to get</summary>
public int? Size
{
Expand All @@ -665,7 +676,7 @@ public string[] Tags
}
}

///<summary>Request options for GetTrainedModelsStats <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference-stats.html</para></summary>
///<summary>Request options for GetTrainedModelsStats <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html</para></summary>
public class GetTrainedModelsStatsRequestParameters : RequestParameters<GetTrainedModelsStatsRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
Expand Down Expand Up @@ -812,7 +823,7 @@ public class PutJobRequestParameters : RequestParameters<PutJobRequestParameters
public override bool SupportsBody => true;
}

///<summary>Request options for PutTrainedModel <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/put-inference.html</para></summary>
///<summary>Request options for PutTrainedModel <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html</para></summary>
public class PutTrainedModelRequestParameters : RequestParameters<PutTrainedModelRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public class ClearScrollRequestParameters : RequestParameters<ClearScrollRequest
public override bool SupportsBody => true;
}

///<summary>Request options for ClosePointInTime <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time.html</para></summary>
///<summary>Request options for ClosePointInTime <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html</para></summary>
public class ClosePointInTimeRequestParameters : RequestParameters<ClosePointInTimeRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE;
Expand Down Expand Up @@ -1438,7 +1438,7 @@ public VersionType? VersionType
}
}

///<summary>Request options for OpenPointInTime <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time.html</para></summary>
///<summary>Request options for OpenPointInTime <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html</para></summary>
public class OpenPointInTimeRequestParameters : RequestParameters<OpenPointInTimeRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,13 @@ public Refresh? Refresh
}
}

///<summary>Request options for ClearApiKeyCache <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html</para></summary>
public class ClearApiKeyCacheRequestParameters : RequestParameters<ClearApiKeyCacheRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => false;
}

///<summary>Request options for ClearCachedPrivileges <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html</para></summary>
public class ClearCachedPrivilegesRequestParameters : RequestParameters<ClearCachedPrivilegesRequestParameters>
{
Expand Down Expand Up @@ -276,6 +283,22 @@ public class GetUserPrivilegesRequestParameters : RequestParameters<GetUserPrivi
public override bool SupportsBody => false;
}

///<summary>Request options for GrantApiKey <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html</para></summary>
public class GrantApiKeyRequestParameters : RequestParameters<GrantApiKeyRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///<summary>
/// 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.
///</summary>
public Refresh? Refresh
{
get => Q<Refresh? >("refresh");
set => Q("refresh", value);
}
}

///<summary>Request options for HasPrivileges <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html</para></summary>
public class HasPrivilegesRequestParameters : RequestParameters<HasPrivilegesRequestParameters>
{
Expand Down
Loading