[OpenAPI] Fix Serverless API base URL (elastic#202373)

hop-dev · Dec 5, 2024 · e6dc202 · e6dc202
1 parent 6a5256f
commit e6dc202
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 38 deletions.
diff --git a/oas_docs/kibana.info.yaml b/oas_docs/kibana.info.yaml
@@ -42,11 +42,6 @@ info:
   x-feedbackLink:
     label: Feedback
     url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
-servers:
-  - url: https://{kibana_url}
-    variables:
-      kibana_url:
-        default: localhost:5601
 security:
   - apiKeyAuth: []
   - basicAuth: []

diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -40,7 +40,7 @@ servers:
   - url: https://{kibana_url}
     variables:
       kibana_url:
-        default: localhost:5601
+        default: <KIBANA_URL>
 security:
   - apiKeyAuth: []
 tags:
@@ -34488,8 +34488,6 @@ paths:
               schema:
                 $ref: '#/components/schemas/SLOs_409_response'
           description: Conflict - The SLO id already exists
-      servers:
-        - url: https://localhost:5601
       summary: Create an SLO
       tags:
         - slo
@@ -34529,8 +34527,6 @@ paths:
               schema:
                 $ref: '#/components/schemas/SLOs_403_response'
           description: Unauthorized response
-      servers:
-        - url: https://localhost:5601
       summary: Batch delete rollup and summary data
       tags:
         - slo

diff --git a/oas_docs/overlays/kibana.overlays.serverless.yaml b/oas_docs/overlays/kibana.overlays.serverless.yaml
@@ -14,7 +14,7 @@ actions:
       - url: https://{kibana_url}
         variables:
           kibana_url:
-            default: localhost:5601
+            default: <KIBANA_URL>
 # Mark all operations as beta
   - target: "$.paths[*]['get','put','post','delete','options','head','patch','trace']"
     description: Add x-beta

diff --git a/oas_docs/overlays/kibana.overlays.yaml b/oas_docs/overlays/kibana.overlays.yaml
@@ -4,6 +4,17 @@ info:
   title: Overlays for the Kibana API document
   version: 0.0.1
 actions:
+# Clean up server definitions
+  - target: '$.servers.*'
+    description: Remove all servers so we can add our own.
+    remove: true
+  - target: '$.servers'
+    description: Add server into the now empty server array.
+    update:
+      - url: https://{kibana_url}
+        variables:
+          kibana_url:
+            default: localhost:5601
 # Add an introduction to spaces
   - target: '$'
     description: Add an extra page about spaces

diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json
@@ -14,8 +14,12 @@
   },
   "servers": [
     {
-      "url": "http://localhost:5601",
-      "description": "local"
+      "url": "https://{kibana_url}",
+      "variables": {
+        "kibana_url": {
+          "default": "localhost:5601"
+        }
+      }
     }
   ],
   "tags": [
@@ -102,12 +106,7 @@
               }
             }
           }
-        },
-        "servers": [
-          {
-            "url": "https://localhost:5601"
-          }
-        ]
+        }
       },
       "get": {
         "summary": "Get a paginated list of SLOs",
@@ -738,12 +737,7 @@
               }
             }
           }
-        },
-        "servers": [
-          {
-            "url": "https://localhost:5601"
-          }
-        ]
+        }
       }
     }
   },

diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml
@@ -9,8 +9,10 @@ info:
     name: Elastic License 2.0
     url: https://www.elastic.co/licensing/elastic-license
 servers:
-  - url: http://localhost:5601
-    description: local
+  - url: https://{kibana_url}
+    variables:
+      kibana_url:
+        default: localhost:5601
 tags:
   - name: slo
     description: SLO APIs enable you to define, manage and track service-level objectives
@@ -63,8 +65,6 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/409_response'
-      servers:
-        - url: https://localhost:5601
     get:
       summary: Get a paginated list of SLOs
       operationId: findSlosOp
@@ -448,8 +448,6 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/403_response'
-      servers:
-        - url: https://localhost:5601
 components:
   parameters:
     kbn_xsrf:

diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/entrypoint.yaml b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/entrypoint.yaml
@@ -12,8 +12,10 @@ tags:
   - name: slo
     description: SLO APIs enable you to define, manage and track service-level objectives
 servers:
-  - url: "http://localhost:5601"
-    description: local
+  - url: https://{kibana_url}
+    variables:
+      kibana_url:
+        default: localhost:5601
 paths:
   "/s/{spaceId}/api/observability/slos":
     $ref: "paths/s@{spaceid}@[email protected]"

diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@[email protected] b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@[email protected]
@@ -46,9 +46,6 @@ post:
         application/json:
           schema:
             $ref: '../components/schemas/409_response.yaml'
-  servers:
-    - url: https://localhost:5601
-
 get:
   summary: Get a paginated list of SLOs
   operationId: findSlosOp

diff --git a/...rvability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@api@slos@_delete_instances.yaml b/...rvability_solution/slo/docs/openapi/slo/paths/s@{spaceid}@api@slos@_delete_instances.yaml
@@ -37,5 +37,3 @@ post:
         application/json:
           schema:
             $ref: '../components/schemas/403_response.yaml'
-  servers:
-    - url: https://localhost:5601