Commit graph

7 commits

Author SHA1 Message Date
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
Lisa Cawley
cf43ba2f27
[DOCS] Remove saved object and data view API pages (#190654)
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
2024-08-20 17:29:06 +00:00
Lisa Cawley
06f1681cc6
[DOCS] Link to new API pages (#190569) 2024-08-15 16:42:59 -07:00
Lisa Cawley
8dc286067b
[DOCS][OAS] Add data view swap saved object references and preview APIs (#187927) 2024-07-24 17:31:06 -05:00
Matthew Kime
b371171d86
[data views] Swap references API docs (#175183)
## Summary

Docs for the swap references api -
https://github.com/elastic/kibana/pull/163225

The docs are on the terse side - I think this makes sense since this is
a tool that should be used infrequently and only by people who use saved
object references.

---------

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: Davis McPhee <davismcphee@hotmail.com>
2024-01-29 15:04:20 -06:00
Lukas Olson
e921693c50
Adds get all REST API to data views (#131683)
* Adds get all API to data views

* Move size to query params

* [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix'

* Use ids/titles instead of entire object

* Add docs

* Add integration test

* Fix docs

* Update docs

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2022-06-02 10:00:19 -07:00
Matthew Kime
eb2ddcd7c6
[data views] data view api docs - index patterns => data views (#119415)
* initial pass at changing urls and anchors

* update api.asciidoc

* upate a few more anchor tags

* upate a few more anchor tags

* update data view api docs

* Update delete.asciidoc

* Update default-get.asciidoc

* add redirects

* fix redirects

* remove duplicate redirect

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-12-01 07:32:05 -06:00