[DOCS] Automate docs for create/update/delete case APIs (#142929)

elastic · Oct 18, 2022 · f92c76c · f92c76c
1 parent 493741a
commit f92c76c
Show file tree

Hide file tree

Showing 23 changed files with 2,485 additions and 556 deletions.
diff --git a/docs/api-generated/README.md b/docs/api-generated/README.md
@@ -14,7 +14,7 @@ or a similar tool that can generate HTML output from OAS.
 . Generate HTML output. For example:
 
   ```
-  openapi-generator-cli generate -g html -i ~/kibana/x-pack/plugins/cases/docs/openapi/entrypoint.yaml -o ~/kibana/docs/api-generated/cases -t ~/kibana/docs/api-generated/template
+  openapi-generator-cli generate -g html -i ~/kibana/x-pack/plugins/cases/docs/openapi/bundled.yaml -o ~/kibana/docs/api-generated/cases -t ~/kibana/docs/api-generated/template
 
   openapi-generator-cli generate -g html -i ~/kibana/x-pack/plugins/ml/common/openapi/ml_apis_v3.yaml -o ~/kibana/docs/api-generated/machine-learning -t ~/kibana/docs/api-generated/template
   ```

diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc
diff --git a/docs/api/cases/cases-api-create.asciidoc b/docs/api/cases/cases-api-create.asciidoc
@@ -6,6 +6,12 @@
 
 Creates a case.
 
+[NOTE]
+====
+For the most up-to-date API details, refer to the
+{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
+====
+
 === {api-request-title}
 
 `POST <kibana host>:<port>/api/cases`
@@ -45,10 +51,10 @@ specify `null` as its value.
 For {ibm-r} connectors, specify:
 
 `issueTypes`:::
-(Required, array of numbers) The type of the incident.
+(Required, array of strings) The type of the incident.
 
 `severityCode`:::
-(Required, number) The severity code of the incident.
+(Required, string) The severity code of the incident.
 
 For {jira} connectors, specify:
 

diff --git a/docs/api/cases/cases-api-delete-cases.asciidoc b/docs/api/cases/cases-api-delete-cases.asciidoc
@@ -6,6 +6,12 @@
 
 Deletes one or more cases.
 
+[NOTE]
+====
+For the most up-to-date API details, refer to the
+{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
+====
+
 === {api-request-title}
 
 `DELETE <kibana host>:<port>/api/cases?ids=["<case ID1>","<case ID2>"]`

diff --git a/docs/api/cases/cases-api-update.asciidoc b/docs/api/cases/cases-api-update.asciidoc
@@ -6,6 +6,12 @@
 
 Updates one or more cases.
 
+[NOTE]
+====
+For the most up-to-date API details, refer to the
+{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
+====
+
 === {api-request-title}
 
 `PATCH <kibana host>:<port>/api/cases`
@@ -51,10 +57,10 @@ connector, specify `null`. If you want to omit any individual field, specify
 For {ibm-r} connectors, specify:
 
 `issueTypes`:::
-(Required, array of numbers) The issue types of the issue.
+(Required, array of strings) The issue types of the issue.
 
 `severityCode`:::
-(Required, number) The severity code of the issue.
+(Required, string) The severity code of the issue.
 
 For {jira} connectors, specify: