github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.11] [DOCS] Remove OAS API previews (#168761) (#169124)

Browse source
This commit is contained in:
Kibana Machine 2023-10-17 11:14:02 -04:00 • committed by GitHub
parent 50f400e178
commit ac6ad7878d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
55 changed files with 49 additions and 13758 deletions
Download patch file Download diff file Expand all files Collapse all files

42
docs/api-generated/README.md
View file

@ -1,42 +0,0 @@
# OpenAPI (Experimental)
Open API specifications (OAS) exist in JSON or YAML format for some Kibana features,
though they are experimental and may be incomplete or change later.
A preview of the API specifications can be added to the Kibana Guide by using
the following process:
. Install [OpenAPI Generator](https://openapi-generator.tech/docs/installation),
or a similar tool that can generate HTML output from OAS.
. Optionally validate the specifications by using the commands listed in the appropriate readmes.
. Generate HTML output. For example:
```
openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/alerting/docs/openapi/bundled.yaml -o $GIT_HOME/kibana/docs/api-generated/rules -t $GIT_HOME/kibana/docs/api-generated/template
openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/cases/docs/openapi/bundled.yaml -o $GIT_HOME/kibana/docs/api-generated/cases -t $GIT_HOME/kibana/docs/api-generated/template
openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/actions/docs/openapi/bundled.yaml -o $GIT_HOME/kibana/docs/api-generated/connectors -t $GIT_HOME/kibana/docs/api-generated/template
openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/ml/common/openapi/ml_apis_v3.yaml -o $GIT_HOME/kibana/docs/api-generated/machine-learning -t $GIT_HOME/kibana/docs/api-generated/template
```
. Rename the output files. For example:
```
mv $GIT_HOME/kibana/docs/api-generated/rules/index.html $GIT_HOME/kibana/docs/api-generated/rules/rule-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/cases/index.html $GIT_HOME/kibana/docs/api-generated/cases/case-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/connectors/index.html $GIT_HOME/kibana/docs/api-generated/connectors/connector-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/machine-learning/index.html $GIT_HOME/kibana/docs/api-generated/machine-learning/ml-apis-passthru.asciidoc
```
. If you're creating a new set of API output, you will need to have a page that incorporates the output by using passthrough blocks. For more information, refer to [Asciidoctor docs](https://docs.asciidoctor.org/asciidoc/latest/pass/pass-block/)
. Verify the output by building the Kibana documentation. At this time, the output is added as a technical preview in the appendix.
## Known issues
- Some OAS 3.0 features such as `anyOf`, `oneOf`, and `allOf` might not display properly in the preview. These are on the [Short-term roadmap](https://openapi-generator.tech/docs/roadmap/) at this time.

5511
docs/api-generated/cases/case-apis-passthru.asciidoc
View file

File diff suppressed because it is too large Load diff

10
docs/api-generated/cases/case-apis.asciidoc
View file

@ -1,10 +0,0 @@
[[case-apis]]
== Case APIs
preview::[]
////
This file includes content that has been generated from https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/docs/openapi. Any modifications required must be done in that open API specification.
////
include::case-apis-passthru.asciidoc[]

2823
docs/api-generated/connectors/connector-apis-passthru.asciidoc
View file

File diff suppressed because it is too large Load diff

10
docs/api-generated/connectors/connector-apis.asciidoc
View file

@ -1,10 +0,0 @@
[[connector-apis]]
== Connector APIs
preview::[]
////
This file includes content that has been generated from https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/docs/openapi. Any modifications required must be done in that open API specification.
////
include::connector-apis-passthru.asciidoc[]

205
docs/api-generated/machine-learning/ml-apis-passthru.asciidoc
View file

@ -1,205 +0,0 @@
////
This content is generated from the open API specification.
Any modifications made to this file will be overwritten.
////
++++
<div class="openapi">
<h2>Access</h2>
<ol>
<li>APIKey KeyParamName:ApiKey KeyInQuery:false KeyInHeader:true</li>
<li>HTTP Basic Authentication</li>
</ol>
<h2><a name="__Methods">Methods</a></h2>
[ Jump to <a href="#__Models">Models</a> ]
<h3>Table of Contents </h3>
<div class="method-summary"></div>
<h4><a href="#Ml">Ml</a></h4>
<ul>
<li><a href="#mlSync"><code><span class="http-method">get</span> /s/{spaceId}/api/ml/saved_objects/sync</code></a></li>
</ul>
<h1><a name="Ml">Ml</a></h1>
<div class="method"><a name="mlSync"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/ml/saved_objects/sync</code></pre></div>
<div class="method-summary">Synchronizes Kibana saved objects for machine learning jobs and trained models. (<span class="nickname">mlSync</span>)</div>
<div class="method-notes">You must have <code>all</code> privileges for the <strong>Machine Learning</strong> feature in the <strong>Analytics</strong> section of the Kibana feature privileges. This API runs automatically when you start Kibana and periodically thereafter.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">simulate (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; When true, simulates the synchronization by returning only the list of actions that would be performed. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#mlSync200Response">mlSync200Response</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"datafeedsAdded" : {
"key" : {
"success" : true
}
},
"savedObjectsCreated" : {
"anomaly-detector" : {
"key" : {
"success" : true
}
},
"data-frame-analytics" : {
"key" : {
"success" : true
}
},
"trained-model" : {
"key" : {
"success" : true
}
}
},
"savedObjectsDeleted" : {
"anomaly-detector" : {
"key" : {
"success" : true
}
},
"data-frame-analytics" : {
"key" : {
"success" : true
}
},
"trained-model" : {
"key" : {
"success" : true
}
}
},
"datafeedsRemoved" : {
"key" : {
"success" : true
}
}
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Indicates a successful call
<a href="#mlSync200Response">mlSync200Response</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#mlSync4xxResponse">mlSync4xxResponse</a>
</div> <!-- method -->
<hr/>
<h2><a name="__Models">Models</a></h2>
[ Jump to <a href="#__Methods">Methods</a> ]
<h3>Table of Contents</h3>
<ol>
<li><a href="#mlSync200Response"><code>mlSync200Response</code> - Successful sync API response</a></li>
<li><a href="#mlSync4xxResponse"><code>mlSync4xxResponse</code> - Unsuccessful sync API response</a></li>
<li><a href="#mlSyncResponseAnomalyDetectors"><code>mlSyncResponseAnomalyDetectors</code> - Sync API response for anomaly detection jobs</a></li>
<li><a href="#mlSyncResponseDataFrameAnalytics"><code>mlSyncResponseDataFrameAnalytics</code> - Sync API response for data frame analytics jobs</a></li>
<li><a href="#mlSyncResponseDatafeeds"><code>mlSyncResponseDatafeeds</code> - Sync API response for datafeeds</a></li>
<li><a href="#mlSyncResponseSavedObjectsCreated"><code>mlSyncResponseSavedObjectsCreated</code> - Sync API response for created saved objects</a></li>
<li><a href="#mlSyncResponseSavedObjectsDeleted"><code>mlSyncResponseSavedObjectsDeleted</code> - Sync API response for deleted saved objects</a></li>
<li><a href="#mlSyncResponseTrainedModels"><code>mlSyncResponseTrainedModels</code> - Sync API response for trained models</a></li>
</ol>
<div class="model">
<h3><a name="mlSync200Response"><code>mlSync200Response</code> - Successful sync API response</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">datafeedsAdded (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseDatafeeds">map[String, mlSyncResponseDatafeeds]</a></span> If a saved object for an anomaly detection job is missing a datafeed identifier, it is added when you run the sync machine learning saved objects API. </div>
<div class="param">datafeedsRemoved (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseDatafeeds">map[String, mlSyncResponseDatafeeds]</a></span> If a saved object for an anomaly detection job references a datafeed that no longer exists, it is deleted when you run the sync machine learning saved objects API. </div>
<div class="param">savedObjectsCreated (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseSavedObjectsCreated">mlSyncResponseSavedObjectsCreated</a></span> </div>
<div class="param">savedObjectsDeleted (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseSavedObjectsDeleted">mlSyncResponseSavedObjectsDeleted</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="mlSync4xxResponse"><code>mlSync4xxResponse</code> - Unsuccessful sync API response</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="mlSyncResponseAnomalyDetectors"><code>mlSyncResponseAnomalyDetectors</code> - Sync API response for anomaly detection jobs</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The sync machine learning saved objects API response contains this object when there are anomaly detection jobs affected by the synchronization. There is an object for each relevant job, which contains the synchronization status.</div>
<div class="field-items">
<div class="param">success (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> The success or failure of the synchronization. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="mlSyncResponseDataFrameAnalytics"><code>mlSyncResponseDataFrameAnalytics</code> - Sync API response for data frame analytics jobs</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The sync machine learning saved objects API response contains this object when there are data frame analytics jobs affected by the synchronization. There is an object for each relevant job, which contains the synchronization status.</div>
<div class="field-items">
<div class="param">success (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> The success or failure of the synchronization. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="mlSyncResponseDatafeeds"><code>mlSyncResponseDatafeeds</code> - Sync API response for datafeeds</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The sync machine learning saved objects API response contains this object when there are datafeeds affected by the synchronization. There is an object for each relevant datafeed, which contains the synchronization status.</div>
<div class="field-items">
<div class="param">success (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> The success or failure of the synchronization. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="mlSyncResponseSavedObjectsCreated"><code>mlSyncResponseSavedObjectsCreated</code> - Sync API response for created saved objects</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>If saved objects are missing for machine learning jobs or trained models, they are created when you run the sync machine learning saved objects API.</div>
<div class="field-items">
<div class="param">anomalyMinusdetector (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseAnomalyDetectors">map[String, mlSyncResponseAnomalyDetectors]</a></span> If saved objects are missing for anomaly detection jobs, they are created. </div>
<div class="param">dataMinusframeMinusanalytics (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseDataFrameAnalytics">map[String, mlSyncResponseDataFrameAnalytics]</a></span> If saved objects are missing for data frame analytics jobs, they are created. </div>
<div class="param">trainedMinusmodel (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseTrainedModels">map[String, mlSyncResponseTrainedModels]</a></span> If saved objects are missing for trained models, they are created. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="mlSyncResponseSavedObjectsDeleted"><code>mlSyncResponseSavedObjectsDeleted</code> - Sync API response for deleted saved objects</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>If saved objects exist for machine learning jobs or trained models that no longer exist, they are deleted when you run the sync machine learning saved objects API.</div>
<div class="field-items">
<div class="param">anomalyMinusdetector (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseAnomalyDetectors">map[String, mlSyncResponseAnomalyDetectors]</a></span> If there are saved objects exist for nonexistent anomaly detection jobs, they are deleted. </div>
<div class="param">dataMinusframeMinusanalytics (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseDataFrameAnalytics">map[String, mlSyncResponseDataFrameAnalytics]</a></span> If there are saved objects exist for nonexistent data frame analytics jobs, they are deleted. </div>
<div class="param">trainedMinusmodel (optional)</div><div class="param-desc"><span class="param-type"><a href="#mlSyncResponseTrainedModels">map[String, mlSyncResponseTrainedModels]</a></span> If there are saved objects exist for nonexistent trained models, they are deleted. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="mlSyncResponseTrainedModels"><code>mlSyncResponseTrainedModels</code> - Sync API response for trained models</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The sync machine learning saved objects API response contains this object when there are trained models affected by the synchronization. There is an object for each relevant trained model, which contains the synchronization status.</div>
<div class="field-items">
<div class="param">success (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> The success or failure of the synchronization. </div>
</div> <!-- field-items -->
</div>
</div>
++++

10
docs/api-generated/machine-learning/ml-apis.asciidoc
View file

@ -1,10 +0,0 @@
[[machine-learning-apis]]
== Machine learning APIs
preview::[]
////
This file includes content that has been generated from https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/openapi. Any modifications required must be done in that open API specification.
////
include::ml-apis-passthru.asciidoc[]

4905
docs/api-generated/rules/rule-apis-passthru.asciidoc
View file

File diff suppressed because it is too large Load diff

10
docs/api-generated/rules/rule-apis.asciidoc
View file

@ -1,10 +0,0 @@
[[rule-apis]]
== Alert and rule APIs
preview::[]
////
This file includes content that has been generated from https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/docs/openapi. Any modifications required must be done in that open API specification.
////
include::rule-apis-passthru.asciidoc[]

170
docs/api-generated/template/index.mustache
View file

@ -1,170 +0,0 @@
////
This content is generated from the open API specification.
Any modifications made to this file will be overwritten.
////
++++
<div class="openapi">
<h2>Access</h2>
{{#hasAuthMethods}}
<ol>
{{#authMethods}}
<li>{{#isBasic}}HTTP Basic Authentication{{/isBasic}}{{#isOAuth}}OAuth AuthorizationUrl:{{authorizationUrl}}TokenUrl:{{tokenUrl}}{{/isOAuth}}{{#isApiKey}}APIKey KeyParamName:{{keyParamName}} KeyInQuery:{{isKeyInQuery}} KeyInHeader:{{isKeyInHeader}}{{/isApiKey}}</li>
{{/authMethods}}
</ol>
{{/hasAuthMethods}}
<h2><a name="__Methods">Methods</a></h2>
[ Jump to <a href="#__Models">Models</a> ]
{{! for the tables of content, I cheat and don't use CSS styles.... }}
<h3>Table of Contents </h3>
<div class="method-summary">{{access}}</div>
{{#apiInfo}}
{{#apis}}
{{#operations}}
<h4><a href="#{{baseName}}">{{baseName}}</a></h4>
<ul>
{{#operation}}
<li><a href="#{{nickname}}"><code><span class="http-method">{{httpMethod}}</span> {{path}}</code></a></li>
{{/operation}}
</ul>
{{/operations}}
{{/apis}}
{{/apiInfo}}
{{#apiInfo}}
{{#apis}}
{{#operations}}
<h1><a name="{{baseName}}">{{baseName}}</a></h1>
{{#operation}}
<div class="method"><a name="{{nickname}}"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="{{httpMethod}}"><code class="huge"><span class="http-method">{{httpMethod}}</span> {{path}}</code></pre></div>
<div class="method-summary">{{summary}} (<span class="nickname">{{nickname}}</span>)</div>
{{! notes is operation.description. So why rename it and make it super confusing???? }}
<div class="method-notes">{{notes}}</div>
{{#hasPathParams}}
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
{{#pathParams}}{{>pathParam}}{{/pathParams}}
</div> <!-- field-items -->
{{/hasPathParams}}
{{#hasConsumes}}
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
{{#consumes}}
<li><code>{{{mediaType}}}</code></li>
{{/consumes}}
</ul>
{{/hasConsumes}}
{{#hasBodyParam}}
<h3 class="field-label">Request body</h3>
<div class="field-items">
{{#bodyParams}}{{>bodyParam}}{{/bodyParams}}
</div> <!-- field-items -->
{{/hasBodyParam}}
{{#hasHeaderParams}}
<h3 class="field-label">Request headers</h3>
<div class="field-items">
{{#headerParams}}{{>headerParam}}{{/headerParams}}
</div> <!-- field-items -->
{{/hasHeaderParams}}
{{#hasQueryParams}}
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
{{#queryParams}}{{>queryParam}}{{/queryParams}}
</div> <!-- field-items -->
{{/hasQueryParams}}
{{#hasFormParams}}
<h3 class="field-label">Form parameters</h3>
<div class="field-items">
{{#formParams}}{{>formParam}}{{/formParams}}
</div> <!-- field-items -->
{{/hasFormParams}}
{{#returnType}}
<h3 class="field-label">Return type</h3>
<div class="return-type">
{{#hasReference}}{{^returnSimpleType}}{{returnContainer}}[{{/returnSimpleType}}<a href="#{{returnBaseType}}">{{returnBaseType}}</a>{{^returnSimpleType}}]{{/returnSimpleType}}{{/hasReference}}
{{^hasReference}}{{returnType}}{{/hasReference}}
</div>
{{/returnType}}
<!--Todo: process Response Object and its headers, schema, examples -->
{{#hasExamples}}
{{#examples}}
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: {{{contentType}}}</div>
<pre class="example"><code>{{{example}}}</code></pre>
{{/examples}}
{{/hasExamples}}
{{#hasProduces}}
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
{{#produces}}
<li><code>{{{mediaType}}}</code></li>
{{/produces}}
</ul>
{{/hasProduces}}
<h3 class="field-label">Responses</h3>
{{#responses}}
<h4 class="field-label">{{code}}</h4>
{{message}}
{{^containerType}}<a href="#{{dataType}}">{{dataType}}</a>{{/containerType}}
{{#examples}}
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: {{{contentType}}}</div>
<pre class="example"><code>{{example}}</code></pre>
{{/examples}}
{{/responses}}
</div> <!-- method -->
<hr/>
{{/operation}}
{{/operations}}
{{/apis}}
{{/apiInfo}}
<h2><a name="__Models">Models</a></h2>
[ Jump to <a href="#__Methods">Methods</a> ]
<h3>Table of Contents</h3>
<ol>
{{#models}}
{{#model}}
<li><a href="#{{name}}"><code>{{name}}</code>{{#title}} - {{.}}{{/title}}</a></li>
{{/model}}
{{/models}}
</ol>
{{#models}}
{{#model}}
<div class="model">
<h3><a name="{{name}}"><code>{{name}}</code>{{#title}} - {{.}}{{/title}}</a> <a class="up" href="#__Models">Up</a></h3>
{{#unescapedDescription}}<div class='model-description'>{{.}}</div>{{/unescapedDescription}}
<div class="field-items">
{{#vars}}<div class="param">{{name}} {{^required}}(optional){{/required}}</div><div class="param-desc"><span class="param-type">{{^isPrimitiveType}}<a href="#{{complexType}}">{{dataType}}</a>{{/isPrimitiveType}}</span> {{unescapedDescription}} {{#dataFormat}}format: {{{.}}}{{/dataFormat}}</div>
{{#isEnum}}
<div class="param-enum-header">Enum:</div>
{{#_enum}}<div class="param-enum">{{this}}</div>{{/_enum}}
{{/isEnum}}
{{/vars}}
</div> <!-- field-items -->
</div>
{{/model}}
{{/models}}
</div>
++++

2
docs/api/actions-and-connectors/create.asciidoc
View file

@ -9,7 +9,7 @@ Creates a connector.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
====
[[create-connector-api-request]]

2
docs/api/actions-and-connectors/delete.asciidoc
View file

@ -11,7 +11,7 @@ WARNING: When you delete a connector, _it cannot be recovered_.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
====
[discrete]

2
docs/api/actions-and-connectors/execute.asciidoc
View file

@ -9,7 +9,7 @@ Runs a connector by ID.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
====
[[execute-connector-api-request]]

2
docs/api/actions-and-connectors/get.asciidoc
View file

@ -9,7 +9,7 @@ Retrieves a connector by ID.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
====
[discrete]

2
docs/api/actions-and-connectors/get_all.asciidoc
View file

@ -9,7 +9,7 @@ Retrieves all connectors.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
====
[discrete]

2
docs/api/actions-and-connectors/list.asciidoc
View file

@ -9,7 +9,7 @@ Retrieves a list of all connector types.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
====
[[list-connector-types-api-request]]

2
docs/api/actions-and-connectors/update.asciidoc
View file

@ -9,7 +9,7 @@ Updates the attributes for a connector.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
====
[[update-connector-api-request]]

2
docs/api/alerting/create_rule.asciidoc
View file

@ -9,7 +9,7 @@ Create {kib} rules.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[create-rule-api-request]]

2
docs/api/alerting/delete_rule.asciidoc
View file

@ -11,7 +11,7 @@ WARNING: After you delete a rule, you cannot recover it.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[delete-rule-api-request]]

2
docs/api/alerting/disable_rule.asciidoc
View file

@ -9,7 +9,7 @@ Disable a rule.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[disable-rule-api-request]]

2
docs/api/alerting/enable_rule.asciidoc
View file

@ -11,7 +11,7 @@ WARNING: This API supports <<token-api-authentication>> only.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[enable-rule-api-request]]

2
docs/api/alerting/find_rules.asciidoc
View file

@ -9,7 +9,7 @@ Retrieve a paginated set of rules based on condition.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[find-rules-api-request]]

2
docs/api/alerting/get_rules.asciidoc
View file

@ -9,7 +9,7 @@ Retrieve a rule by ID.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[get-rule-api-request]]

2
docs/api/alerting/health.asciidoc
View file

@ -9,7 +9,7 @@ Retrieve the health status of the alerting framework.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[get-alerting-framework-health-api-request]]

2
docs/api/alerting/list_rule_types.asciidoc
View file

@ -9,7 +9,7 @@ Retrieve a list of rule types that the user is authorized to access.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====

2
docs/api/alerting/mute_alert.asciidoc
View file

@ -9,7 +9,7 @@ Mute an alert.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[mute-alert-api-request]]

2
docs/api/alerting/mute_all_alerts.asciidoc
View file

@ -9,7 +9,7 @@ Mute all alerts.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[mute-all-alerts-api-request]]

2
docs/api/alerting/unmute_alert.asciidoc
View file

@ -9,7 +9,7 @@ Unmute an alert.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[unmute-alert-api-request]]

2
docs/api/alerting/unmute_all_alerts.asciidoc
View file

@ -9,7 +9,7 @@ Unmute all alerts.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[unmute-all-alerts-api-all-request]]

2
docs/api/alerting/update_rule.asciidoc
View file

@ -9,7 +9,7 @@ Update the attributes for an existing rule.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification]. For a preview, check out <<rule-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
====
[[update-rule-api-request]]

2
docs/api/cases/cases-api-add-comment.asciidoc
View file

@ -9,7 +9,7 @@ Adds a comment or alert to a case.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-create.asciidoc
View file

@ -9,7 +9,7 @@ Creates a case.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-delete-cases.asciidoc
View file

@ -9,7 +9,7 @@ Deletes one or more cases.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-delete-comments.asciidoc
View file

@ -9,7 +9,7 @@ Deletes one or all comments and alerts from a case.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-find-case-activity.asciidoc
View file

@ -9,7 +9,7 @@ Finds user activity for a case.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-find-cases.asciidoc
View file

@ -9,7 +9,7 @@ Retrieves a paginated subset of cases.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-find-connectors.asciidoc
View file

@ -13,7 +13,7 @@ returned. Refer to the list of supported external incident management systems in
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-get-alerts.asciidoc
View file

@ -11,7 +11,7 @@ Gets all alerts attached to a case.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-get-case-activity.asciidoc
View file

@ -11,7 +11,7 @@ deprecated::[8.1.0,Use <<cases-api-find-case-activity>> instead.]
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-get-case.asciidoc
View file

@ -9,7 +9,7 @@ Returns information about a case.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-get-cases-by-alert.asciidoc
View file

@ -11,7 +11,7 @@ Returns the cases associated with a specific alert.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====

2
docs/api/cases/cases-api-get-comments.asciidoc
View file

@ -9,7 +9,7 @@ Gets a comment or all comments for a case.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-get-configuration.asciidoc
View file

@ -10,7 +10,7 @@ default connector for cases.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-get-reporters.asciidoc
View file

@ -9,7 +9,7 @@ Returns information about the users who opened cases.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====

2
docs/api/cases/cases-api-get-status.asciidoc
View file

@ -9,7 +9,7 @@ Returns the number of cases that are open, closed, and in progress.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
deprecated::[8.1.0]

2
docs/api/cases/cases-api-get-tags.asciidoc
View file

@ -9,7 +9,7 @@ Aggregates and returns a list of case tags.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-push.asciidoc
View file

@ -9,7 +9,7 @@ Pushes a case to an external service.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-set-configuration.asciidoc
View file

@ -10,7 +10,7 @@ default connector for cases.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-update-comment.asciidoc
View file

@ -9,7 +9,7 @@ Updates a comment or alert in a case.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-update-configuration.asciidoc
View file

@ -10,7 +10,7 @@ connector for cases.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/cases/cases-api-update.asciidoc
View file

@ -9,7 +9,7 @@ Updates one or more cases.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification].
====
=== {api-request-title}

2
docs/api/machine-learning/sync.asciidoc
View file

@ -9,7 +9,7 @@ Synchronizes {kib} saved objects for {ml} jobs and trained models.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/ml/common/openapi[open API specification]. For a preview, check out <<machine-learning-apis>>.
{kib-repo}/tree/{branch}/x-pack/plugins/ml/common/openapi[open API specification].
====
[[machine-learning-api-sync-request]]

17
docs/apis.asciidoc
View file

@ -1,17 +0,0 @@
[role="exclude",id="apis"]
= APIs
[partintro]
--
preview::[]
These APIs are documented using the OpenAPI specification. The current supported
version of the specification is 3.0. For more information, go to https://openapi-generator.tech/[OpenAPI Generator]
--
include::api-generated/cases/case-apis.asciidoc[]
include::api-generated/connectors/connector-apis.asciidoc[]
include::api-generated/machine-learning/ml-apis.asciidoc[]
include::api-generated/rules/rule-apis.asciidoc[]

2
docs/index.asciidoc
View file

@ -17,7 +17,5 @@ include::CHANGELOG.asciidoc[]
include::developer/index.asciidoc[]
include::apis.asciidoc[]
include::redirects.asciidoc[]

8
docs/redirects.asciidoc
View file

@ -426,4 +426,10 @@ This content has moved. Refer to <<enhancements-and-bug-fixes-v8.10.0-revised>>
[role="exclude",id="gen-ai-action-type"]
== Generative AI connector and action
This connector was renamed. Refer to <<openai-action-type>>.
This connector was renamed. Refer to <<openai-action-type>>.
[role="exclude",id="apis"]
== APIs
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[alerting], {kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[cases], {kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[connectors], and {kib-repo}/tree/{branch}/x-pack/plugins/ml/common/openapi[machine learning] open API specifications.