chore(slo): Add response required fields (#163430)

elastic · Aug 10, 2023 · 8ad6744 · 8ad6744
1 parent b97059c
commit 8ad6744
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 0 deletions.
diff --git a/x-pack/plugins/observability/docs/openapi/slo/bundled.json b/x-pack/plugins/observability/docs/openapi/slo/bundled.json
@@ -1264,6 +1264,12 @@
       "error_budget": {
         "title": "Error budget",
         "type": "object",
+        "required": [
+          "initial",
+          "consumed",
+          "remaining",
+          "isEstimated"
+        ],
         "properties": {
           "initial": {
             "type": "number",
@@ -1291,6 +1297,11 @@
         "title": "Summary",
         "type": "object",
         "description": "The SLO computed data",
+        "required": [
+          "status",
+          "sliValue",
+          "errorBudget"
+        ],
         "properties": {
           "status": {
             "$ref": "#/components/schemas/summary_status"
@@ -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.",

diff --git a/x-pack/plugins/observability/docs/openapi/slo/bundled.yaml b/x-pack/plugins/observability/docs/openapi/slo/bundled.yaml
@@ -867,6 +867,11 @@ components:
     error_budget:
       title: Error budget
       type: object
+      required:
+        - initial
+        - consumed
+        - remaining
+        - isEstimated
       properties:
         initial:
           type: number
@@ -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'
@@ -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.

diff --git a/x-pack/plugins/observability/docs/openapi/slo/components/schemas/error_budget.yaml b/x-pack/plugins/observability/docs/openapi/slo/components/schemas/error_budget.yaml
@@ -1,5 +1,10 @@
 title: Error budget
 type: object
+required:
+  - initial
+  - consumed
+  - remaining
+  - isEstimated
 properties:
   initial:
     type: number

diff --git a/x-pack/plugins/observability/docs/openapi/slo/components/schemas/slo_response.yaml b/x-pack/plugins/observability/docs/openapi/slo/components/schemas/slo_response.yaml
@@ -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.

diff --git a/x-pack/plugins/observability/docs/openapi/slo/components/schemas/summary.yaml b/x-pack/plugins/observability/docs/openapi/slo/components/schemas/summary.yaml
@@ -1,6 +1,10 @@
 title: Summary
 type: object
 description: The SLO computed data
+required:
+  - status
+  - sliValue
+  - errorBudget
 properties:
   status:
     $ref: './summary_status.yaml'