From 502fb009cfbcb5aa2718b4daade2c8a5dbfc5002 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Tue, 31 Jan 2023 12:01:00 -0800 Subject: [PATCH] [DOCS] Lint case API specifications (#149641) --- docs/api-generated/README.md | 2 +- .../cases/case-apis-passthru.asciidoc | 27 +++++++++---------- .../plugins/cases/docs/openapi/bundled.json | 9 ++++--- .../plugins/cases/docs/openapi/bundled.yaml | 9 ++++--- .../openapi/components/headers/kbn_xsrf.yaml | 1 + ...api@cases@{caseid}@user_actions@_find.yaml | 8 +++--- 6 files changed, 29 insertions(+), 27 deletions(-) diff --git a/docs/api-generated/README.md b/docs/api-generated/README.md index 97a94e512e5c..97fd32119b8b 100644 --- a/docs/api-generated/README.md +++ b/docs/api-generated/README.md @@ -25,7 +25,7 @@ or a similar tool that can generate HTML output from OAS. . Rename the output files. For example: ``` - mv $GIT_HOME/kibana/docs/api-generated/rules/index.html $GIT_HOME/kibana/docs/api-generated/rules/rule-apis-passthru.asciidoc + mv $GIT_HOME/kibana/docs/api-generated/rules/index.html $GIT_HOME/kibana/docs/api-generated/rules/rule-apis-passthru.asciidoc mv $GIT_HOME/kibana/docs/api-generated/cases/index.html $GIT_HOME/kibana/docs/api-generated/cases/case-apis-passthru.asciidoc mv $GIT_HOME/kibana/docs/api-generated/connectors/index.html $GIT_HOME/kibana/docs/api-generated/connectors/connector-apis-passthru.asciidoc mv $GIT_HOME/kibana/docs/api-generated/machine-learning/index.html $GIT_HOME/kibana/docs/api-generated/machine-learning/ml-apis-passthru.asciidoc diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc index 5801fe57ec07..d6d5b0d589ac 100644 --- a/docs/api-generated/cases/case-apis-passthru.asciidoc +++ b/docs/api-generated/cases/case-apis-passthru.asciidoc @@ -78,7 +78,7 @@ Any modifications made to this file will be overwritten.
kbn-xsrf (required)
-
Header Parameter — default: null
+
Header Parameter — Cross-site request forgery protection default: null
@@ -198,7 +198,7 @@ Any modifications made to this file will be overwritten.
kbn-xsrf (required)
-
Header Parameter — default: null
+
Header Parameter — Cross-site request forgery protection default: null
@@ -306,7 +306,7 @@ Any modifications made to this file will be overwritten.
kbn-xsrf (required)
-
Header Parameter — default: null
+
Header Parameter — Cross-site request forgery protection default: null
@@ -362,7 +362,7 @@ Any modifications made to this file will be overwritten.
kbn-xsrf (required)
-
Header Parameter — default: null
+
Header Parameter — Cross-site request forgery protection default: null
@@ -410,7 +410,7 @@ Any modifications made to this file will be overwritten.
kbn-xsrf (required)
-
Header Parameter — default: null
+
Header Parameter — Cross-site request forgery protection default: null
@@ -482,7 +482,6 @@ Any modifications made to this file will be overwritten. 
{
   "userActions" : [ {
     "owner" : "cases",
-    "case_id" : "22df07d0-03b1-11ed-920c-974bfa104448",
     "action" : "create",
     "created_at" : "2022-05-13T09:16:17.416Z",
     "id" : "22fd3e30-03b1-11ed-920c-974bfa104448",
@@ -497,7 +496,6 @@ Any modifications made to this file will be overwritten.
     "version" : "WzM1ODg4LDFd"
   }, {
     "owner" : "cases",
-    "case_id" : "22df07d0-03b1-11ed-920c-974bfa104448",
     "action" : "create",
     "created_at" : "2022-05-13T09:16:17.416Z",
     "id" : "22fd3e30-03b1-11ed-920c-974bfa104448",
@@ -1519,7 +1517,7 @@ Any modifications made to this file will be overwritten.
     

       
kbn-xsrf (required)

 
-      
Header Parameter —  default: null 

+      
Header Parameter — Cross-site request forgery protection default: null 

 
     
  
 
@@ -1639,7 +1637,7 @@ Any modifications made to this file will be overwritten.
     

       
kbn-xsrf (required)

 
-      
Header Parameter —  default: null 

+      
Header Parameter — Cross-site request forgery protection default: null 

 
     
  
 
@@ -1740,7 +1738,7 @@ Any modifications made to this file will be overwritten.
     

       
kbn-xsrf (required)

 
-      
Header Parameter —  default: null 

+      
Header Parameter — Cross-site request forgery protection default: null 

 
     
  
 
@@ -1862,7 +1860,7 @@ Any modifications made to this file will be overwritten.
     

       
kbn-xsrf (required)

 
-      
Header Parameter —  default: null 

+      
Header Parameter — Cross-site request forgery protection default: null 

 
     
  
 
@@ -1984,7 +1982,7 @@ Any modifications made to this file will be overwritten.
     

       
kbn-xsrf (required)

 
-      
Header Parameter —  default: null 

+      
Header Parameter — Cross-site request forgery protection default: null 

 
     
  
 
@@ -3001,7 +2999,6 @@ Any modifications made to this file will be overwritten.
     

     

       
action 
actions  

-
case_id 
String  

 
comment_id 
String  

 
created_at 
Date  format: date-time

 
created_by 
user_actions_response_properties_created_by  

@@ -3009,7 +3006,9 @@ Any modifications made to this file will be overwritten.
 
owner 
owners  

 
payload 
user_actions_response_properties_payload  

 
version 
String  

-
type 
action_types  

+
type 
String The type of action. 

+        
Enum:

+        
assignees
create_case
comment
connector
description
pushed
tags
title
status
settings
severity

     
  
   
   

diff --git a/x-pack/plugins/cases/docs/openapi/bundled.json b/x-pack/plugins/cases/docs/openapi/bundled.json
index 7260061d76b0..37647324ccf7 100644
--- a/x-pack/plugins/cases/docs/openapi/bundled.json
+++ b/x-pack/plugins/cases/docs/openapi/bundled.json
@@ -2111,9 +2111,9 @@
             "description": "The page number to return.",
             "schema": {
               "type": "string",
-              "default": 1
+              "default": "1"
             },
-            "example": 1
+            "example": "1"
           },
           {
             "name": "perPage",
@@ -2121,9 +2121,9 @@
             "description": "The number of user actions to return per page.",
             "schema": {
               "type": "string",
-              "default": 20
+              "default": "20"
             },
-            "example": 20
+            "example": "20"
           },
           {
             "name": "sortOrder",
@@ -2245,6 +2245,7 @@
         },
         "in": "header",
         "name": "kbn-xsrf",
+        "description": "Cross-site request forgery protection",
         "required": true
       },
       "space_id": {
diff --git a/x-pack/plugins/cases/docs/openapi/bundled.yaml b/x-pack/plugins/cases/docs/openapi/bundled.yaml
index aa55e180191c..8098a2d8787f 100644
--- a/x-pack/plugins/cases/docs/openapi/bundled.yaml
+++ b/x-pack/plugins/cases/docs/openapi/bundled.yaml
@@ -1309,15 +1309,15 @@ paths:
           description: The page number to return.
           schema:
             type: string
-            default: 1
-          example: 1
+            default: '1'
+          example: '1'
         - name: perPage
           in: query
           description: The number of user actions to return per page.
           schema:
             type: string
-            default: 20
-          example: 20
+            default: '20'
+          example: '20'
         - name: sortOrder
           in: query
           description: Determines the sort order.
@@ -1398,6 +1398,7 @@ components:
         type: string
       in: header
       name: kbn-xsrf
+      description: Cross-site request forgery protection
       required: true
     space_id:
       in: path
diff --git a/x-pack/plugins/cases/docs/openapi/components/headers/kbn_xsrf.yaml b/x-pack/plugins/cases/docs/openapi/components/headers/kbn_xsrf.yaml
index 3d8dfae634e6..fe0402a43aa0 100644
--- a/x-pack/plugins/cases/docs/openapi/components/headers/kbn_xsrf.yaml
+++ b/x-pack/plugins/cases/docs/openapi/components/headers/kbn_xsrf.yaml
@@ -2,4 +2,5 @@ schema:
   type: string
 in: header
 name: kbn-xsrf
+description: Cross-site request forgery protection
 required: true
diff --git a/x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@user_actions@_find.yaml b/x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@user_actions@_find.yaml
index 8ec83b50416e..8cdeca5b9a7a 100644
--- a/x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@user_actions@_find.yaml
+++ b/x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@user_actions@_find.yaml
@@ -15,15 +15,15 @@ get:
       description: The page number to return.
       schema:
         type: string
-        default: 1
-      example: 1
+        default: "1"
+      example: "1"
     - name: perPage
       in: query
       description: The number of user actions to return per page.
       schema:
         type: string
-        default: 20
-      example: 20
+        default: "20"
+      example: "20"
     - name: sortOrder
       in: query
       description: Determines the sort order.