Commit graph

28 commits

Author SHA1 Message Date
natasha-moore-elastic
b205d206ae
[DOCS] Deletes asciidoc Osquery API docs (#216269)
## Summary

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

Deletes asciidoc Osquery API docs from 8.16+ branches
2025-03-28 16:15:42 +00:00
Christiane (Tina) Heiligers
37d6545699
[docs] Document internal API restriction in 9.0 (#191943)
fix: https://github.com/elastic/kibana/issues/191941

Adds note that access to internal APIs will be restricted as of 9.0:


![document-restricted-internal-API-access](https://github.com/user-attachments/assets/56b5c43d-ff6f-4b5b-8c18-2cbe1a1de7c3)

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

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
2024-09-03 17:59:50 -05:00
Lisa Cawley
06f1681cc6
[DOCS] Link to new API pages (#190569) 2024-08-15 16:42:59 -07:00
shainaraskas
a36a370878
[Docs] remove Kibana book-scoped variables (#178676)
## Summary

Removes book-scoped docs variable in preparation for eventual migration
to Docsmobile
2024-03-14 11:53:33 -04:00
Shahzad
8bbb58f19a
[Synthetics] Global params Public APIs (#169669) 2023-10-27 16:16:40 +02:00
Shahzad
882e0bf81a
[Uptime] Settings public API (#163400) 2023-10-23 06:14:37 -07:00
Youhei Sakurai
b46a737703
Add support for PATCH requests in Console (#165634)
## Summary

This PR adds support for PATCH requests in Console.


![patch-request](8257ca4b-303e-4f46-bbcc-6e6f95336c30)

Closes #154274

### Checklist

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

## Release note

Adds support for PATCH requests in Console.

---------

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2023-09-09 10:33:56 +09:00
Stef Nestor
75f2d0c714
Append DevTool commands automatically prefix Space (#140443)
In DevTools, if you go to run `kbn:/s/foo/api/MY_REQUEST` then IF default space you effectively run `KIBANA/s/foo/api/MY_REQUEST` BUT IF non-default space e.g. `admin` you end up running `KIBANA/s/admin/s/foo/api/MY_REQUEST` which is invalid. 

This is not pointed out in Dev Tools and since this page updated to the emphasize the DevTools example, this is tripping up more users who think it should work via this page.

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-10-18 14:18:36 -06:00
Lisa Cawley
1be987e66a
[DOCS] Link to open API specification from ML sync API (#142136) 2022-09-29 08:29:07 -07:00
Patryk Kopyciński
33689abc77
[Osquery] Add docs for Osquery API (#137162) 2022-08-09 18:43:31 +02:00
Lisa Cawley
7c8dff7af1
[DOCS] Replace ML API page with automated output (#136583) 2022-07-22 08:55:37 -07:00
gchaps
0d5808a22b
[DOCS] Adds Kibana API support to Console (#134111)
* [DOCS] Adds Kibana API support to Console

* Update docs/dev-tools/console/console.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-06-13 09:03:44 -07:00
Lisa Cawley
4ad03d1b7d
[DOCS] Add Cases API links (#127647) 2022-03-15 07:25:00 -07:00
Lisa Cawley
ee081010d8
[DOCS] Add deprecated index pattern APIs (#124065) 2022-01-31 15:47:25 -08: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
Vadim Kibana
e9f0d7b9b4
Short url docs (#113084) 2021-10-12 19:46:58 +02:00
Lisa Cawley
04e5a15464
[DOCS] Add machine learning sync API (#112033) 2021-09-21 08:33:48 -07:00
Rudolf Meijering
5464af6923
legacy dashboards import/export API: deprecation logs and usage data (#111283)
* Move legacy dashboards API to core and adds usage data

* More legacy_export plugin removal

* Log a warning for deprecated dashboard import/export API

* Review comments
2021-09-08 16:15:52 -04:00
Yuliia Naumenko
73e8871be0
[Alerting][Docs] Support enablement documentation. (#101457)
* [Alerting][Docs] Support enablement documentation.

* additional docs

* fixed links

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed common issues

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed due to comments

* fixed TM health api page

* fixed TM health api page 2

* Apply suggestions from code review

Co-authored-by: ymao1 <ying.mao@elastic.co>
Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>
Co-authored-by: ymao1 <ying.mao@elastic.co>

* fixed due to the comments

* fixed due to the comments

* fixed experimental flag

* fixed due to the comments

* Apply suggestions from code review

Co-authored-by: ymao1 <ying.mao@elastic.co>

* Update docs/user/alerting/alerting-troubleshooting.asciidoc

Co-authored-by: ymao1 <ying.mao@elastic.co>

* fixed due to the comments

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: ymao1 <ying.mao@elastic.co>
Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>
2021-06-28 11:57:17 -07:00
Anton Dosov
c5f8aeeb43
[Docs] Index patterns REST API docs (#100549) 2021-05-26 18:33:23 +02:00
Mike Côté
3abb79a179
Create new alerting HTTP APIs that use the new terminology (#93977)
* Move current alert HTTP APIs to legacy folder (#93943)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Create new rule HTTP APIs (#93980)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Move current alert HTTP APIs to legacy folder (#93943)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Add necessary files

* Create rule route

* Get rule API

* Update rule API

* Delete rule route

* Aggregate rules API

* Disable rule API

* Enable rule API

* Find rules API

* Fix Update API

* Get rule alert summary API

* Get rule state API

* Health API

* Rule types API

* Mute all API

* Mute alert API

* Unmute all API

* Unmute alert route

* Update API key API

* corrected tpye by making it much more complicated

* removed unneeded cocde

* Fixes

* Add back health route

* mutedInstanceIds -> mutedAlertIds

* lastRun -> last_run

* alert_type_state -> rule_type_state & alert_instances -> alerts

Co-authored-by: Gidi Meir Morris <github@gidi.io>

* Create docs for new rule HTTP APIs, deprecate old docs (#94745)

* Create docs for new APIs, deprecate old docs

* Remove connector_type_id

* Update docs

* Add link to legacy APIs from rules API docs

* Remove connector_type_id references

* [DOCS] Add legacy APIs to index.asciidoc

* Fix camel case

Co-authored-by: lcawl <lcawley@elastic.co>

* Make alerting tests use new rules APIs (#95159)

* Make API integration tests use new HTTP APIs

* Fix end to end tests

* Fix test failures

* Fix more test failures

* Rename some files

* Add tests for legacy APIs (#95333)

* Initial commit (#95457)

* Move some new alerting APIs to /internal (#95461)

* Initial commit

* Update README.md

* Use internal API

* Merge deprecated warning w/ alternative solution

* Update API docs

Co-authored-by: Gidi Meir Morris <github@gidi.io>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
2021-03-30 08:27:28 -04:00
Aleh Zasypkin
3f3cc8ee35
Expose session invalidation API. (#92376) 2021-03-24 09:54:08 +01:00
Yuliia Naumenko
fb96b9c755
[Docs] Changed REST API intro page with removing experimental definition for all APIs. (#92539)
* [Docs] Changed REST API intro page with removing experimental definition for all APIs

* fixed ci

* fixed ci
2021-02-24 07:53:36 -08:00
Yuliia Naumenko
da25d2753b
[Alerts][Docs] Added API documentation for alerts plugin (#91067)
* Added API documentation for alerts plugin

* Added link to user api

* fixed links

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/create.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/delete.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/delete.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/disable.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/enable.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/disable.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/update.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/enable.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/find.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/find.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/find.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/find.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/find.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/find.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/get.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/get.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: Gidi Meir Morris <github@gidi.io>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: Gidi Meir Morris <github@gidi.io>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/list.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/health.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/list.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/list.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/api/alerts/list.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed due to comments

* fixed due to comments

* fixed due to comments

* fixed links

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed due to comments

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Gidi Meir Morris <github@gidi.io>
2021-02-18 12:36:25 -08:00
ymao1
88ac3bf541
[Actions][Docs] Actions and Connectors API Docs (#90974)
* Stubbing out asciidocs

* wip

* Finishing connector API docs

* Cleanup

* Removing experimental label

* PR fixes

* PR fixes

* PR fixes
2021-02-17 13:43:25 -05:00
Kaarina Tungseth
1e3f14395c
[DOCS] API intro (#47164)
* [DOCS] API intro

* Logstash configuration management

* Reformatting

* Comments from Josh

* Commets from Gail

* Fixed broken things
2019-10-16 15:10:40 -05:00
Kaarina Tungseth
adfebc51bb
[DOCS] Updated API experimental notes (#46008) 2019-09-18 10:54:28 -05:00
Lisa Cawley
80c05bf928
[DOCS] Adds user folder (#45411) 2019-09-11 12:59:38 -07:00
Renamed from docs/api.asciidoc (Browse further)