mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
f9c43f61c9
## Summary - Removes `apidoc-markdown` dependency and custom scripts for generating internal documentation for ML Kibana endpoints - Replaces apidoc annotations with `summary` and `description` props for route handlers and kbn-schemas to generate an OpenAPI spec file - `/internal/ml/jobs/delete_jobs` route was not versioned for some reason, I changed that #### How to test 1. Enable OAS endpoint in `kibana.dev.yml` ```yaml server.oas.enabled: true ``` 2. Start Kibana dev server ```bash yarn start --no-base-path ``` 3. Call the OAS endpoint for ML _internal_ routes ```bash curl -s -u <USERNAME>:<PASSWORD> http://localhost:5601/api/oas\?pathStartsWith\=/internal/ml\&access\=internal -o ml_kibana_openapi.json ```
87 lines
2.7 KiB
TypeScript
87 lines
2.7 KiB
TypeScript
/*
|
|
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
* or more contributor license agreements. Licensed under the Elastic License
|
|
* 2.0; you may not use this file except in compliance with the Elastic License
|
|
* 2.0.
|
|
*/
|
|
|
|
import type { IScopedClusterClient } from '@kbn/core/server';
|
|
import type { FieldsForHistograms } from '@kbn/ml-agg-utils';
|
|
import type { RuntimeMappings } from '@kbn/ml-runtime-field-utils';
|
|
import { ML_INTERNAL_BASE_PATH } from '../../common/constants/app';
|
|
import { wrapError } from '../client/error_wrapper';
|
|
import { DataVisualizer } from '../models/data_visualizer';
|
|
import {
|
|
dataVisualizerFieldHistogramsResponse,
|
|
dataVisualizerFieldHistogramsSchema,
|
|
indexPatternSchema,
|
|
} from './schemas/data_visualizer_schema';
|
|
import type { RouteInitialization } from '../types';
|
|
|
|
function getHistogramsForFields(
|
|
client: IScopedClusterClient,
|
|
indexPattern: string,
|
|
query: any,
|
|
fields: FieldsForHistograms,
|
|
samplerShardSize: number,
|
|
runtimeMappings: RuntimeMappings
|
|
) {
|
|
const dv = new DataVisualizer(client);
|
|
return dv.getHistogramsForFields(indexPattern, query, fields, samplerShardSize, runtimeMappings);
|
|
}
|
|
|
|
/**
|
|
* Routes for the index data visualizer.
|
|
*/
|
|
export function dataVisualizerRoutes({ router, routeGuard }: RouteInitialization) {
|
|
router.versioned
|
|
.post({
|
|
path: `${ML_INTERNAL_BASE_PATH}/data_visualizer/get_field_histograms/{indexPattern}`,
|
|
access: 'internal',
|
|
options: {
|
|
tags: ['access:ml:canGetFieldInfo'],
|
|
},
|
|
summary: 'Gets histograms for fields',
|
|
description: 'Returns the histograms on a list fields in the specified index pattern.',
|
|
})
|
|
.addVersion(
|
|
{
|
|
version: '1',
|
|
validate: {
|
|
request: {
|
|
params: indexPatternSchema,
|
|
body: dataVisualizerFieldHistogramsSchema,
|
|
},
|
|
response: {
|
|
200: {
|
|
body: dataVisualizerFieldHistogramsResponse,
|
|
description: 'Histograms by field, keyed on the name of the field.',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
routeGuard.basicLicenseAPIGuard(async ({ client, request, response }) => {
|
|
try {
|
|
const {
|
|
params: { indexPattern },
|
|
body: { query, fields, samplerShardSize, runtimeMappings },
|
|
} = request;
|
|
|
|
const results = await getHistogramsForFields(
|
|
client,
|
|
indexPattern,
|
|
query,
|
|
fields,
|
|
samplerShardSize,
|
|
runtimeMappings
|
|
);
|
|
|
|
return response.ok({
|
|
body: results,
|
|
});
|
|
} catch (e) {
|
|
return response.customError(wrapError(e));
|
|
}
|
|
})
|
|
);
|
|
}
|