From ee1062a31c9ec5b41400d27b6786b371487c1807 Mon Sep 17 00:00:00 2001
From: Lisa Cawley <lcawley@elastic.co>
Date: Fri, 26 Jul 2024 08:04:18 -0700
Subject: [PATCH] [8.15] [OAS][DOCS] Add x-topics info about running APIs in
 spaces (#189144) (#189224)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[OAS][DOCS] Add x-topics info about running APIs in spaces
(#189144)](https://github.com/elastic/kibana/pull/189144)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-07-25T18:23:52Z","message":"[OAS][DOCS]
Add x-topics info about running APIs in spaces
(#189144)","sha":"42c5d918d3125ce7c766a6e432412a5f1f7b2d05","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","backport:prev-minor","Feature:OAS","v8.16.0"],"number":189144,"url":"https://github.com/elastic/kibana/pull/189144","mergeCommit":{"message":"[OAS][DOCS]
Add x-topics info about running APIs in spaces
(#189144)","sha":"42c5d918d3125ce7c766a6e432412a5f1f7b2d05"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/189144","number":189144,"mergeCommit":{"message":"[OAS][DOCS]
Add x-topics info about running APIs in spaces
(#189144)","sha":"42c5d918d3125ce7c766a6e432412a5f1f7b2d05"}}]}]
BACKPORT-->
---
 oas_docs/kibana.info.yaml              |  2 ++
 oas_docs/output/kibana.yaml            |  4 +++
 oas_docs/overlays/kibana.overlays.yaml | 39 ++++++++++++++++++++++++++
 3 files changed, 45 insertions(+)

diff --git a/oas_docs/kibana.info.yaml b/oas_docs/kibana.info.yaml
index 888d9aaef86c3..0b6c2b2ea0fec 100644
--- a/oas_docs/kibana.info.yaml
+++ b/oas_docs/kibana.info.yaml
@@ -22,6 +22,8 @@ info:
     ```
     GET kbn:/api/data_views
     ```
+
+    For more information about the console, refer to [Run API requests](https://www.elastic.co/guide/en/kibana/current/console-kibana.html).
   version: "1.0.2"
   license:
     name: Elastic License 2.0
diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
index d6c93eba91f28..0f1ad710897a1 100644
--- a/oas_docs/output/kibana.yaml
+++ b/oas_docs/output/kibana.yaml
@@ -41,6 +41,10 @@ info:
     GET kbn:/api/data_views
 
     ```
+
+
+    For more information about the console, refer to [Run API
+    requests](https://www.elastic.co/guide/en/kibana/current/console-kibana.html).
   version: 1.0.2
   license:
     name: Elastic License 2.0
diff --git a/oas_docs/overlays/kibana.overlays.yaml b/oas_docs/overlays/kibana.overlays.yaml
index 6607f9cf8f12d..7681a7201872a 100644
--- a/oas_docs/overlays/kibana.overlays.yaml
+++ b/oas_docs/overlays/kibana.overlays.yaml
@@ -14,3 +14,42 @@ actions:
         variables:
           kibana_url:
             default: localhost:5601
+  - target: '$.components.securitySchemes'
+    description: Add an API key security scheme
+    update:
+      apiKeyAuth:
+        in: header
+        name: Authorization
+        type: apiKey
+        description: You must create an API key and use the encoded value in the request header. To learn about creating keys, go to [API keys](https://www.elastic.co/guide/en/kibana/current/api-keys.html).
+  - target: '$.components.securitySchemes'
+    description: Add an basic security scheme
+    update:
+      basicAuth:
+        type: http
+        scheme: basic
+  - target: '$'
+    description: Add document-level security.
+    update:
+      security:
+        - apiKeyAuth: []
+        - basicAuth: []
+  - target: '$'
+    description: Add an extra page about spaces
+    update:
+      x-topics:
+        - title: Kibana spaces
+          content: |
+            Spaces enable you to organize your dashboards and other saved objects into meaningful categories.
+            You can use the default space or create your own spaces.
+
+            To run APIs in non-default spaces, you must add `s/{space_id}/` to the path.
+            For example:
+
+            ```
+            curl -X GET "http://localhost:5601/s/marketing/api/data_views"
+            ```
+
+            If you use the Kibana console to send API requests, it automatically adds the appropriate space identifier.
+
+            To learn more, check out [Spaces](https://www.elastic.co/guide/en/kibana/current/xpack-spaces.html).