Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,684 changes: 842 additions & 842 deletions oas_docs/output/kibana.yaml

Large diffs are not rendered by default.

31 changes: 15 additions & 16 deletions oas_docs/overlays/alerting.overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ actions:
# Add some alerting API examples
- target: "$.paths['/api/alerting/rule/{id}']['post']"
description: "Add examples to create rule API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
examples:
createEsQueryEsqlRuleRequest:
$ref: "../examples/create_es_query_esql_rule_request.yaml"
Expand All @@ -25,7 +25,7 @@ actions:
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
application/json:
examples:
createEsQueryEsqlRuleResponse:
$ref: "../examples/create_es_query_esql_rule_response.yaml"
Expand All @@ -39,17 +39,17 @@ actions:
$ref: "../examples/create_tracking_containment_rule_response.yaml"
- target: "$.paths['/api/alerting/rule/{id}']['put']"
description: "Add examples to update rule API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
examples:
updateRuleRequest:
$ref: '../examples/update_rule_request.yaml'
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
application/json:
examples:
updateRuleResponse:
$ref: '../examples/update_rule_response.yaml'
Expand All @@ -59,7 +59,7 @@ actions:
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
application/json:
examples:
findRulesResponse:
$ref: '../examples/find_rules_response.yaml'
Expand All @@ -77,10 +77,10 @@ actions:
# Add some alerting rule parameters
- target: "$.paths['/api/alerting/rule/{id}']['post']"
description: "Add params to create rule API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
schema:
properties:
params:
Expand Down Expand Up @@ -147,4 +147,3 @@ actions:
# Threshold rule (siem.thresholdRule)
# TLS certificate rule (xpack.uptime.alerts.tlsCertificate)
# Transform health (transform_health)

60 changes: 30 additions & 30 deletions oas_docs/overlays/connectors.overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ actions:
# Add some connector API examples
- target: "$.paths['/api/actions/connector/{id}']['post']"
description: "Add examples to create connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
examples:
createEmailConnectorRequest:
$ref: "../examples/create_email_connector_request.yaml"
Expand All @@ -28,7 +28,7 @@ actions:
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
application/json:
examples:
createEmailConnectorResponse:
$ref: "../examples/create_email_connector_response.yaml"
Expand All @@ -40,10 +40,10 @@ actions:
$ref: "../examples/get_connector_response.yaml"
- target: "$.paths['/api/actions/connector/{id}/_execute']['post']"
description: "Add examples to run connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
examples:
runIndexConnectorRequest:
$ref: "../examples/run_index_connector_request.yaml"
Expand All @@ -58,7 +58,7 @@ actions:
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
application/json:
examples:
runIndexConnectorResponse:
$ref: "../examples/run_index_connector_response.yaml"
Expand All @@ -78,7 +78,7 @@ actions:
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
application/json:
examples:
getConnectorResponse:
$ref: '../examples/get_connector_response.yaml'
Expand All @@ -89,7 +89,7 @@ actions:
200:
description: Indicates a successful call.
content:
application/json; Elastic-Api-Version=2023-10-31:
application/json:
examples:
getConnectorTypesServerlessResponse:
$ref: '../examples/get_connector_types_generativeai_response.yaml'
Expand All @@ -100,16 +100,16 @@ actions:
200:
description: Indicates a successful call.
content:
application/json; Elastic-Api-Version=2023-10-31:
application/json:
examples:
getConnectorsResponse:
$ref: '../examples/get_connectors_response.yaml'
- target: "$.paths['/api/actions/connector/{id}']['put']"
description: "Add examples to update connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
examples:
updateIndexConnectorRequest:
$ref: '../examples/update_index_connector_request.yaml'
Expand All @@ -129,10 +129,10 @@ actions:
# Add some connector configuration schemas
- target: "$.paths['/api/actions/connector/{id}']['post']"
description: "Add config and secrets to create connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
schema:
properties:
config:
Expand Down Expand Up @@ -246,10 +246,10 @@ actions:
- $ref: '../../x-pack/platform/plugins/shared/actions/docs/openapi/components/schemas/xmatters_secrets.yaml'
- target: "$.paths['/api/actions/connector/{id}']['put']"
description: "Add config and secrets to update connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
schema:
properties:
config:
Expand Down Expand Up @@ -365,13 +365,13 @@ actions:
- target: "$.paths['/api/actions/connector/{id}/_execute']['post'].requestBody.content.*.schema.properties.params"
description: "Remove params in run connector API"
remove: true
# Add some run connector params
# Add some run connector params
- target: "$.paths['/api/actions/connector/{id}/_execute']['post']"
description: "Add examples to run connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
schema:
properties:
params:
Expand Down
32 changes: 16 additions & 16 deletions oas_docs/overlays/kibana.overlays.shared.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,39 @@ actions:
# Add some spaces API examples
- target: "$.paths['/api/spaces/space']['post']"
description: "Add example to create space API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
examples:
createSpaceRequest:
$ref: "../examples/create_space_request.yaml"
- target: "$.paths['/api/spaces/space/{id}']['put']"
description: "Add example to update space API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
update:
requestBody:
content:
application/json:
examples:
updateSpaceRequest:
$ref: "../examples/update_space_request.yaml"
- target: "$.paths['/api/spaces/space/{id}']['get']"
description: "Add example to get space API"
update:
update:
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
200:
content:
application/json:
examples:
getSpaceResponseExample:
$ref: "../examples/get_space_response.yaml"
- target: "$.paths['/api/spaces/space']['get']"
description: "Add example to get all spaces API"
update:
update:
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
200:
content:
application/json:
examples:
getSpacesResponseExample1:
$ref: "../examples/get_spaces_response1.yaml"
Expand Down
Loading