[OAS] Migrate machine learning APIs to v3.1.0

elastic · Nov 21, 2023 · 41d3db0 · 41d3db0
1 parent dda4498
commit 41d3db0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/x-pack/plugins/ml/common/openapi/ml_apis.yaml b/x-pack/plugins/ml/common/openapi/ml_apis.yaml
@@ -1,4 +1,4 @@
-openapi: 3.0.1
+openapi: 3.1.0
 info:
   title: Machine learning APIs
   description: Kibana APIs for the machine learning feature
@@ -82,7 +82,8 @@ components:
     required: false
     schema:
       type: boolean
-    example: 'true'
+      examples:
+        - true
  securitySchemes:
   basicAuth:
     type: http
@@ -187,12 +188,14 @@ components:
       properties:
         error:
           type: string
-          example: Unauthorized
+          examples:
+            - Unauthorized
         message:
           type: string 
         statusCode:
           type: integer
-          example: 401
+          examples:
+            - 401
  examples:
    mlSyncExample:
      summary: Two anomaly detection jobs required synchronization in this example.

diff --git a/x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml b/x-pack/plugins/ml/common/openapi/ml_apis_serverless.yaml
@@ -1,4 +1,4 @@
-openapi: 3.0.1
+openapi: 3.1.0
 info:
   title: Machine learning APIs
   description: Kibana APIs for the machine learning feature
@@ -46,7 +46,8 @@ components:
     required: false
     schema:
       type: boolean
-    example: 'true'
+      examples:
+        - true
  securitySchemes:
   apiKeyAuth:
     type: apiKey
@@ -148,12 +149,14 @@ components:
       properties:
         error:
           type: string
-          example: Unauthorized
+          examples:
+            - Unauthorized
         message:
           type: string 
         statusCode:
           type: integer
-          example: 401
+          examples:
+            - 401
  examples:
    mlSyncExample:
      summary: Two anomaly detection jobs required synchronization in this example.