Skip to content

Commit

Permalink
Add response required fields
Browse files Browse the repository at this point in the history
  • Loading branch information
kdelemme committed Aug 8, 2023
1 parent 1922d73 commit f57b64f
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 0 deletions.
28 changes: 28 additions & 0 deletions x-pack/plugins/observability/docs/openapi/slo/bundled.json
Original file line number Diff line number Diff line change
Expand Up @@ -1264,6 +1264,12 @@
"error_budget": {
"title": "Error budget",
"type": "object",
"required": [
"initial",
"consumed",
"remaining",
"isEstimated"
],
"properties": {
"initial": {
"type": "number",
Expand Down Expand Up @@ -1291,6 +1297,11 @@
"title": "Summary",
"type": "object",
"description": "The SLO computed data",
"required": [
"status",
"sliValue",
"errorBudget"
],
"properties": {
"status": {
"$ref": "#/components/schemas/summary_status"
Expand All @@ -1307,6 +1318,23 @@
"slo_response": {
"title": "SLO response",
"type": "object",
"required": [
"id",
"name",
"description",
"indicator",
"timeWindow",
"budgetingMethod",
"objective",
"settings",
"revision",
"summary",
"enabled",
"groupBy",
"instanceId",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"description": "The identifier of the SLO.",
Expand Down
25 changes: 25 additions & 0 deletions x-pack/plugins/observability/docs/openapi/slo/bundled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -867,6 +867,11 @@ components:
error_budget:
title: Error budget
type: object
required:
- initial
- consumed
- remaining
- isEstimated
properties:
initial:
type: number
Expand All @@ -888,6 +893,10 @@ components:
title: Summary
type: object
description: The SLO computed data
required:
- status
- sliValue
- errorBudget
properties:
status:
$ref: '#/components/schemas/summary_status'
Expand All @@ -899,6 +908,22 @@ components:
slo_response:
title: SLO response
type: object
required:
- id
- name
- description
- indicator
- timeWindow
- budgetingMethod
- objective
- settings
- revision
- summary
- enabled
- groupBy
- instanceId
- createdAt
- updatedAt
properties:
id:
description: The identifier of the SLO.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
title: Error budget
type: object
required:
- initial
- consumed
- remaining
- isEstimated
properties:
initial:
type: number
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
title: SLO response
type: object
required:
- id
- name
- description
- indicator
- timeWindow
- budgetingMethod
- objective
- settings
- revision
- summary
- enabled
- groupBy
- instanceId
- createdAt
- updatedAt
properties:
id:
description: The identifier of the SLO.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
title: Summary
type: object
description: The SLO computed data
required:
- status
- sliValue
- errorBudget
properties:
status:
$ref: './summary_status.yaml'
Expand Down

0 comments on commit f57b64f

Please sign in to comment.