diff --git a/docs/api-generated/README.md b/docs/api-generated/README.md index fd76a53a9fae2..6eda1a4d2e9f1 100644 --- a/docs/api-generated/README.md +++ b/docs/api-generated/README.md @@ -14,15 +14,18 @@ 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/bundled.yaml -o ~/kibana/docs/api-generated/cases -t ~/kibana/docs/api-generated/template + openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/cases/docs/openapi/bundled.yaml -o $GIT_HOME/kibana/docs/api-generated/cases -t $GIT_HOME/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 + openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/actions/docs/openapi/bundled.yaml -o $GIT_HOME/kibana/docs/api-generated/connectors -t $GIT_HOME/kibana/docs/api-generated/template + + openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/ml/common/openapi/ml_apis_v3.yaml -o $GIT_HOME/kibana/docs/api-generated/machine-learning -t $GIT_HOME/kibana/docs/api-generated/template ``` . Rename the output files. For example: ``` - mv ~/kibana/docs/api-generated/cases/index.html case-apis-passthru.asciidoc - mv ~/kibana/docs/api-generated/machine-learning/index.html ml-apis-passthru.adoc + 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.adoc ``` . If you're creating a new set of API output, you will need to have a page that incorporates the output by using passthrough blocks. For more information, refer to [Asciidoctor docs](https://docs.asciidoctor.org/asciidoc/latest/pass/pass-block/) diff --git a/docs/api-generated/connectors/connector-apis-passthru.asciidoc b/docs/api-generated/connectors/connector-apis-passthru.asciidoc new file mode 100644 index 0000000000000..fd97cd89608b9 --- /dev/null +++ b/docs/api-generated/connectors/connector-apis-passthru.asciidoc @@ -0,0 +1,113 @@ +//// +This content is generated from the open API specification. +Any modifications made to this file will be overwritten. +//// + +++++ +
get /s/{spaceId}/api/actions/connector_types/s/ and the identifier are omitted from the path, the default space is used. default: null {
+ "supported_feature_ids" : [ "alerting", "uptime", "siem" ],
+ "name" : "Index",
+ "enabled_in_license" : true,
+ "id" : ".index",
+ "enabled_in_config" : true,
+ "minimum_license_required" : "basic",
+ "enabled" : true
+}
+
+ application/jsonfeatures - Upalerting, cases, uptime, and siem.getConnectorTypes_200_response_inner - Up.yml file.