github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Add SLO APIs to bundled OpenAPI document (#186575)

Browse source
This commit is contained in:
Lisa Cawley 2024-06-20 19:49:05 -07:00 • committed by GitHub
parent 4db61fa913
commit cd96a10529
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 1898 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

1866
oas_docs/kibana.serverless.yaml
View file

File diff suppressed because it is too large Load diff

2
oas_docs/makefile
View file

@ -15,7 +15,7 @@
.PHONY: api-docs
api-docs: ## Generate 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" -o "kibana.serverless.yaml" --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" -o "kibana.serverless.yaml" --prefix-components-with-info-prop title
.PHONY: api-docs-lint
api-docs-lint: ## Run spectral API docs linter

18
x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json
View file

@ -35,7 +35,7 @@
"paths": {
"/s/{spaceId}/api/observability/slos": {
"post": {
"summary": "Creates an SLO.",
"summary": "Create an SLO",
"operationId": "createSloOp",
"description": "You must have `all` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.\n",
"tags": [
@ -256,7 +256,7 @@
},
"/s/{spaceId}/api/observability/slos/{sloId}": {
"get": {
"summary": "Get a SLO",
"summary": "Get an SLO",
"operationId": "getSloOp",
"description": "You must have the `read` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.\n",
"tags": [
@ -336,7 +336,7 @@
}
},
"put": {
"summary": "Updates an SLO",
"summary": "Update an SLO",
"operationId": "updateSloOp",
"description": "You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.\n",
"tags": [
@ -417,7 +417,7 @@
}
},
"delete": {
"summary": "Deletes an SLO",
"summary": "Delete an SLO",
"operationId": "deleteSloOp",
"description": "You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.\n",
"tags": [
@ -483,7 +483,7 @@
},
"/s/{spaceId}/api/observability/slos/{sloId}/enable": {
"post": {
"summary": "Enables an SLO",
"summary": "Enable an SLO",
"operationId": "enableSloOp",
"description": "You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.\n",
"tags": [
@ -549,7 +549,7 @@
},
"/s/{spaceId}/api/observability/slos/{sloId}/disable": {
"post": {
"summary": "Disables an SLO",
"summary": "Disable an SLO",
"operationId": "disableSloOp",
"description": "You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.\n",
"tags": [
@ -615,7 +615,7 @@
},
"/s/{spaceId}/api/observability/slos/{sloId}/_reset": {
"post": {
"summary": "Resets an SLO.",
"summary": "Reset an SLO",
"operationId": "resetSloOp",
"description": "You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.\n",
"tags": [
@ -1111,7 +1111,7 @@
]
},
"kql_with_filters_good": {
"title": "KQL with filters",
"title": "KQL query for good events",
"description": "The KQL query used to define the good events.",
"oneOf": [
{
@ -1136,7 +1136,7 @@
]
},
"kql_with_filters_total": {
"title": "KQL with filters",
"title": "KQL query for all events",
"description": "The KQL query used to define all events.",
"oneOf": [
{

18
x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml
View file

@ -20,7 +20,7 @@ tags:
paths:
/s/{spaceId}/api/observability/slos:
post:
summary: Creates an SLO.
summary: Create an SLO
operationId: createSloOp
description: |
You must have `all` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
@ -159,7 +159,7 @@ paths:
$ref: '#/components/schemas/404_response'
/s/{spaceId}/api/observability/slos/{sloId}:
get:
summary: Get a SLO
summary: Get an SLO
operationId: getSloOp
description: |
You must have the `read` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
@ -207,7 +207,7 @@ paths:
schema:
$ref: '#/components/schemas/404_response'
put:
summary: Updates an SLO
summary: Update an SLO
operationId: updateSloOp
description: |
You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
@ -255,7 +255,7 @@ paths:
schema:
$ref: '#/components/schemas/404_response'
delete:
summary: Deletes an SLO
summary: Delete an SLO
operationId: deleteSloOp
description: |
You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
@ -294,7 +294,7 @@ paths:
$ref: '#/components/schemas/404_response'
/s/{spaceId}/api/observability/slos/{sloId}/enable:
post:
summary: Enables an SLO
summary: Enable an SLO
operationId: enableSloOp
description: |
You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
@ -333,7 +333,7 @@ paths:
$ref: '#/components/schemas/404_response'
/s/{spaceId}/api/observability/slos/{sloId}/disable:
post:
summary: Disables an SLO
summary: Disable an SLO
operationId: disableSloOp
description: |
You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
@ -372,7 +372,7 @@ paths:
$ref: '#/components/schemas/404_response'
/s/{spaceId}/api/observability/slos/{sloId}/_reset:
post:
summary: Resets an SLO.
summary: Reset an SLO
operationId: resetSloOp
description: |
You must have the `write` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
@ -694,7 +694,7 @@ components:
items:
$ref: '#/components/schemas/filter'
kql_with_filters_good:
title: KQL with filters
title: KQL query for good events
description: The KQL query used to define the good events.
oneOf:
- description: the KQL query to filter the documents with.
@ -709,7 +709,7 @@ components:
items:
$ref: '#/components/schemas/filter'
kql_with_filters_total:
title: KQL with filters
title: KQL query for all events
description: The KQL query used to define all events.
oneOf:
- description: the KQL query to filter the documents with.

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/indicator_properties_custom_kql.yaml
View file

@ -23,7 +23,7 @@ properties:
description: The kibana data view id to use, primarily used to include data view runtime mappings.
Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
type: string
example: 03b80ab3-003d-498b-881c-3beedbaf1162
example: '03b80ab3-003d-498b-881c-3beedbaf1162'
filter:
$ref: "kql_with_filters.yaml"
good:

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/indicator_properties_custom_metric.yaml
View file

@ -23,7 +23,7 @@ properties:
description: The kibana data view id to use, primarily used to include data view runtime mappings.
Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
type: string
example: 03b80ab3-003d-498b-881c-3beedbaf1162
example: '03b80ab3-003d-498b-881c-3beedbaf1162'
filter:
description: the KQL query to filter the documents with.
type: string

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/indicator_properties_histogram.yaml
View file

@ -23,7 +23,7 @@ properties:
description: The kibana data view id to use, primarily used to include data view runtime mappings.
Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
type: string
example: 03b80ab3-003d-498b-881c-3beedbaf1162
example: '03b80ab3-003d-498b-881c-3beedbaf1162'
filter:
description: the KQL query to filter the documents with.
type: string

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/indicator_properties_timeslice_metric.yaml
View file

@ -22,7 +22,7 @@ properties:
description: The kibana data view id to use, primarily used to include data view runtime mappings.
Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.
type: string
example: 03b80ab3-003d-498b-881c-3beedbaf1162
example: '03b80ab3-003d-498b-881c-3beedbaf1162'
filter:
description: the KQL query to filter the documents with.
type: string

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/kql_with_filters_good.yaml
View file

@ -1,4 +1,4 @@
title: KQL with filters
title: KQL query for good events
description: The KQL query used to define the good events.
oneOf:
- description: the KQL query to filter the documents with.

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/kql_with_filters_total.yaml
View file

@ -1,4 +1,4 @@
title: KQL with filters
title: KQL query for all events
description: The KQL query used to define all events.
oneOf:
- description: the KQL query to filter the documents with.

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@api@slos.yaml
View file

@ -1,5 +1,5 @@
post:
summary: Creates an SLO.
summary: Create an SLO
operationId: createSloOp
description: >
You must have `all` privileges for the **SLOs** feature in the

6
x-pack/plugins/observability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@api@slos@{sloid}.yaml
View file

@ -1,5 +1,5 @@
get:
summary: Get a SLO
summary: Get an SLO
operationId: getSloOp
description: >
You must have the `read` privileges for the **SLOs** feature in the
@ -49,7 +49,7 @@ get:
$ref: '../components/schemas/404_response.yaml'
put:
summary: Updates an SLO
summary: Update an SLO
operationId: updateSloOp
description: >
You must have the `write` privileges for the **SLOs** feature in the
@ -99,7 +99,7 @@ put:
$ref: '../components/schemas/404_response.yaml'
delete:
summary: Deletes an SLO
summary: Delete an SLO
operationId: deleteSloOp
description: >
You must have the `write` privileges for the **SLOs** feature in the

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@api@slos@{sloid}@_reset.yaml
View file

@ -1,5 +1,5 @@
post:
summary: Resets an SLO.
summary: Reset an SLO
operationId: resetSloOp
description: >
You must have the `write` privileges for the **SLOs** feature in the

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@api@slos@{sloid}@disable.yaml
View file

@ -1,5 +1,5 @@
post:
summary: Disables an SLO
summary: Disable an SLO
operationId: disableSloOp
description: >
You must have the `write` privileges for the **SLOs** feature in the

2
x-pack/plugins/observability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@api@slos@{sloid}@enable.yaml
View file

@ -1,5 +1,5 @@
post:
summary: Enables an SLO
summary: Enable an SLO
operationId: enableSloOp
description: >
You must have the `write` privileges for the **SLOs** feature in the