Skip to content

[Internal]: Add context and improve tag for Fleet remote synced integration APIs #1691

Open
@lcawl

Description

@lcawl

Description

Relates to elastic/kibana#192363

A new set of APIs appeared in the Kibana API docs:

That grouping name (tag) was derived from https://github.com/elastic/kibana/blob/f2129b04dd63de83746982e1a08816a5ccd06f5e/x-pack/platform/plugins/shared/fleet/server/routes/remote_synced_integrations/index.ts#L37

However we can (and often do) clean up the text and description and links for tags via overlays in https://github.com/elastic/kibana/blob/main/oas_docs/overlays/kibana.overlays.shared.yaml

IMO we should consider setting the tag's x-displayname to something the begins with "Fleet" and add an externalDocs link to our narrative docs for more context (e.g. https://www.elastic.co/docs/reference/fleet/remote-elasticsearch-output#automatic-integrations-synchronization ?)

Resources

This feature seems to have been implemented in elastic/kibana#216178

Which documentation set does this change impact?

Elastic On-Prem and Cloud (all)

Feature differences

N/A

What release is this request related to?

9.1

Serverless release

Not sure which release they were first published in, but I noticed them while doing the Jun 9 2025 API docs refresh.

Collaboration model

The documentation team

Point of contact.

Main contact: @criamico ?

Stakeholders:
If any assistance is required to update the overlay file: @lcawl

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:IngestIssues owned by the Ingest Docs Team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions