Add get-settings spec for /settings endpoint

elastic · Jul 22, 2021 · da25a60 · da25a60
1 parent 7d98448
commit da25a60
Show file tree

Hide file tree

Showing 5 changed files with 120 additions and 0 deletions.
diff --git a/x-pack/plugins/fleet/common/openapi/bundled.json b/x-pack/plugins/fleet/common/openapi/bundled.json
@@ -59,6 +59,25 @@
         ]
       }
     },
+    "/settings": {
+      "get": {
+        "summary": "Settings",
+        "tags": [],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/fleet_settings_response"
+                }
+              }
+            }
+          }
+        },
+        "operationId": "get-settings"
+      }
+    },
     "/epm/categories": {
       "get": {
         "summary": "Package categories",
@@ -1775,6 +1794,39 @@
           "nonFatalErrors"
         ]
       },
+      "fleet_settings_response": {
+        "title": "Fleet Setup response",
+        "type": "object",
+        "properties": {
+          "response": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "has_seen_add_data_notice": {
+                "type": "boolean"
+              },
+              "has_seen_fleet_migration_notice": {
+                "type": "boolean"
+              },
+              "fleet_server_hosts": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "required": [
+              "fleet_server_hosts",
+              "id"
+            ]
+          }
+        },
+        "required": [
+          "response"
+        ]
+      },
       "search_result": {
         "title": "Search result",
         "type": "object",

diff --git a/x-pack/plugins/fleet/common/openapi/bundled.yaml b/x-pack/plugins/fleet/common/openapi/bundled.yaml
@@ -36,6 +36,18 @@ paths:
       operationId: setup
       parameters:
         - $ref: '#/components/parameters/kbn_xsrf'
+  /settings:
+    get:
+      summary: Settings
+      tags: []
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/fleet_settings_response'
+      operationId: get-settings
   /epm/categories:
     get:
       summary: Package categories
@@ -1086,6 +1098,28 @@ components:
       required:
         - isInitialized
         - nonFatalErrors
+    fleet_settings_response:
+      title: Fleet Setup response
+      type: object
+      properties:
+        response:
+          type: object
+          properties:
+            id:
+              type: string
+            has_seen_add_data_notice:
+              type: boolean
+            has_seen_fleet_migration_notice:
+              type: boolean
+            fleet_server_hosts:
+              type: array
+              items:
+                type: string
+          required:
+            - fleet_server_hosts
+            - id
+      required:
+        - response
     search_result:
       title: Search result
       type: object

diff --git a/x-pack/plugins/fleet/common/openapi/components/schemas/fleet_settings_response.yaml b/x-pack/plugins/fleet/common/openapi/components/schemas/fleet_settings_response.yaml
@@ -0,0 +1,21 @@
+title: Fleet Setup response
+type: object
+properties:
+  response:
+    type: object
+    properties:
+      id:
+        type: string
+      has_seen_add_data_notice:
+        type: boolean
+      has_seen_fleet_migration_notice:
+        type: boolean
+      fleet_server_hosts:
+        type: array
+        items:
+          type: string
+    required:
+      - fleet_server_hosts
+      - id
+required:
+  - response
diff --git a/x-pack/plugins/fleet/common/openapi/entrypoint.yaml b/x-pack/plugins/fleet/common/openapi/entrypoint.yaml
@@ -16,6 +16,8 @@ paths:
   # plugin-wide endpoint(s)
   /setup:
     $ref: paths/setup.yaml
+  /settings:
+    $ref: paths/settings.yaml
   # EPM / integrations endpoints
   /epm/categories:
     $ref: paths/[email protected]

diff --git a/x-pack/plugins/fleet/common/openapi/paths/settings.yaml b/x-pack/plugins/fleet/common/openapi/paths/settings.yaml
@@ -0,0 +1,11 @@
+get:
+  summary: Settings
+  tags: []
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/fleet_settings_response.yaml
+  operationId: get-settings