Skip to content

Commit aff7b06

Browse files
authored
[OpenAPI] Add doc_tag to machine learning APIs (#2985)
1 parent 470590b commit aff7b06

File tree

73 files changed

+399
-245
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+399
-245
lines changed

.spectral.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ rules:
2626
oas2-schema: warn
2727
# Tags
2828
openapi-tags: warn
29-
openapi-tags-alphabetical: info
29+
openapi-tags-alphabetical: false
3030
# Turn off some built-in rules
3131
operation-description: false
3232
operation-singular-tag: false

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,24 @@ actions:
139139
# M
140140
- name: ml
141141
x-displayName: Machine learning
142+
- name: ml anomaly
143+
x-displayName: Machine learning anomaly detection
144+
# description:
145+
externalDocs:
146+
url: https://www.elastic.co/guide/en/machine-learning/master/ml-ad-finding-anomalies.html
147+
description: Finding anomalies
148+
- name: ml data frame
149+
x-displayName: Machine learning data frame analytics
150+
# description:
151+
externalDocs:
152+
url: https://www.elastic.co/guide/en/machine-learning/master/ml-dfa-overview.html
153+
description: Data frame analytics overview
154+
- name: ml trained model
155+
x-displayName: Machine learning trained model
156+
# description:
157+
externalDocs:
158+
url: https://www.elastic.co/guide/en/machine-learning/master/ml-nlp-overview.html
159+
description: Natural language processing overview
142160
- name: migration
143161
x-displayName: Migration
144162
- name: monitoring

output/openapi/elasticsearch-openapi.json

Lines changed: 104 additions & 104 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 72 additions & 72 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 136 additions & 68 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import { Id } from '@_types/common'
3030
* @availability stack since=8.5.0 stability=stable
3131
* @availability serverless stability=stable visibility=private
3232
* @cluster_privileges manage_ml
33+
* @doc_tag ml trained model
3334
*/
3435
export interface Request extends RequestBase {
3536
path_parts: {

specification/ml/close_job/MlCloseJobRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import { Duration } from '@_types/Time'
3232
* @availability serverless stability=stable visibility=public
3333
* @cluster_privileges manage_ml
3434
* @doc_id ml-close-job
35+
* @doc_tag ml anomaly
3536
*/
3637
export interface Request extends RequestBase {
3738
path_parts: {

specification/ml/delete_calendar/MlDeleteCalendarRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import { Id } from '@_types/common'
2828
* @availability serverless stability=stable visibility=public
2929
* @cluster_privileges manage_ml
3030
* @doc_id ml-delete-calendar
31+
* @doc_tag ml anomaly
3132
*/
3233
export interface Request extends RequestBase {
3334
path_parts: {

specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import { Id } from '@_types/common'
2626
* @availability stack since=6.2.0 stability=stable
2727
* @availability serverless stability=stable visibility=public
2828
* @doc_id ml-delete-calendar-event
29+
* @doc_tag ml anomaly
2930
*/
3031
export interface Request extends RequestBase {
3132
path_parts: {

specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Id, Ids } from '@_types/common'
2727
* @availability serverless stability=stable visibility=public
2828
* @cluster_privileges manage_ml
2929
* @doc_id ml-delete-calendar-job
30+
* @doc_tag ml anomaly
3031
*/
3132
export interface Request extends RequestBase {
3233
path_parts: {

0 commit comments

Comments
 (0)