mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[OAS][DOCS] Add tag x-displayName in overlays (#189842)
This commit is contained in:
parent
6bce74530a
commit
d323898483
4 changed files with 91 additions and 1671 deletions
|
@ -15,7 +15,7 @@
|
|||
|
||||
.PHONY: api-docs
|
||||
api-docs: ## Generate kibana.serverless.yaml and kibana.yaml
|
||||
@npx @redocly/cli join "kibana.info.serverless.yaml" "../x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml" "../x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml" "../src/plugins/data_views/docs/openapi/bundled.yaml" "../x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml" "../packages/core/saved-objects/docs/openapi/bundled_serverless.yaml" "../x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml" -o "output/kibana.serverless.yaml" "bundle.serverless.json" --prefix-components-with-info-prop title
|
||||
@npx @redocly/cli join "kibana.info.serverless.yaml" "../x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml" "../x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml" "../src/plugins/data_views/docs/openapi/bundled.yaml" "../x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml" "../packages/core/saved-objects/docs/openapi/bundled_serverless.yaml" "../x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml" "bundle.serverless.json" -o "output/kibana.serverless.yaml" --prefix-components-with-info-prop title
|
||||
@npx @redocly/cli join "kibana.info.yaml" "../x-pack/plugins/alerting/docs/openapi/bundled.yaml" "../x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml" "../x-pack/plugins/cases/docs/openapi/bundled.yaml" "../x-pack/plugins/actions/docs/openapi/bundled.yaml" "../src/plugins/data_views/docs/openapi/bundled.yaml" "../x-pack/plugins/ml/common/openapi/ml_apis.yaml" "../packages/core/saved-objects/docs/openapi/bundled.yaml" "bundle.json" -o "output/kibana.yaml" --prefix-components-with-info-prop title
|
||||
|
||||
.PHONY: api-docs-stateful
|
||||
|
@ -25,7 +25,7 @@ api-docs-stateful: ## Generate only kibana.yaml
|
|||
|
||||
.PHONY: api-docs-serverless
|
||||
api-docs-serverless: ## Generate only kibana.serverless.yaml
|
||||
@npx @redocly/cli join "kibana.info.serverless.yaml" "../x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml" "../x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml" "../src/plugins/data_views/docs/openapi/bundled.yaml" "../x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml" "../packages/core/saved-objects/docs/openapi/bundled_serverless.yaml" "../x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml" -o "output/kibana.serverless.yaml" "bundle.serverless.json" --prefix-components-with-info-prop title
|
||||
@npx @redocly/cli join "kibana.info.serverless.yaml" "../x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml" "../x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml" "../src/plugins/data_views/docs/openapi/bundled.yaml" "../x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml" "../packages/core/saved-objects/docs/openapi/bundled_serverless.yaml" "../x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml" "bundle.serverless.json" -o "output/kibana.serverless.yaml" --prefix-components-with-info-prop title
|
||||
|
||||
.PHONY: api-docs-lint
|
||||
api-docs-lint: ## Run spectral API docs linter
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -37,4 +37,37 @@ actions:
|
|||
- target: '$.paths[*][*]'
|
||||
description: Add x-beta
|
||||
update:
|
||||
x-beta: true
|
||||
x-beta: true
|
||||
# Add some tag descriptions and displayNames
|
||||
- target: '$.tags[?(@.name=="connectors")]'
|
||||
description: Change tag description and displayName
|
||||
update:
|
||||
description: >
|
||||
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems.
|
||||
Alerting rules can use connectors to run actions when rule conditions are met.
|
||||
externalDocs:
|
||||
description: Connector documentation
|
||||
url: https://www.elastic.co/docs/current/serverless/action-connectors
|
||||
x-displayName: "Connectors"
|
||||
- target: '$.tags[?(@.name=="data views")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "Data views"
|
||||
- target: '$.tags[?(@.name=="ml")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "Machine learning"
|
||||
- target: '$.tags[?(@.name=="saved objects")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "Saved objects"
|
||||
- target: '$.tags[?(@.name=="slo")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "Service level objectives"
|
||||
- target: '$.tags[?(@.name=="system")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "System"
|
||||
description: >
|
||||
Get information about the system status, resource usage, and installed plugins.
|
|
@ -60,3 +60,58 @@ actions:
|
|||
If you use the Kibana console to send API requests, it automatically adds the appropriate space identifier.
|
||||
|
||||
To learn more, check out [Spaces](https://www.elastic.co/guide/en/kibana/current/xpack-spaces.html).
|
||||
# Add some tag descriptions and displayNames
|
||||
- target: '$.tags[?(@.name=="alerting")]'
|
||||
description: Change tag description and displayName
|
||||
update:
|
||||
description: >
|
||||
Alerting enables you to define rules, which detect complex conditions within your data.
|
||||
When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule.
|
||||
Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
|
||||
externalDocs:
|
||||
description: Alerting documentation
|
||||
url: https://www.elastic.co/guide/en/kibana/current/alerting-getting-started.html
|
||||
x-displayName: "Alerting"
|
||||
- target: '$.tags[?(@.name=="cases")]'
|
||||
description: Change tag description and displayName
|
||||
update:
|
||||
description: >
|
||||
Cases are used to open and track issues.
|
||||
You can add assignees and tags to your cases, set their severity and status, and add alerts, comments, and visualizations.
|
||||
You can also send cases to external incident management systems by configuring connectors.
|
||||
externalDocs:
|
||||
description: Cases documentation
|
||||
url: https://www.elastic.co/guide/en/kibana/current/cases.html
|
||||
x-displayName: "Cases"
|
||||
- target: '$.tags[?(@.name=="connectors")]'
|
||||
description: Change tag description and displayName
|
||||
update:
|
||||
description: >
|
||||
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems.
|
||||
Alerting rules can use connectors to run actions when rule conditions are met.
|
||||
externalDocs:
|
||||
description: Connector documentation
|
||||
url: https://www.elastic.co/guide/en/kibana/current/action-types.html
|
||||
x-displayName: "Connectors"
|
||||
- target: '$.tags[?(@.name=="data views")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "Data views"
|
||||
- target: '$.tags[?(@.name=="ml")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "Machine learning"
|
||||
- target: '$.tags[?(@.name=="saved objects")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "Saved objects"
|
||||
# - target: '$.tags[?(@.name=="slo")]'
|
||||
# description: Change displayName
|
||||
# update:
|
||||
# x-displayName: "Service level objectives"
|
||||
- target: '$.tags[?(@.name=="system")]'
|
||||
description: Change displayName
|
||||
update:
|
||||
x-displayName: "System"
|
||||
description: >
|
||||
Get information about the system status, resource usage, and installed plugins.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue