Commit graph

65 commits

Author SHA1 Message Date
Kibana Machine
82848ba927
Saved objects import compatibility across versions (#94072) (#94111)
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
2021-03-09 10:19:50 -05:00
Luca Belluccini
90b7915b4b
[DOC] Dashboard Export API (#65005) (#88263)
Suggest how to export multiple dashboards on the same API call.
2021-01-14 10:18:42 +01:00
gchaps
8f20aee0d2
Replaces GET verb with POST to match the rest of the documentation. (#85926) (#86567)
Both the documentation and the code (including tests) mention this should be a POST request. 

Proposing the same changes that were proposed in https://github.com/elastic/kibana/pull/85790 for backports to 7.x releases.

Co-authored-by: Franಠ_ಠis Conil <frconil@users.noreply.github.com>
2020-12-21 07:42:11 -08:00
Kaarina Tungseth
5f1767579d
[DOCS] Adds missing add default field API (#86332) (#86382) 2020-12-17 15:05:23 -06:00
Joe Portner
76b9853ea5
[Docs] Add server.xsrf.disableProtection to settings docs (#76022) (#76100) 2020-08-27 11:08:53 -04:00
Kaarina Tungseth
333271abd0
[7.x] [DOCS] Adds API keys to API docs (#71738) (#71891) 2020-07-15 11:30:12 -05:00
Kaarina Tungseth
a1f62120c6
[DOCS] Fixes to API docs (#71678) (#71765)
* [DOCS] Fixes to API docs

* Fixes rogue -u
# Conflicts:
#	docs/api/saved-objects/create.asciidoc
#	docs/api/saved-objects/export.asciidoc
#	docs/api/upgrade-assistant/batch_reindexing.asciidoc
2020-07-14 16:21:52 -05:00
Josh Dover
39c5e38c1d
[7.6] [DOCS] Clarify 'fields' option in SO.find docs (#71491) (#71723) 2020-07-14 13:12:29 -06:00
Kaarina Tungseth
6202690360
[DOCS] Fixes POST request for saved objects (#69036) (#69045) 2020-06-12 11:39:55 -05:00
Lisa Cawley
cc09185637
[DOCS] Fixes nesting in APM and spaces API (#62659) (#62670) 2020-04-06 11:59:57 -07:00
Kaarina Tungseth
c7d466e6c4
[DOCS] Collapses content in Kibana and APM APIs (#62201) (#62646)
* Collapses content in Kibana and APM APIs

* Update docs/api/role-management/put.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

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

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2020-04-06 13:11:20 -05:00
Kaarina Tungseth
6c24a49b2a
[7.6] [DOCS] Updates API requests and examples (#60695) (#60827)
* [DOCS] Updates API requests and examples (#60695)

* [DOCS] Updates API requests and examples

* Review comments

* Fixed errors
2020-03-26 15:19:37 -05:00
Melori Arellano
746662cab4
[DOCS] Add space_id path parameter to saved_object APIs (#47627) (#60969)
* [DOCS] Add space_id path parameter to saved_object APIs

* [DOCS] Apply suggested edits for #47627

* [DOCS] Apply suggested edits for #47627 to delete API
2020-03-23 15:06:22 -06:00
Kaarina Tungseth
5adce31aa0
[DOCS] Fixed typo in dashboard import API (#57862) (#57885) 2020-02-18 10:58:31 -06:00
gchaps
a529fc9a76
[docs] Fix spaces api example json (#50411) (#57120)
Make this example properly formatted json.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Chris Koehnke <chris.koehnke@pm.me>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-02-07 08:11:18 -08:00
Brandon Morelli
8fdb64d1d5
[docs] Remove unused callout (#56032) (#56099) 2020-01-28 13:19:03 -08:00
Kaarina Tungseth
5119ef2536
[DOCS] Updates for API usage (#51989) (#53147)
* [DOCS] Updates for API usage

* Changes from Larry

* Update docs/api/using-api.asciidoc

Co-Authored-By: Larry Gregory <lgregorydev@gmail.com>

* Comments from Larry

* Comment from Larry
2019-12-16 11:15:13 -06:00
Lisa Cawley
7e19942f26
[7.x] [DOCS] Fixes broken links (#51634) (#51771) 2019-11-26 13:48:59 -08:00
Kaarina Tungseth
cc18cb88f6
[DOCS] API intro (#47164) (#48461)
* [DOCS] API intro

* Logstash configuration management

* Reformatting

* Comments from Josh

* Commets from Gail

* Fixed broken things
2019-10-16 16:01:28 -05:00
Kaarina Tungseth
412b00fa16
[DOCS] Removed v1 from get features API request (#48425) 2019-10-16 11:37:27 -05:00
Rudolf Meijering
05c76f293c
Ignore missing references on saved object exports (#47685) (#48388)
* add saved object export details in ndjson response

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* update core doc

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* exclude export details for space copy

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* fixing tests

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* display warning instead of success if export contains missing refs

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* nits/typo

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* properly updates api integration tests

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* fix typings

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* add test on objects_table component

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* remove added translations from jp/cn bundles

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* restoring line feeds

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* improve doc and user alert message

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* restoring line feeds on server.api.md

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>

* warning test label

Signed-off-by: pgayvallet <pierre.gayvallet@elastic.co>
2019-10-16 15:39:17 +02:00
Nik Everett
bc59cb9e4d
Docs: Fix for asciidoctor (#47876) (#47910)
Asciidoctor is a bit more picky about somethings. This fixes them for
it.
2019-10-10 17:47:08 -04:00
Xavier Mouligneau
aa36b9e994
Add KQL functionality in the find function of the saved objects (#41136) (#47182)
* Add KQL functionality in the find function of the saved objects

wip

rename variable from KQL to filter, fix unit test + add new ones

miss security pluggins

review I

fix api changes

refactor after reviewing with Rudolf

fix type

review III

review IV

for security put back allowed logic back to return empty results

remove StaticIndexPattern

review V

fix core_api_changes

fix type

* validate filter to match requirement type.attributes.key or type.savedObjectKey

* Fix types

* fix a bug + add more api integration test

* fix types in test until we create package @kbn/types

* fix type issue

* fix api integration test

* export nodeTypes from packages @kbn/es-query instead of the function buildNodeKuery

* throw 400- bad request when validation error in find

* fix type issue

* accept api change

* renove _ to represent private

* fix unit test + add doc

* add comment to explain why we removed the private
2019-10-03 08:42:35 -04:00
Larry Gregory
45cc8d2aa5
[7.x] Custom space avatar images (#45148) (#46019)
* First changes for avatar images

* Added the ability to have custom images for space avatars

* Partial changes as requested by reviewers

* Final commit for space avatar images PR

* Wrapping avatar file name

* Colour picker always enabled, to allow background change for transparent svgs

* All the changes requested in the last review

* Fixes the type_check test errors

* Fixing the rendering errors for space pages

* Another batch of changes as requested by review

* Some more snapshot tests

* Last batch of changes

* Fixed the type_check test

* API doc updates

* Removed comment

* Removed imageUrl from state


Co-authored-by: Larry Gregory <larry.gregory@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2019-09-18 12:56:17 -04:00
Kaarina Tungseth
7fb9d01739
[DOCS] Updated API experimental notes (#46008) (#46032) 2019-09-18 11:02:27 -05:00
Kaarina Tungseth
d421a2cc22
[7.x] [DOCS] New template for APIs (#39298) (#45282)
* Clean up

* Dashboard export API

* More changes

* role-management and saved-objects

* Clean up

* Final clean up

* Clean up

* Moved labels to appropriate places

* Fixed rogue commits

* Comment from Aleh
2019-09-16 11:04:28 -05:00
Aleh Zasypkin
6341714d82
[7.x] Move base feature controls functionality from XPack Main plugin to a dedicated XPack Features plugin. (#45172) 2019-09-09 20:57:35 +02:00
Brandon Kobel
48aac69ae2
Moving Saved Object APIs from Experimental to Beta (#44140) (#44255)
* Saved Object APIs, now beta!

* Using Gail's word-choice, thanks Gail!!!
2019-08-28 08:49:45 -07:00
Larry Gregory
19b3941e2f
Copy Saved Objects to Spaces API (#38014) (#43723) 2019-08-21 18:47:09 -04:00
Lisa Cawley
0dbede0809 [DOCS] Fixes experimental annotations (#40376) 2019-07-15 10:18:58 -07:00
Lisa Cawley
b339750be9 [DOCS] Fixes typo (#40668) 2019-07-10 15:32:17 -07:00
Holger Brandl
f8b5160c13 Removed invalid/unneeded comma in json query (#31797)
(cherry picked from commit 276dcc7f72)

# Conflicts:
#	docs/api/url_shortening/shorten_url.asciidoc
(cherry picked from commit 0a316000e3)
2019-06-27 16:50:49 -07:00
Mike Côté
0c89b8efc7
Update import saved objects API docs to use curl examples (#37997) (#38098)
* Remove copy as curl

* Update import docs to use curl examples
2019-06-05 09:41:01 -04:00
Mike Côté
6e72e96247
Fix export saved objects API docs (#37991) (#38096) 2019-06-05 09:40:48 -04:00
Ahmad Bamieh
cfdc5f3a0f
[7.x] [Docs] Remove conflict code (#37672) (#37702) 2019-06-01 02:50:41 +03:00
Larry Gregory
6684d5b063
Feature Controls - Documentation (#35656) (#36911)
* update spaces images

* add Spaces FC section

* Updates for kibana authorization section

* update plugin development guide

* start adding docs

* remove unused description field from Feature Registry interface

* Update role management API documentation

* Apply suggestions from code review

Thanks, Gail!

Co-Authored-By: legrego <lgregorydev@gmail.com>

* Update docs/api/role-management/put.asciidoc

* update kibana privileges section intro

* relocate link to Role Management API

* update PUT role docs to align with ES

* indicate that base and feature privileges cannot be used at the same time

* restructure kibana privileges section

* add UI and API examples to Kibana Privileges section

* Apply suggestions from code review

Co-Authored-By: legrego <lgregorydev@gmail.com>

* address PR feedback

* Apply suggestions from code review

Co-Authored-By: legrego <lgregorydev@gmail.com>

* Apply suggestions from code review

Co-Authored-By: legrego <lgregorydev@gmail.com>

* address pr feedback

* Update docs/api/role-management/put.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/security/index.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>

* address PR feedback

* fix merge from master

* Update docs/spaces/managing-spaces.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>
2019-05-23 06:27:59 -04:00
István Zoltán Szabó
0ad91c09a6 [DOCS] Completed warning text. 2019-05-22 10:41:21 +02:00
Brandon Kobel
6092760ba8
Fixing the Kibana Role Management API note syntax (#36314) (#36464) 2019-05-20 19:21:24 -04:00
Larry Gregory
737a9be7a3
[7.x] Feature Controls - Spaces API Docs (#34575) (#35224)
Backports the following commits to 7.x:
 - Feature Controls - Spaces API Docs  (#34575)
2019-04-17 10:08:59 -04:00
Mike Côté
03202f5484
Modify saved object import APIs to handle special use cases from the previous import process (#34161) (#34539)
* Modify import APIs to handle special use cases from the previous import process

* Cleanup

* Add more examples to the docs

* Make title come from data inside file

* Fix some broken tests

* Fix docs

* Fix docs wording

* Apply PR feedback pt1

* Apply PR feedback pt2
2019-04-04 10:25:05 -04:00
Mike Côté
99d9b11dc7
Modify saved object export API to support exporting nested dependencies (#34225) (#34476)
* Modify saved object export API to be able to export nested dependencies

* Apply verbal feedback

* Apply PR feedback
2019-04-03 16:37:51 -04:00
gchaps
d3e469d933 [DOCS] Updates Create Pipeline doc (#34359) 2019-04-02 13:25:26 -07:00
Josh Dover
43b1b5e008
[docs] Add docs for Add Default Field API (#33792)
* [docs] Add docs for Add Default Field API

* Apply suggestions from code review

Co-Authored-By: joshdover <me@joshdover.com>

* Update copy

[skip ci]
2019-03-27 09:08:07 -05:00
Mike Côté
17f2f23f11
Return import errors for saved objects referencing a missing index pattern or search (#33005) (#33277)
* cherry-pick fd2bc9b

* Return errors when objects are missing references

* Fix import tslint

* Fix failing jest tests

* Fix x-pack integration tests

* Rename ensureReferencesExist to validateReferences

* Fix test naming to use validateReferences

* Update resolve_import_errors API to reflect new type attribute

* Validate references for search type as well

* Clarify comment

* Apply PR feedback

* Modify saved object bulkGet to be able to filter fields

* Apply PR feedback
2019-03-14 21:28:14 -04:00
Mike Côté
b5fd3da0a5
Rename resolve import conflicts API to resolve import errors (#33024) (#33124) 2019-03-13 10:27:56 -04:00
Mike Côté
f2016f09ae
Basic server side import API for saved objects (#32158) (#32790)
* Initial work

* Add overwrite and skip support

* Cleanup and add tests

* Move code into separate files

* Remove reduce

* New API parameters

* Add support to replace references

* Add better error handling

* Add spaces tests

* Fix return type in collectSavedObjects

* Apply PR feedback

* Update jest tests due to jest version upgrade

* Add docs

* WIP

* Split import routes pt1

* Add tests

* Fix broken tests

* Update docs and fix broken test

* Add successCount to _import endpoint

* Make skip by default in resolution API

* Update tests for removal of skips

* Add back support for skips

* Add success count

* Add back resolve import conflicts x-pack tests

* Remove writev from filter stream

* Delete _mock_server.d.ts file

* Rename lib/import_saved_objects to lib/import

* Filter records at stream level for conflict resolution

* Update docs

* Add tests to validate documentation

* Return 200 instead of other code for errors, include errors array

* Change [] to {}

* Apply PR feedback

* Fix import object limit to not return 500

* Change some wording in the docs

* Fix status code

* Apply PR feedback pt2

* Lower maxImportPayloadBytes to 10MB

* Add unknown type tests for import

* Add unknown type tests for resolve_import_conflicts

* Fix tslint issues
2019-03-08 14:23:10 -05:00
Mike Côté
d54690e064
Basic server side export API for saved objects (#30326) (#32513)
* Initial work for new server side export API

* Revert UI changes, API only in this PR

* Remove whitespace at top of export.asciidoc

* Add tests around limitations

* Add comment

* Convert some files to typescript

* Move Boom.boomify to where the errors are created

* Use Boom.badRequest for now

* Fix lint issue

* Move files

* Update tests

* Add functional test

* Export all documents by default

* Update test assertions

* Use ~10000 saved objects in export api integration test

* Convert route to typescript, add content-type response header

* Move some tests to api_integration

* Use new sort and rename functions/variables

* Move tests to API integration

* Cleanup and finalize api integration tests

* Make type or objects required but not both in the same call

* Add spaces / security tests

* Add noTypeOrObjects to security / spaces tests

* Use json-stable-stringify and add tests for export ordering

* Address self feedback, add without kibana index test

* Only allow export API to export index-pattern, dashboard, visualization and search type objects

* Make import export size configurable and fix broken tests

* Fix broken tests

* Move test config to mock server

* Add more typescript types instead of using any

* Convert request from GET to POST

* Fix saved objects mixin test

* Update src/legacy/server/saved_objects/lib/export.ts

Co-Authored-By: mikecote <mikecote@users.noreply.github.com>

* Apply PR feedback

* Fix lint error

* Update test snapshots due to jest upgrade

* Add error handling for bulkGet

* Split export API into two endpoints

* Update src/legacy/server/saved_objects/routes/export_by_type.test.ts

Co-Authored-By: mikecote <mikecote@users.noreply.github.com>

* Update docs/api/saved-objects/export_by_type.asciidoc

Co-Authored-By: mikecote <mikecote@users.noreply.github.com>

* Update docs/api/saved-objects/export_by_type.asciidoc

Co-Authored-By: mikecote <mikecote@users.noreply.github.com>

* Update src/legacy/server/saved_objects/routes/export_objects.test.ts

Co-Authored-By: mikecote <mikecote@users.noreply.github.com>

* Apply PR feedback

* MockServer -> createMockServer

* Revert back to single API

* Re-apply PR feedback
2019-03-05 16:38:23 -05:00
Josh Dover
11311f1429
[docs] Add docs for Upgrade Assistant APIs (#30330) (#31013)
* [docs] Add docs for Upgrade Assistant APIs

* Apply suggestions from code review

Co-Authored-By: joshdover <me@joshdover.com>

* Link to code tables
2019-02-13 15:41:29 -06:00
Mike Côté
1b0f595f01
Add new "references" attribute to saved objects for relationships (#28199)
* Add new references attribute to saved objects

* Add dual support for dashboard export API

* Use new relationships API supporting legacy relationships extraction

* Code cleanup

* Fix style and CI error

* Add missing spaces test for findRelationships

* Convert collect_references_deep to typescript

* Add missing trailing commas

* Fix broken test by making saved object API consistently return references

* Fix broken api integration tests

* Add comment about the two TS types for saved object

* Only return title from the attributes returned in findRelationships

* Fix broken test

* Add missing security tests

* Drop filterTypes support

* Implement references to search, dashboard, visualization, graph

* Add index pattern migration to dashboards

* Add references mapping to dashboard mppings.json

* Remove findRelationships from repository and into it's own function / file

* Apply PR feedback pt1

* Fix some failing tests

* Remove error throwing in migrations

* Add references to edit saved object screen

* Pass types to findRelationships

* [ftr] restore snapshots from master, rely on migrations to add references

* [security] remove `find_relationships` action

* remove data set modifications

* [security/savedObjectsClient] remove _getAuthorizedTypes method

* fix security & spaces tests to consider references and migrationVersion

* Add space id prefixes to es_archiver/saved_objects/spaces/data.json

* Rename referenced attributes to have a suffix of RefName

* Fix length check in scenario references doesn't exist

* Add test for inject references to not be called when references array is empty or missing

* some code cleanup

* Make migrations run on machine learning data files, fix rollup filterPath for savedSearchRefName

* fix broken test

* Fix collector.js to include references in elasticsearch response

* code cleanup pt2

* add some more tests

* fix broken tests

* updated documentation on referencedBy option for saved object client find function

* Move visualization migrations into kibana plugin

* Update docs with better description on references

* Apply PR feedback

* Fix merge

* fix tests I broke adressing PR feedback

* PR feedback pt2
2019-01-30 15:53:03 -05:00
Mike Côté
9eef63f783
Allow passing a default operator to use on saved object client find operations (#29339)
* Allow passing a default operator to use on find operations

* Default operator to OR like elasticsearch to avoid passing null

* Add dashboard search tests

* Make search_operator optional

* Fix query_params.test.js

* Include searchOperator in saved_object_finder

* Apply PR feedback

* Rename searchOperator to defaultSearchOperator
2019-01-30 11:33:44 -05:00