Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[8.x] Fix API docs link (backport #1415) #1419

Merged
merged 1 commit into from
Nov 4, 2024
Merged

[8.x] Fix API docs link (backport #1415) #1419

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 2 additions & 17 deletions docs/en/ingest-management/fleet/fleet-api-docs.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,8 @@
[[fleet-api-docs]]
= {kib} {fleet} APIs

You can find details for all available {fleet} API endpoints in our generated
<<fleet-apis,{fleet} API docs>>. This documentation is experimental and may be
incomplete or change later.

The main source of truth for the {fleet} API can be found in the
https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/openapi/bundled.json[self-contained spec file]
that you can use to generate docs using Swagger or a similar tool.
For more information, refer to the
https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/openapi/README.md[{fleet} OpenAPI readme].

//However we do provide a self-contained spec file that you can
//https://petstore.swagger.io/?url=https://raw.githubusercontent.com/elastic/kibana/{branch}/x-pack/plugins/fleet/common/openapi/bundled.json[view in Swagger]
//(or a similar tool) to explore our Fleet APIs.

//For more information, refer to the
//https://github.com/elastic/kibana/blob/{branch}/x-pack/plugins/fleet/common/openapi/README.md[{fleet} OpenAPI file]
//in the {kib} repository.
You can find details for all available {fleet} API endpoints in our generated
{api-kibana}[Kibana API docs].

In this section, we provide examples of some commonly used {fleet} APIs.

Expand Down