mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
b3573364cf
## 26/06 Edits Following discussion with the team, made the following changes: * Modified curl and request and response examples with more appropriate examples ## 20/06 Edits Following discussion with the team, made the following changes: * Removed `query` parameter from the API, and therefore removed it from docs * Made API return OpenAI format by default * Removed `unredactions` property from public API schema and removed it from docs ## Summary Closes https://github.com/elastic/obs-ai-assistant-team/issues/193 Add docs for chat/complete public API. ## Steps to view documentation 1. checkout branch 2. Install bump-cli if you don't already have it: https://docs.bump.sh/help/continuous-integration/cli/ 3. Go to kibana/oas_docs folder 4. Run `bump preview output/kibana.yaml` or `bump preview output/kibana.serverless.yaml` 5. Go to the url given by the command (it takes a while to load). On the side bar, click on Observability AI Assistant menu item and there you can see the docs :) ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)   --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
50 lines
3.1 KiB
JavaScript
50 lines
3.1 KiB
JavaScript
/*
|
|
* 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
|
|
* Public License v 1"; you may not use this file except in compliance with, at
|
|
* your election, the "Elastic License 2.0", the "GNU Affero General Public
|
|
* License v3.0 only", or the "Server Side Public License, v 1".
|
|
*/
|
|
|
|
require('../../src/setup_node_env');
|
|
const { merge } = require('@kbn/openapi-bundler');
|
|
const { REPO_ROOT } = require('@kbn/repo-info');
|
|
|
|
(async () => {
|
|
await merge({
|
|
sourceGlobs: [
|
|
`${REPO_ROOT}/oas_docs/bundle.json`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/shared/alerting/docs/openapi/bundled.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/shared/cases/docs/openapi/bundled.yaml`,
|
|
`${REPO_ROOT}/src/platform/plugins/shared/data_views/docs/openapi/bundled.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/shared/features/docs/openapi/feature_apis.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/shared/ml/common/openapi/ml_apis.yaml`,
|
|
`${REPO_ROOT}/src/core/packages/saved-objects/docs/openapi/bundled.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/private/upgrade_assistant/docs/openapi/upgrade_apis.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/shared/security/docs/openapi/user_session_apis.yaml`,
|
|
`${REPO_ROOT}/src/platform/plugins/shared/share/docs/openapi/short_url_apis.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/private/logstash/docs/openapi/logstash_apis.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/shared/task_manager/docs/openapi/bundled.yaml`,
|
|
|
|
// Observability Solution
|
|
`${REPO_ROOT}/x-pack/solutions/observability/plugins/apm/docs/openapi/apm/bundled.yaml`,
|
|
`${REPO_ROOT}/x-pack/solutions/observability/plugins/slo/docs/openapi/slo/bundled.yaml`,
|
|
`${REPO_ROOT}/x-pack/solutions/observability/plugins/uptime/docs/openapi/uptime_apis.yaml`,
|
|
`${REPO_ROOT}/x-pack/solutions/observability/plugins/observability_ai_assistant_app/docs/openapi/observability_ai_assistant_app_apis.yaml`,
|
|
`${REPO_ROOT}/x-pack/solutions/observability/plugins/synthetics/docs/openapi/synthetic_apis.yaml`,
|
|
|
|
// Security solution
|
|
`${REPO_ROOT}/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/*.schema.yaml`,
|
|
`${REPO_ROOT}/x-pack/solutions/security/packages/kbn-securitysolution-lists-common/docs/openapi/ess/*.schema.yaml`,
|
|
`${REPO_ROOT}/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/ess/*.schema.yaml`,
|
|
`${REPO_ROOT}/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/ess/*.schema.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/packages/shared/kbn-elastic-assistant-common/docs/openapi/ess/*.schema.yaml`,
|
|
`${REPO_ROOT}/x-pack/platform/plugins/shared/osquery/docs/openapi/ess/*.schema.yaml`,
|
|
],
|
|
outputFilePath: `${REPO_ROOT}/oas_docs/output/kibana.yaml`,
|
|
options: {
|
|
prototypeDocument: `${REPO_ROOT}/oas_docs/kibana.info.yaml`,
|
|
},
|
|
});
|
|
})();
|