Skip to content

Commit

Permalink
[DOCS] Group by params
Browse files Browse the repository at this point in the history
  • Loading branch information
@lcawl
lcawl committed Jan 25, 2023
1 parent e55afc0 commit 63bbeec
Show file tree
Hide file tree
Showing 7 changed files with 387 additions and 139 deletions.
40 changes: 35 additions & 5 deletions docs/api-generated/connectors/connector-apis-passthru.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,9 @@ Any modifications made to this file will be overwritten.
<li><a href="#getConnector_404_response"><code>getConnector_404_response</code> - </a></li>
<li><a href="#runConnector_200_response"><code>runConnector_200_response</code> - </a></li>
<li><a href="#runConnector_200_response_data"><code>runConnector_200_response_data</code> - </a></li>
<li><a href="#run_connector_params_documents"><code>run_connector_params_documents</code> - Run index connector parameters</a></li>
<li><a href="#run_connector_params_level_message"><code>run_connector_params_level_message</code> - Run server log connector parameters</a></li>
<li><a href="#run_connector_params_subactions"><code>run_connector_params_subactions</code> - Run connector subactions</a></li>
<li><a href="#secrets_properties_cases_webhook"><code>secrets_properties_cases_webhook</code> - Connector secrets properties for Webhook - Case Management connector</a></li>
<li><a href="#secrets_properties_jira"><code>secrets_properties_jira</code> - Connector secrets properties for a Jira connector</a></li>
<li><a href="#secrets_properties_opsgenie"><code>secrets_properties_opsgenie</code> - Connector secrets properties for an Opsgenie connector</a></li>
Expand Down Expand Up @@ -698,15 +701,15 @@ Any modifications made to this file will be overwritten.
<h3><a name="Run_connector_request_body_properties_params"><code>Run_connector_request_body_properties_params</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">documents (optional)</div><div class="param-desc"><span class="param-type"><a href="#map">array[map[String, oas_any_type_not_mapped]]</a></span> The documents to index in JSON format. This property is required only for index connectors. </div>
<div class="param">level (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The log level of the message. This property is applicable only to server log connectors. </div>
<div class="param">documents </div><div class="param-desc"><span class="param-type"><a href="#map">array[map[String, oas_any_type_not_mapped]]</a></span> The documents to index in JSON format. </div>
<div class="param">level (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The log level of the message. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">debug</div><div class="param-enum">error</div><div class="param-enum">fatal</div><div class="param-enum">info</div><div class="param-enum">trace</div><div class="param-enum">warn</div>
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The message to log. This property is required only for server log connectors. </div>
<div class="param">subAction (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The message to log. </div>
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">addEvent</div><div class="param-enum">createAlert</div><div class="param-enum">closeAlert</div><div class="param-enum">fieldsByIssueType</div><div class="param-enum">getChoices</div><div class="param-enum">getFields</div><div class="param-enum">getIncident</div><div class="param-enum">issue</div><div class="param-enum">issues</div><div class="param-enum">issueTypes</div><div class="param-enum">pushToService</div>
<div class="param">subActionParams (optional)</div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> </div>
<div class="param">subActionParams (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
Expand Down Expand Up @@ -1327,6 +1330,33 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="run_connector_params_documents"><code>run_connector_params_documents</code> - Run index connector parameters</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Test an action that indexes a document into Elasticsearch.</div>
<div class="field-items">
<div class="param">documents </div><div class="param-desc"><span class="param-type"><a href="#map">array[map[String, oas_any_type_not_mapped]]</a></span> The documents to index in JSON format. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="run_connector_params_level_message"><code>run_connector_params_level_message</code> - Run server log connector parameters</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Test an action that writes an entry to the Kibana server log.</div>
<div class="field-items">
<div class="param">level (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The log level of the message. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">debug</div><div class="param-enum">error</div><div class="param-enum">fatal</div><div class="param-enum">info</div><div class="param-enum">trace</div><div class="param-enum">warn</div>
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The message to log. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="run_connector_params_subactions"><code>run_connector_params_subactions</code> - Run connector subactions</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Test an actions that require subactions and subaction parameters.</div>
<div class="field-items">
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">addEvent</div><div class="param-enum">createAlert</div><div class="param-enum">closeAlert</div><div class="param-enum">fieldsByIssueType</div><div class="param-enum">getChoices</div><div class="param-enum">getFields</div><div class="param-enum">getIncident</div><div class="param-enum">issue</div><div class="param-enum">issues</div><div class="param-enum">issueTypes</div><div class="param-enum">pushToService</div>
<div class="param">subActionParams (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="secrets_properties_cases_webhook"><code>secrets_properties_cases_webhook</code> - Connector secrets properties for Webhook - Case Management connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
Expand Down
211 changes: 166 additions & 45 deletions x-pack/plugins/actions/docs/openapi/bundled.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -659,56 +659,36 @@
],
"properties": {
"params": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"description": "The documents to index in JSON format. This property is required only for index connectors.",
"items": {
"type": "object",
"additionalProperties": true
}
"oneOf": [
{
"$ref": "#/components/schemas/run_connector_params_documents"
},
"level": {
"type": "string",
"description": "The log level of the message. This property is applicable only to server log connectors.",
"enum": [
"debug",
"error",
"fatal",
"info",
"trace",
"warn"
]
},
"message": {
"type": "string",
"description": "The message to log. This property is required only for server log connectors."
{
"$ref": "#/components/schemas/run_connector_params_level_message"
},
"subAction": {
"type": "string",
"description": "The action to test.",
"enum": [
"addEvent",
"createAlert",
"closeAlert",
"fieldsByIssueType",
"getChoices",
"getFields",
"getIncident",
"issue",
"issues",
"issueTypes",
"pushToService"
]
},
"subActionParams": {
"type": "object",
"additionalProperties": true
{
"$ref": "#/components/schemas/run_connector_params_subactions"
}
}
]
}
}
},
"examples": {
"runIndexConnectorRequest": {
"$ref": "#/components/examples/run_index_connector_request"
},
"runJiraConnectorRequest": {
"$ref": "#/components/examples/run_jira_connector_request"
},
"runServerLogConnectorRequest": {
"$ref": "#/components/examples/run_server_log_connector_request"
},
"runServiceNowITOMConnectorRequest": {
"$ref": "#/components/examples/run_servicenow_itom_connector_request"
},
"runSwimlaneConnectorRequest": {
"$ref": "#/components/examples/run_swimlane_connector_request"
}
}
}
}
Expand Down Expand Up @@ -3078,6 +3058,81 @@
"uptime",
"siem"
]
},
"run_connector_params_documents": {
"title": "Run index connector parameters",
"description": "Test an action that indexes a document into Elasticsearch.",
"type": "object",
"required": [
"documents"
],
"properties": {
"documents": {
"type": "array",
"description": "The documents to index in JSON format.",
"items": {
"type": "object",
"additionalProperties": true
}
}
}
},
"run_connector_params_level_message": {
"title": "Run server log connector parameters",
"description": "Test an action that writes an entry to the Kibana server log.",
"type": "object",
"required": [
"message"
],
"properties": {
"level": {
"type": "string",
"description": "The log level of the message.",
"enum": [
"debug",
"error",
"fatal",
"info",
"trace",
"warn"
],
"default": "info"
},
"message": {
"type": "string",
"description": "The message to log."
}
}
},
"run_connector_params_subactions": {
"title": "Run connector subactions",
"description": "Test an actions that require subactions and subaction parameters.",
"type": "object",
"required": [
"subAction"
],
"properties": {
"subAction": {
"type": "string",
"description": "The action to test.",
"enum": [
"addEvent",
"createAlert",
"closeAlert",
"fieldsByIssueType",
"getChoices",
"getFields",
"getIncident",
"issue",
"issues",
"issueTypes",
"pushToService"
]
},
"subActionParams": {
"type": "object"
}
}
}
},
"examples": {
Expand Down Expand Up @@ -3198,6 +3253,72 @@
}
]
},
"run_index_connector_request": {
"summary": "Run an index connector.",
"value": {
"params": {
"documents": [
{
"id": "my_doc_id",
"name": "my_doc_name",
"message": "hello, world"
}
]
}
}
},
"run_jira_connector_request": {
"summary": "Run a Jira connector to retrieve the list of issue types.",
"value": {
"params": {
"subAction": "issueTypes"
}
}
},
"run_server_log_connector_request": {
"summary": "Run a server log connector.",
"value": {
"params": {
"level": "warn",
"message": "Test warning message."
}
}
},
"run_servicenow_itom_connector_request": {
"summary": "Run a ServiceNow ITOM connector to retrieve the list of choices.",
"value": {
"params": {
"subAction": "getChoices",
"subActionParams": {
"fields": [
"severity",
"urgency"
]
}
}
}
},
"run_swimlane_connector_request": {
"summary": "Run a Swimlane connector to create an incident.",
"value": {
"params": {
"subAction": "pushToService",
"subActionParams": {
"comments": [
{
"commentId": 1,
"comment": "A comment about the incident."
}
],
"incident": {
"caseId": "1000",
"caseName": "Case name",
"description": "Description of the incident."
}
}
}
}
},
"run_index_connector_response": {
"summary": "Response from running an index connector.",
"value": {
Expand Down
Loading

0 comments on commit 63bbeec

Please sign in to comment.