Commit graph

37 commits

Author SHA1 Message Date
gchaps
c5db7ce64e
[7.x] Update create.asciidoc (#84046) (#84671)
* Update create.asciidoc (#84046)

The url templates provided for call of the API with space information was missing the /api/ section in it.

(cherry picked from commit 35f1cc16eaa29666d7212402f57ab17858ebc96d)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

* [DOCS] Fixes requests

Co-authored-by: Olivier V <vandamo.be@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2020-12-01 10:47:10 -08:00
Aleh Zasypkin
8adb439c59
[7.x] Rename batchSize parameter to batch_size to be consistent with the API namings guidelines. (#82224) 2020-11-01 13:21:35 +01:00
Aleh Zasypkin
a50e8c98f5
[7.x][Docs] Document Encrypted Saved Objects functionality. (#80867) 2020-10-16 18:25:02 +02:00
Joe Portner
54f947a6a3
[Docs] Update developer docs for create/bulkCreate initialNamespaces (#79769) (#79794)
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2020-10-07 00:14:26 -04:00
Joe Portner
f7bf1410d9
Rename namespaces to initialNamespaces for create operations (#79682) (#79767) 2020-10-06 19:04:08 -04:00
Joe Portner
bc114ae1ac
[7.x] Add support for sharing saved objects to all spaces (#76132) (#79411) 2020-10-05 10:55:18 -04:00
Kaarina Tungseth
25936f7a2f
[DOCS] Updates create.asciidoc (#73481) (#78464)
Co-authored-by: Sutra Hsing <sutrahsing@163.com>

Co-authored-by: Sutra Hsing <sutrahsing@163.com>
2020-09-24 12:37:40 -05:00
Joe Portner
5d94ec8c1d
[7.x] Sharing saved-objects phase 1.5 (#75444) (#76034) 2020-08-27 13:53:02 -04:00
Kaarina Tungseth
3d14f644f0
[DOCS] Fixes to API docs (#71678) (#71740)
* [DOCS] Fixes to API docs

* Fixes rogue -u
2020-07-14 16:17:57 -05:00
Josh Dover
af5f902e80
[7.x] [DOCS] Clarify 'fields' option in SO.find docs (#71491) (#71720) 2020-07-14 13:12:06 -06:00
Kaarina Tungseth
af8b5fac91
[DOCS] Fixes POST request for saved objects (#69036) (#69042) 2020-06-12 11:37:22 -05:00
Josh Dover
61d89506a3
[7.x] Fix typos (#66984) (#67550)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Ryder Timberlake <wrtimberlake@gmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-06-02 07:57:55 -06:00
Kaarina Tungseth
3fc33a3e8e
Add headers to the sample curl (#63548) (#63861)
* Add headers to the sample curl

At least in 7.x it doesn't work without the kbn-xsrf and json headers.

* More headers to curl commands

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

Co-authored-by: Radu Gheorghe <radu.gheorghe@sematext.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-04-17 10:17:33 -05:00
Joe Portner
a0bde86792
[7.x] Sharing saved-objects phase 1 (#54605) (#63215)
Co-authored-by: kobelb <brandon.kobel@elastic.co>
2020-04-10 12:56:08 -04:00
Kaarina Tungseth
967186bd36
[7.x] [DOCS] Updates API requests and examples (#60695) (#60826)
* [DOCS] Updates API requests and examples (#60695)

* [DOCS] Updates API requests and examples

* Review comments

* Fixed error
2020-03-26 15:11:17 -05:00
Melori Arellano
04475e8177
[DOCS] Add space_id path parameter to saved_object APIs (#47627) (#60968)
* [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:12 -06:00
Brandon Morelli
753c42be44
[docs] Remove unused callout (#56032) (#56098) 2020-01-28 13:19:14 -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
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
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
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
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
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
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
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
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
Sarah Hersh
5c1615dd96
[DOCS] Kibana APIs not accessible via Console (#26221) 2018-12-05 16:20:58 -05:00
Larry Gregory
33acd60f9f
Remove ability to implicitly find across all types (#23198) 2018-09-19 07:22:43 -04:00
Nathan Reese
2084842e36
Add _bulk_create endpoint to /api/saved_objects (#20498)
* add _bulk_create rest endpoint

* document bulk_create api

* provide 409 status code when conflicts exist

* add overwrite and version to documenation

* clean up assert statements and 2 places where bulkCreate is getting used with new output

* properly stub bulkCreate return

* remove version of documenation example
2018-07-10 07:38:39 -06:00
Court Ewing
5abc2dc738
Documentation for Saved Objects API (#19513)
* Adds documentation for Saved Objects API

Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>

* [DOCS] Moved Rest APIs in navigation

* docs: revise rest api intro

* docs: revise create object api details

* docs: revise saved object api intro

* docs: revise delete saved object api details

* docs: remove newline character from api response

* docs: get saved object api details

* docs: update saved object api details

* docs: fix title attribute in saved object api examples

* docs: bulk-get saved object api details

* docs: find saved object api details

* docs: add index-pattern to valid types in api

* docs: clarify sending multiple values in api

* docs: note that savedObjects.find is not safe for export
2018-05-30 12:27:48 -04:00