Skip to content

Commit f8fef78

Browse files
[9.1] Add overlay for Fleet remote synced integrations API (elastic#233493) (elastic#233712)
This PR is a manual backport of elastic#233493 and includes: - A commit with the changes from [the backported PR](elastic#233493) - A commit by the CI which updates the `oas_docs/output/kibana.yaml` --- This PR adds an overlay for the Fleet remote synced integrations API, adding a description for the API and an external link to the relevant documentation. Closes elastic/docs-content#1691 --------- Co-authored-by: kibanamachine <[email protected]>
1 parent fa1d0fe commit f8fef78

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

oas_docs/output/kibana.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,13 @@ tags:
103103
- name: Fleet package policies
104104
- name: Fleet proxies
105105
- name: Fleet remote synced integrations
106+
description: |
107+
Use the Fleet remote synced integrations API to check the status of the automatic integrations synchronization on a remote cluster:
108+
* Use the `/api/fleet/remote_synced_integrations/{outputId}/remote_status` endpoint on the management cluster to query the synchronization status of the integrations installed on the remote cluster by the ID of the configured remote Elasticsearch output.
109+
* Use the `/api/fleet/remote_synced_integrations/status` endpoint on the remote cluster to query the synchronization status of the installed integrations.
110+
externalDocs:
111+
description: Automatic integrations synchronization documentation
112+
url: https://www.elastic.co/docs/reference/fleet/automatic-integrations-synchronization
106113
- name: Fleet Server hosts
107114
- name: Fleet service tokens
108115
- name: Fleet uninstall tokens

oas_docs/overlays/kibana.overlays.shared.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# overlays.yaml
22
overlay: 1.0.0
33
info:
4-
title: Overlays that are applicable to both serverless and non-serverless documentas
4+
title: Overlays that are applicable to both serverless and non-serverless documents
55
version: 0.0.1
66
actions:
77
# Add some tag descriptions and displayNames

oas_docs/overlays/kibana.overlays.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,18 @@ actions:
102102
externalDocs:
103103
description: Synthetic monitoring
104104
url: https://www.elastic.co/docs/solutions/observability/synthetics
105+
- target: '$.tags[?(@.name=="Fleet remote synced integrations")]'
106+
description: Change tag description and add external docs link
107+
update:
108+
description: >
109+
Use the Fleet remote synced integrations API to check the status of the automatic integrations synchronization on a remote cluster:
110+
111+
* Use the `/api/fleet/remote_synced_integrations/{outputId}/remote_status` endpoint on the management cluster to query the synchronization status of the integrations installed on the remote cluster by the ID of the configured remote Elasticsearch output.
112+
113+
* Use the `/api/fleet/remote_synced_integrations/status` endpoint on the remote cluster to query the synchronization status of the installed integrations.
114+
externalDocs:
115+
description: Automatic integrations synchronization documentation
116+
url: https://www.elastic.co/docs/reference/fleet/automatic-integrations-synchronization
105117
# Remove extra tags from operations
106118
- target: "$.paths[*][*].tags[1:]"
107119
description: Remove all but first tag from operations

0 commit comments

Comments
 (0)