mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[8.16][OpenAPI] Update branch detail in API introduction (#199883)
This commit is contained in:
parent
0a4ce9ea7e
commit
df500bddb7
6 changed files with 5 additions and 28061 deletions
|
@ -1,51 +0,0 @@
|
|||
openapi: 3.0.3
|
||||
info:
|
||||
title: Kibana Serverless APIs
|
||||
description: |
|
||||
**Technical preview**
|
||||
This functionality is in technical preview and may be changed or removed in a future release.
|
||||
Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
|
||||
|
||||
The Kibana REST APIs for Elastic serverless enable you to manage resources
|
||||
such as connectors, data views, and saved objects. The API calls are
|
||||
stateless. Each request that you make happens in isolation from other calls
|
||||
and must include all of the necessary information for Kibana to fulfill the
|
||||
request. API requests return JSON output, which is a format that is
|
||||
machine-readable and works well for automation.
|
||||
|
||||
To interact with Kibana APIs, use the following operations:
|
||||
|
||||
- GET: Fetches the information.
|
||||
- POST: Adds new information.
|
||||
- PUT: Updates the existing information.
|
||||
- DELETE: Removes the information.
|
||||
|
||||
You can prepend any Kibana API endpoint with `kbn:` and run the request in
|
||||
**Dev Tools → Console**. For example:
|
||||
|
||||
```
|
||||
GET kbn:/api/data_views
|
||||
```
|
||||
|
||||
## Documentation source and versions
|
||||
|
||||
This documentation is derived from the `main` branch of the [kibana](https://github.com/elastic/kibana) repository.
|
||||
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
|
||||
version: "1.0.2"
|
||||
x-doc-license:
|
||||
name: Attribution-NonCommercial-NoDerivatives 4.0 International
|
||||
url: https://creativecommons.org/licenses/by-nc-nd/4.0/
|
||||
contact:
|
||||
name: Kibana Team
|
||||
x-feedbackLink:
|
||||
label: Feedback
|
||||
url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
|
||||
security:
|
||||
- apiKeyAuth: []
|
||||
components:
|
||||
securitySchemes:
|
||||
apiKeyAuth:
|
||||
type: apiKey
|
||||
in: header
|
||||
name: Authorization
|
||||
description: You must create an API key and use the encoded value in the request header. To learn about creating keys, go to [API keys](https://www.elastic.co/docs/current/serverless/api-keys).
|
|
@ -29,7 +29,7 @@ info:
|
|||
|
||||
## Documentation source and versions
|
||||
|
||||
This documentation is derived from the `main` branch of the [kibana](https://github.com/elastic/kibana) repository.
|
||||
This documentation is derived from the `8.16` branch of the [kibana](https://github.com/elastic/kibana) repository.
|
||||
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
|
||||
version: '1.0.2'
|
||||
x-doc-license:
|
||||
|
|
|
@ -30,7 +30,7 @@ api-docs-lint-stateful: ## Run redocly API docs linter on kibana.yaml
|
|||
@npx @redocly/cli lint "output/kibana.yaml" --config "linters/redocly.yaml" --format stylish --max-problems 500
|
||||
|
||||
.PHONY: api-docs-overlay
|
||||
api-docs-overlay: ## Run spectral API docs linter on kibana.serverless.yaml
|
||||
api-docs-overlay: ## Run spectral API docs linter on kibana.yaml
|
||||
@npx bump overlay "output/kibana.yaml" "overlays/kibana.overlays.yaml" > "output/kibana.tmp1.yaml"
|
||||
@npx bump overlay "output/kibana.tmp1.yaml" "overlays/alerting.overlays.yaml" > "output/kibana.tmp2.yaml"
|
||||
@npx bump overlay "output/kibana.tmp2.yaml" "overlays/connectors.overlays.yaml" > "output/kibana.tmp3.yaml"
|
||||
|
@ -39,11 +39,11 @@ api-docs-overlay: ## Run spectral API docs linter on kibana.serverless.yaml
|
|||
rm output/kibana.tmp*.yaml
|
||||
|
||||
.PHONY: api-docs-preview
|
||||
api-docs-preview: ## Generate a preview for kibana.yaml and kibana.serverless.yaml
|
||||
api-docs-preview: ## Generate a preview for kibana.yaml
|
||||
@npx bump preview "output/kibana.yaml"
|
||||
|
||||
.PHONY: api-docs-overlay-preview
|
||||
api-docs-overlay-preview: ## Generate a preview for kibana.new.yaml and kibana.serverless.new.yaml
|
||||
api-docs-overlay-preview: ## Generate a preview for kibana.new.yaml
|
||||
@npx bump preview "output/kibana.new.yaml"
|
||||
|
||||
help: ## Display help
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -55,7 +55,7 @@ info:
|
|||
## Documentation source and versions
|
||||
|
||||
|
||||
This documentation is derived from the `main` branch of the
|
||||
This documentation is derived from the `8.16` branch of the
|
||||
[kibana](https://github.com/elastic/kibana) repository.
|
||||
|
||||
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0
|
||||
|
|
|
@ -1,40 +0,0 @@
|
|||
/*
|
||||
* 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.serverless.json`,
|
||||
`${REPO_ROOT}/src/plugins/data_views/docs/openapi/bundled.yaml`,
|
||||
`${REPO_ROOT}/x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml`,
|
||||
`${REPO_ROOT}/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml`,
|
||||
`${REPO_ROOT}/x-pack/plugins/fleet/common/openapi/bundled.yaml`,
|
||||
|
||||
// Observability Solution
|
||||
`${REPO_ROOT}/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml`,
|
||||
`${REPO_ROOT}/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml`,
|
||||
|
||||
// Security solution
|
||||
`${REPO_ROOT}/x-pack/plugins/security_solution/docs/openapi/serverless/*.schema.yaml`,
|
||||
`${REPO_ROOT}/packages/kbn-securitysolution-lists-common/docs/openapi/serverless/*.schema.yaml`,
|
||||
`${REPO_ROOT}/packages/kbn-securitysolution-exceptions-common/docs/openapi/serverless/*.schema.yaml`,
|
||||
`${REPO_ROOT}/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/serverless/*.schema.yaml`,
|
||||
`${REPO_ROOT}/x-pack/packages/kbn-elastic-assistant-common/docs/openapi/serverless/*.schema.yaml`,
|
||||
`${REPO_ROOT}/x-pack/plugins/osquery/docs/openapi/serverless/*.schema.yaml`,
|
||||
],
|
||||
outputFilePath: `${REPO_ROOT}/oas_docs/output/kibana.serverless.yaml`,
|
||||
options: {
|
||||
prototypeDocument: `${REPO_ROOT}/oas_docs/kibana.info.serverless.yaml`,
|
||||
},
|
||||
});
|
||||
})();
|
Loading…
Add table
Add a link
Reference in a new issue