Skip to content

[ML] Adding OAS examples to public APIs #243385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
+122 −0
Draft

[ML] Adding OAS examples to public APIs #243385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e09d501
[ML] Adding OAS examples
jgowdyelastic Nov 18, 2025
cfcf724
Merge branch 'main' into adding-examples-to-public-apis
jgowdyelastic Nov 20, 2025
f31c12c
switching to yml files
jgowdyelastic Nov 20, 2025
4b46034
Merge branch 'adding-examples-to-public-apis' of github.com:jgowdyela…
jgowdyelastic Nov 20, 2025
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
44 changes: 44 additions & 0 deletions x-pack/platform/plugins/shared/ml/server/routes/saved_objects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* 2.0.
*/

import path from 'node:path';
import { ML_EXTERNAL_BASE_PATH, ML_INTERNAL_BASE_PATH } from '../../common/constants/app';
import { wrapError } from '../client/error_wrapper';
import type { RouteInitialization, SavedObjectsRouteDeps } from '../types';
Expand Down Expand Up @@ -88,6 +89,9 @@ export function savedObjectsRoutes(
query: syncJobObjects,
},
},
options: {
oasOperationObject: () => path.resolve(__dirname, './schemas/sync_saved_objects.yml'),
},
},
routeGuard.fullLicenseAPIGuard(
async ({ client, request, response, mlSavedObjectService }) => {
Expand Down Expand Up @@ -259,6 +263,9 @@ export function savedObjectsRoutes(
body: updateJobsSpaces,
},
},
options: {
oasOperationObject: () => path.resolve(__dirname, './schemas/update_job_spaces.yml'),
},
},
routeGuard.fullLicenseAPIGuard(async ({ request, response, mlSavedObjectService }) => {
try {
Expand Down Expand Up @@ -347,6 +354,43 @@ export function savedObjectsRoutes(
body: updateTrainedModelsSpaces,
},
},
options: {
oasOperationObject: () => ({
requestBody: {
content: {
'application/json': {
examples: {
updateModelSpacesRequest: {
value: {
modelIds: ['test-model'],
spacesToAdd: ['default'],
spacesToRemove: ['*'],
},
},
},
},
},
},
responses: {
200: {
content: {
'application/json': {
examples: {
successADResponse: {
value: {
'test-model': {
success: true,
type: 'trained-model',
},
},
},
},
},
},
},
},
}),
},
},
routeGuard.fullLicenseAPIGuard(async ({ request, response, mlSavedObjectService }) => {
try {
Expand Down
14 changes: 14 additions & 0 deletions x-pack/platform/plugins/shared/ml/server/routes/schemas/sync_saved_objects.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
responses:
'200':
content:
application/json:
examples:
successSyncResponse:
value:
savedObjectsCreated:
'anomaly-detector':
'test-job':
success: true
savedObjectsDeleted: {}
datafeedsAdded: {}
datafeedsRemoved: {}
32 changes: 32 additions & 0 deletions x-pack/platform/plugins/shared/ml/server/routes/schemas/update_job_spaces.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
requestBody:
content:
application/json:
examples:
updateADJobSpacesRequest:
value:
jobType: 'anomaly-detector'
jobIds: ['test-job']
spacesToAdd: ['default']
spacesToRemove: ['*']
updateDFAJobSpacesRequest:
value:
jobType: 'data-frame-analytics'
jobIds: ['test-job']
spacesToAdd: ['default']
spacesToRemove: ['*']

responses:
'200':
content:
application/json:
examples:
successADResponse:
value:
'test-job':
success: true
type: 'anomaly-detector'
successDFAResponse:
value:
'test-job':
success: true
type: 'data-frame-analytics'
32 changes: 32 additions & 0 deletions x-pack/platform/plugins/shared/ml/server/routes/schemas/update_trained_models_spaces.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
requestBody:
content:
application/json:
examples:
updateADJobSpacesRequest:
value:
jobType: 'anomaly-detector'
jobIds: ['test-job']
spacesToAdd: ['default']
spacesToRemove: ['*']
updateDFAJobSpacesRequest:
value:
jobType: 'data-frame-analytics'
jobIds: ['test-job']
spacesToAdd: ['default']
spacesToRemove: ['*']

responses:
'200':
content:
application/json:
examples:
successADResponse:
value:
'test-job':
success: true
type: 'anomaly-detector'
successDFAResponse:
value:
'test-job':
success: true
type: 'data-frame-analytics'