[data views] REST endpoint for swapping saved object references by mattkime · Pull Request #157665 · elastic/kibana

mattkime · 2023-05-14T05:10:49Z

Summary

Managing large number of saved objects can be cumbersome. This api endpoint allows the management of references without clicking through a lot of different UIs.

For example -

This swaps all data view id abcd-efg references to xyz-123

POST /api/data_views/swap_references
{
     "from_id" : "abcd-efg",
     "to_id" : "xyz-123",
     "preview" : false, // optional, necessary to save changes
     "delete" : true // optional, removes data view which is no longer referenced
}

returns 
{
  preview: false,
  result: [{ id: "123", type: "visualization" }],
  deleteSuccess: true
}

Additional params -

from_type: string - specify the saved object type. Default is `index-pattern` for data view
for_id: string | string[] - limit the affected saved objects to one or more by id
for_type: string - limit the affected saved objects by type

Closes #153806

…na into data_views_swap_references

elasticmachine · 2023-06-30T02:47:11Z

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

jughosta

Very helpful addition!

jughosta · 2023-07-04T09:34:18Z

src/plugins/data_views/server/rest_api_routes/public/swap_references.ts

+        request: {
+          body: schema.object({
+            from_id: idSchema,
+            from_type: schema.maybe(schema.string()),


What other types are supported? It could be that this endpoint should not be under data_views path then.

jughosta · 2023-07-04T09:35:06Z

src/plugins/data_views/server/rest_api_routes/public/swap_references.ts

+          body: schema.object({
+            from_id: idSchema,
+            from_type: schema.maybe(schema.string()),
+            to: idSchema,


to_id for consistency with from_id

jughosta · 2023-07-04T09:39:12Z

src/plugins/data_views/server/rest_api_routes/public/swap_references.ts

+            search_id: schema.maybe(schema.oneOf([idSchema, schema.arrayOf(idSchema)])),
+            search_type: schema.maybe(schema.string()),


How about for_id and for_type? search can be confused with a search query.

thanks, that does clarify things.

src/plugins/data_views/server/rest_api_routes/public/swap_references.ts

test/api_integration/apis/data_views/swap_references/main.ts

jughosta · 2023-07-04T10:07:07Z

test/api_integration/apis/data_views/swap_references/main.ts

+      const res2 = await supertest
+        .post(DATA_VIEW_SWAP_REFERENCES_PATH)
+        .set(ELASTIC_HTTP_VERSION_HEADER, INITIAL_REST_VERSION)
+        .send({
+          from_id: dataViewId,
+          to: dataViewId,
+        });
+
+      expect(res2.body.result.length).to.equal(1);


This part does not save changes, right? Does it fit to the test description?

I removed this.

test/api_integration/apis/data_views/swap_references/main.ts

test/api_integration/apis/index.ts

…na into data_views_swap_references

kibana-ci · 2023-07-06T05:02:09Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 765abae

Failed CI Steps

Pick Test Group Run Order

Metrics [docs]

Unknown metric groups

API count

id	before	after	diff
`dataViews`	1048	1049	+1

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	14	16	+2
`securitySolution`	410	414	+4
total			+6

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	15	17	+2
`securitySolution`	489	493	+4
total			+6

History

💚 Build #139917 succeeded 97962a0
💚 Build #139292 succeeded 594e433
💚 Build #138709 succeeded c885426
💚 Build #138701 succeeded 0b5fd86
💚 Build #138673 succeeded 403c7fa
💔 Build #130225 failed 3e01c00

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @mattkime

jughosta

Great job! LGTM 👍

## Summary Some simple dev UX improvements to the swap_references data views api - ``` POST /api/data_views/swap_references/_preview { "fromId" : "abcd-efg", "toId" : "xyz-123" } returns { result: [{ id: "123", type: "visualization" }], } ``` ``` POST /api/data_views/swap_references { "fromId" : "abcd-efg", "toId" : "xyz-123", "delete" : true // optional, removes data view which is no longer referenced } returns { result: [{ id: "123", type: "visualization" }], deleteStatus: { remainingRefs: 0, deletePerformed: true } ``` Additional params - ``` fromType: string - specify the saved object type. Default is `index-pattern` for data view forId: string | string[] - limit the affected saved objects to one or more by id forType: string - limit the affected saved objects by type ``` Improves upon #157665 Docs will be created in follow up PR

## Summary Some simple dev UX improvements to the swap_references data views api - ``` POST /api/data_views/swap_references/_preview { "fromId" : "abcd-efg", "toId" : "xyz-123" } returns { result: [{ id: "123", type: "visualization" }], } ``` ``` POST /api/data_views/swap_references { "fromId" : "abcd-efg", "toId" : "xyz-123", "delete" : true // optional, removes data view which is no longer referenced } returns { result: [{ id: "123", type: "visualization" }], deleteStatus: { remainingRefs: 0, deletePerformed: true } ``` Additional params - ``` fromType: string - specify the saved object type. Default is `index-pattern` for data view forId: string | string[] - limit the affected saved objects to one or more by id forType: string - limit the affected saved objects by type ``` Improves upon elastic#157665 Docs will be created in follow up PR

mattkime added 5 commits May 10, 2023 10:22

mostly working

a8f255c

cleanup

a5f4b8b

tests mostly in place

9ef29cd

Merge branch 'main' into data_views_swap_references

3e01c00

Merge branch 'main' into data_views_swap_references

7125f61

mattkime changed the title ~~Data views swap references~~ [data views] REST endpoint for swapping saved object references Jun 27, 2023

mattkime self-assigned this Jun 27, 2023

mattkime added 5 commits June 27, 2023 16:55

schema / type response

403c7fa

Merge branch 'main' into data_views_swap_references

0b5fd86

complete tests and tweak implementation code

e85187e

Merge branch 'data_views_swap_references' of github.com:mattkime/kiba…

c885426

…na into data_views_swap_references

Merge branch 'main' into data_views_swap_references

594e433

mattkime marked this pull request as ready for review June 30, 2023 02:47

mattkime requested a review from a team as a code owner June 30, 2023 02:47

Merge branch 'main' into data_views_swap_references

97962a0

jughosta reviewed Jul 4, 2023

View reviewed changes

mattkime added 2 commits July 5, 2023 22:41

improve tests

6c1ee0e

Merge branch 'data_views_swap_references' of github.com:mattkime/kiba…

765abae

…na into data_views_swap_references

jughosta approved these changes Jul 6, 2023

View reviewed changes

mattkime merged commit c843c97 into elastic:main Jul 6, 2023

kibanamachine added v8.10.0 backport:skip This PR does not require backporting labels Jul 6, 2023

mattkime mentioned this pull request Aug 9, 2023

[data views] swap_references api improvements #163225

Merged

		search_id: schema.maybe(schema.oneOf([idSchema, schema.arrayOf(idSchema)])),
		search_type: schema.maybe(schema.string()),

Conversation

mattkime commented May 14, 2023 • edited by jughosta Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

elasticmachine commented Jun 30, 2023

Uh oh!

jughosta left a comment

Choose a reason for hiding this comment

Uh oh!

jughosta Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

jughosta Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

jughosta Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

mattkime Jul 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jughosta Jul 4, 2023

Choose a reason for hiding this comment

Uh oh!

mattkime Jul 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kibana-ci commented Jul 6, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

API count

ESLint disabled line counts

Total ESLint disabled count

History

Uh oh!

jughosta left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mattkime commented May 14, 2023 •

edited by jughosta

Loading