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

Update documentation

Browse source
This commit is contained in:
Kevin Delemme 2023-07-27 16:05:03 -04:00
parent f78c523d57
commit c0f6e53af2
3 changed files with 31 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

35
x-pack/plugins/observability/docs/openapi/slo/bundled.json
View file

@ -136,27 +136,13 @@
"$ref": "#/components/parameters/space_id"
},
{
"name": "name",
"name": "kqlQuery",
"in": "query",
"description": "Filter by name",
"description": "A valid kql query to filter the SLO with",
"schema": {
"type": "string"
},
"example": "awesome-service"
},
{
"name": "indicatorTypes",
"in": "query",
"description": "Filter by indicator type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"sli.kql.custom"
]
"example": "slo.name:latency* and slo.tags : \"prod\""
},
{
"name": "page",
@ -176,7 +162,7 @@
"type": "integer",
"default": 25
},
"example": 20
"example": 25
},
{
"name": "sortBy",
@ -185,12 +171,14 @@
"schema": {
"type": "string",
"enum": [
"creationTime",
"indicatorType"
"sli_value",
"status",
"error_budget_consumed",
"error_budget_remaining"
],
"default": "creationTime"
"default": "status"
},
"example": "creationTime"
"example": "status"
},
{
"name": "sortDirection",
@ -1333,7 +1321,8 @@
"sli.apm.transactionErrorRate": "#/components/schemas/indicator_properties_apm_availability",
"sli.kql.custom": "#/components/schemas/indicator_properties_custom_kql",
"sli.apm.transactionDuration": "#/components/schemas/indicator_properties_apm_latency",
"sli.apm.sli.metric.custom": "#/components/schemas/indicator_properties_custom_metric"
"sli.metric.custom": "#/components/schemas/indicator_properties_custom_metric",
"sli.histogram.custom": "#/components/schemas/indicator_properties_histogram"
}
},
"oneOf": [

30
x-pack/plugins/observability/docs/openapi/slo/bundled.yaml
View file

@ -80,21 +80,12 @@ paths:
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- $ref: '#/components/parameters/space_id'
- name: name
- name: kqlQuery
in: query
description: Filter by name
description: A valid kql query to filter the SLO with
schema:
type: string
example: awesome-service
- name: indicatorTypes
in: query
description: Filter by indicator type
schema:
type: array
items:
type: string
example:
- sli.kql.custom
example: 'slo.name:latency* and slo.tags : "prod"'
- name: page
in: query
description: The page number to return
@ -108,17 +99,19 @@ paths:
schema:
type: integer
default: 25
example: 20
example: 25
- name: sortBy
in: query
description: Sort by field
schema:
type: string
enum:
- creationTime
- indicatorType
default: creationTime
example: creationTime
- sli_value
- status
- error_budget_consumed
- error_budget_remaining
default: status
example: status
- name: sortDirection
in: query
description: Sort order
@ -920,7 +913,8 @@ components:
sli.apm.transactionErrorRate: '#/components/schemas/indicator_properties_apm_availability'
sli.kql.custom: '#/components/schemas/indicator_properties_custom_kql'
sli.apm.transactionDuration: '#/components/schemas/indicator_properties_apm_latency'
sli.apm.sli.metric.custom: '#/components/schemas/indicator_properties_custom_metric'
sli.metric.custom: '#/components/schemas/indicator_properties_custom_metric'
sli.histogram.custom: '#/components/schemas/indicator_properties_histogram'
oneOf:
- $ref: '#/components/schemas/indicator_properties_custom_kql'
- $ref: '#/components/schemas/indicator_properties_apm_availability'

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

@ -60,20 +60,12 @@ get:
parameters:
- $ref: ../components/headers/kbn_xsrf.yaml
- $ref: ../components/parameters/space_id.yaml
- name: name
- name: kqlQuery
in: query
description: Filter by name
description: A valid kql query to filter the SLO with
schema:
type: string
example: awesome-service
- name: indicatorTypes
in: query
description: Filter by indicator type
schema:
type: array
items:
type: string
example: ['sli.kql.custom']
example: 'slo.name:latency* and slo.tags : "prod"'
- name: page
in: query
description: The page number to return
@ -87,15 +79,15 @@ get:
schema:
type: integer
default: 25
example: 20
example: 25
- name: sortBy
in: query
description: Sort by field
schema:
type: string
enum: [creationTime, indicatorType]
default: creationTime
example: creationTime
enum: [sli_value, status, error_budget_consumed, error_budget_remaining]
default: status
example: status
- name: sortDirection
in: query
description: Sort order