Fix typo in OAS

elastic · Nov 6, 2024 · 7c399ad · 7c399ad
1 parent 8fe0d3a
commit 7c399ad
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 31 deletions.
diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -3,7 +3,7 @@ info:
   contact:
     name: Kibana Team
   description: >
-    **Technical preview**  
+    **Technical preview**
 
     This functionality is in technical preview and may be changed or removed in
     a future release.
@@ -183,7 +183,7 @@ paths:
                     description: >-
                       Indicates whether the connector is preconfigured. If true,
                       the `config` and `is_missing_secrets` properties are
-                      omitted from the response. 
+                      omitted from the response.
                     type: boolean
                   is_system_action:
                     description: >-
@@ -279,7 +279,7 @@ paths:
                     description: >-
                       Indicates whether the connector is preconfigured. If true,
                       the `config` and `is_missing_secrets` properties are
-                      omitted from the response. 
+                      omitted from the response.
                     type: boolean
                   is_system_action:
                     description: >-
@@ -371,7 +371,7 @@ paths:
                     description: >-
                       Indicates whether the connector is preconfigured. If true,
                       the `config` and `is_missing_secrets` properties are
-                      omitted from the response. 
+                      omitted from the response.
                     type: boolean
                   is_system_action:
                     description: >-
@@ -459,7 +459,7 @@ paths:
                     description: >-
                       Indicates whether the connector is preconfigured. If true,
                       the `config` and `is_missing_secrets` properties are
-                      omitted from the response. 
+                      omitted from the response.
                     type: boolean
                   is_system_action:
                     description: >-
@@ -34725,7 +34725,7 @@ paths:
                               members have read access to. A document within the
                               specified data streams and indices must match this
                               query in order for it to be accessible by the role
-                              members. 
+                              members.
                             type: string
                         required:
                           - clusters
@@ -35004,7 +35004,7 @@ paths:
                                     document within the specified data streams
                                     and indices must match this query in order
                                     for it to be accessible by the role
-                                    members. 
+                                    members.
                                   type: string
                               required:
                                 - clusters
@@ -50524,7 +50524,7 @@ tags:
     name: ml
   - name: roles
   - description: >
-      Export sets of saved objects that you want to import into {kib}, resolve
+      Export sets of saved objects that you want to import into Kibana, resolve
       import errors, and rotate an encryption key for encrypted saved objects
       with the saved objects APIs.
 

diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -180,7 +180,7 @@ paths:
                     description: >-
                       Indicates whether the connector is preconfigured. If true,
                       the `config` and `is_missing_secrets` properties are
-                      omitted from the response. 
+                      omitted from the response.
                     type: boolean
                   is_system_action:
                     description: >-
@@ -276,7 +276,7 @@ paths:
                     description: >-
                       Indicates whether the connector is preconfigured. If true,
                       the `config` and `is_missing_secrets` properties are
-                      omitted from the response. 
+                      omitted from the response.
                     type: boolean
                   is_system_action:
                     description: >-
@@ -368,7 +368,7 @@ paths:
                     description: >-
                       Indicates whether the connector is preconfigured. If true,
                       the `config` and `is_missing_secrets` properties are
-                      omitted from the response. 
+                      omitted from the response.
                     type: boolean
                   is_system_action:
                     description: >-
@@ -456,7 +456,7 @@ paths:
                     description: >-
                       Indicates whether the connector is preconfigured. If true,
                       the `config` and `is_missing_secrets` properties are
-                      omitted from the response. 
+                      omitted from the response.
                     type: boolean
                   is_system_action:
                     description: >-
@@ -6869,7 +6869,7 @@ paths:
         - cases
     patch:
       description: >
-        You must have `all` privileges for the **Cases** feature in the 
+        You must have `all` privileges for the **Cases** feature in the
         **Management**, **Observability**, or **Security** section of the
         Kibana  feature privileges, depending on the owner of the case you're
         updating.
@@ -37229,7 +37229,7 @@ paths:
           description: >
             Indicates a successful call. NOTE: This HTTP response code indicates
             that the bulk operation succeeded.  Errors pertaining to individual
-            objects will be returned in the response body. 
+            objects will be returned in the response body.
         '400':
           content:
             application/json; Elastic-Api-Version=2023-10-31:
@@ -37263,7 +37263,7 @@ paths:
           description: >
             Indicates a successful call. NOTE: This HTTP response code indicates
             that the bulk operation succeeded. Errors pertaining to individual
-            objects will be returned in the response body. 
+            objects will be returned in the response body.
         '400':
           content:
             application/json; Elastic-Api-Version=2023-10-31:
@@ -38819,7 +38819,7 @@ paths:
                               members have read access to. A document within the
                               specified data streams and indices must match this
                               query in order for it to be accessible by the role
-                              members. 
+                              members.
                             type: string
                         required:
                           - clusters
@@ -39098,7 +39098,7 @@ paths:
                                     document within the specified data streams
                                     and indices must match this query in order
                                     for it to be accessible by the role
-                                    members. 
+                                    members.
                                   type: string
                               required:
                                 - clusters
@@ -44328,7 +44328,7 @@ components:
           description: >
             The scaling factor to use when encoding values. This property is
             applicable when `type` is `scaled_float`. Values will be multiplied
-            by this factor at index time and rounded to the closest long value. 
+            by this factor at index time and rounded to the closest long value.
           type: integer
         type:
           description: Specifies the data type for the field.
@@ -58900,7 +58900,7 @@ tags:
     name: ml
   - name: roles
   - description: >
-      Export sets of saved objects that you want to import into {kib}, resolve
+      Export sets of saved objects that you want to import into Kibana, resolve
       import errors, and rotate an encryption key for encrypted saved objects
       with the saved objects APIs.
 

diff --git a/packages/core/saved-objects/docs/openapi/bundled.json b/packages/core/saved-objects/docs/openapi/bundled.json
@@ -21,7 +21,7 @@
     {
       "name": "saved objects",
       "x-displayName": "Saved objects",
-      "description": "Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.\n\nTo manage a specific type of saved object, use the corresponding APIs.\nFor example, use:\n\n* [Data views](../group/endpoint-data-views)\n* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)\n* [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)\n\nWarning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.\n"
+      "description": "Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.\n\nTo manage a specific type of saved object, use the corresponding APIs.\nFor example, use:\n\n* [Data views](../group/endpoint-data-views)\n* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)\n* [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)\n\nWarning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.\n"
     }
   ],
   "paths": {
@@ -1423,4 +1423,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/core/saved-objects/docs/openapi/bundled.yaml b/packages/core/saved-objects/docs/openapi/bundled.yaml
@@ -14,7 +14,7 @@ tags:
   - name: saved objects
     x-displayName: Saved objects
     description: |
-      Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
+      Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
 
       To manage a specific type of saved object, use the corresponding APIs.
       For example, use:
@@ -216,7 +216,7 @@ paths:
       responses:
         '200':
           description: |
-            Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded.  Errors pertaining to individual objects will be returned in the response body. 
+            Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded.  Errors pertaining to individual objects will be returned in the response body.
           content:
             application/json:
               schema:
@@ -248,7 +248,7 @@ paths:
       responses:
         '200':
           description: |
-            Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body. 
+            Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
           content:
             application/json:
               schema:

diff --git a/packages/core/saved-objects/docs/openapi/bundled_serverless.json b/packages/core/saved-objects/docs/openapi/bundled_serverless.json
@@ -26,7 +26,7 @@
     {
       "name": "saved objects",
       "x-displayName": "Saved objects",
-      "description": "Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.\n\nTo manage a specific type of saved object, use the corresponding APIs.\nFor example, use:\n\n[Data views](../group/endpoint-data-views)\n\nWarning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.\n"
+      "description": "Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.\n\nTo manage a specific type of saved object, use the corresponding APIs.\nFor example, use:\n\n[Data views](../group/endpoint-data-views)\n\nWarning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.\n"
     }
   ],
   "paths": {
@@ -358,4 +358,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml b/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml
@@ -17,7 +17,7 @@ tags:
   - name: saved objects
     x-displayName: Saved objects
     description: |
-      Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
+      Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
 
       To manage a specific type of saved object, use the corresponding APIs.
       For example, use:

diff --git a/packages/core/saved-objects/docs/openapi/entrypoint.yaml b/packages/core/saved-objects/docs/openapi/entrypoint.yaml
@@ -12,8 +12,8 @@ tags:
   - name: saved objects
     x-displayName: Saved objects
     description: |
-      Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
-      
+      Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
+
       To manage a specific type of saved object, use the corresponding APIs.
       For example, use:
 

diff --git a/packages/core/saved-objects/docs/openapi/entrypoint_serverless.yaml b/packages/core/saved-objects/docs/openapi/entrypoint_serverless.yaml
@@ -12,8 +12,8 @@ tags:
   - name: saved objects
     x-displayName: Saved objects
     description: |
-      Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
-      
+      Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
+
       To manage a specific type of saved object, use the corresponding APIs.
       For example, use: