github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 19:13:14 -04:00
Code Issues Projects Releases Packages Wiki Activity
83135 commits 499 branches 518 tags 21 GiB
Commit graph

3 commits

Author SHA1 Message Date
natasha-moore-elastic
f0f1775632
[DOCS ]Direct users to new API reference site (#195909) 
## Summary

Contributes to
https://github.com/elastic/security-docs-internal/issues/48.

Add callouts to the asciidoc Osquery API docs to direct users to the new
API reference site, in preparation for retiring the asciidoc API docs.

NOTE: The api-kibana variable is defined in version-specific files. In
[8.15.asciidoc](873ec2c47f/shared/versions/stack/8.15.asciidoc (L74))
and
[8.x.asciidoc](873ec2c47f/shared/versions/stack/8.x.asciidoc (L75)),
the variable points to the [v8
branch](https://www.elastic.co/docs/api/doc/kibana/v8) of the API
reference, which currently doesn't include Security API docs. The v8
branch is derived from the "current" Kibana branch, which is currently
8.15. This likely means that we can only backport the callouts to 8.16
once 8.16 becomes the "current" docs version.

Preview: [Osquery manager
API](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html)
and all its child pages
 2024-10-15 16:29:05 +01:00
Christiane (Tina) Heiligers
dd221a7be1
[Docs] Add details to SO APIs landing page (#191693) 
Fix https://github.com/elastic/kibana/issues/191534
The deprecation warning in the Kibana Saved Objects API main page was
removed in https://github.com/elastic/kibana/pull/190654.

This PR adds a section about when the APIs will be removed and what to
use instead.

The PR also includes updates to other API main pages that mention the SO
APIs.

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

VIew the [html
diff](https://kibana_bk_191693.docs-preview.app.elstc.co/diff) for these
changes:

![Short URLs API landing
page](https://github.com/user-attachments/assets/3716f33e-0d00-4ff7-b29d-7a5ba0a0f1f2)

![Data views API landing
page](https://github.com/user-attachments/assets/81c8a843-27ca-4510-a181-7ec9b20f86d6)

The updated OpenAPI document looks like this in a Bump.sh preview:


![image](https://github.com/user-attachments/assets/a8b58142-5082-4b75-8b3f-339b8a6b57e4)

---------

Co-authored-by: lcawl <lcawley@elastic.co>
 2024-08-29 15:04:00 -05:00
Patryk Kopyciński
33689abc77
[Osquery] Add docs for Osquery API (#137162) 2022-08-09 18:43:31 +02:00