[Lens] Add internal CRUD api routes by nickofthyme · Pull Request #223296 · elastic/kibana

nickofthyme · 2025-06-10T20:03:39Z

Summary

This adds basic Lens CRUD api routes using the Content Management system.

Operation	URI
Create	`POST api/lens/visualizations`
Get	`GET api/lens/visualizations/{id}`
Search	`GET api/lens/visualizations?query=test`
Update	`PUT api/lens/visualizations/{id}`
Delete	`DELETE api/lens/visualizations/{id}`

Changes to Lens Content Management

The custom update method uses soClient.create under the hood for reasons (i.e. #160116). However, doing this acts as an update or create method with the provided id. I changed this behavior so now any update where the id is not found will return a 404 error.

Closes #221941
Closes #221942 - OpenAPI docs auto generate from route schema

Testing

You can testing this locally in kibana dev console like so...

GET kbn:/api/lens/visualizations/<id>?apiVersion=1

The apiVersion query param is needed to test internal api routes.

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.

nickofthyme

A few thoughts to consider.

nickofthyme · 2025-06-10T20:04:53Z

src/platform/plugins/shared/dashboard/server/api/register_routes.ts

-            perPage: schema.maybe(
-              schema.number({
-                meta: {
-                  description:
-                    'The number of dashboards to display on each page (max 1000). Default is "20".',
-                },
-                defaultValue: 20,
-                min: 1,
-                max: 1000,
-              })
-            ),
+            perPage: schema.number({
+              meta: {
+                description:
+                  'The number of dashboards to display on each page (max 1000). Default is "20".',
+              },
+              defaultValue: 20,
+              min: 1,
+              max: 1000,
+            }),


Using a defaultValue is enough to treat this as optional, but when also paired with schema.maybe the resulting validated value of perPage will be undefined instead of 20.

Mostly for @nickpeihl

x-pack/platform/plugins/shared/lens/server/api/routes/visualizations/create.ts

nickofthyme · 2025-06-10T20:22:21Z

x-pack/platform/plugins/shared/lens/server/api/routes/visualizations/create.ts

+      try {
+        ({ result } = await client.create(data, options));
+      } catch (e) {
+        // TODO prevent duplicate titles?
+
+        if (e.isBoom && e.output.statusCode === 403) {
+          return res.forbidden();
+        }


Do we want to prohibit duplicate titles at the API level? Currently we block this in the UI.

do we today ? (on the UI level ? )

Good question.
@nickpeihl do you have an existing logic for that in presentation? I would like consistency on the API side with the UI, hence keep the title validation as well, but let's sync with the entire API ecosystem as I think it has priority over UI.
@ppisljar yes we do. It is not possible to save a visualisation with an existing title.

We don't have that logic to prohibit duplicate titles on the API. We also don't prohibit it in the UI. We first warn users that saving a dashboard will create a duplicate title. But they can click the save button again to create the dashboard.

It is my understanding that Lens also allows creating a duplicative title in the same way.

Interesting, I never realized that was the flow. I figured the save was disabled.

x-pack/platform/plugins/shared/lens/server/content_management/lens_storage.ts

x-pack/platform/plugins/shared/lens/server/content_management/v1/cm_services.ts

src/platform/test/api_integration/apis/lens/visualizations/create/index.ts

ppisljar

nice, LGTM!

src/platform/test/api_integration/fixtures/kbn_archiver/saved_objects/lens.json

- fix paths - update files after move - move fixtures - add lens test config - update CO file with move

…apping'

jbudz

.buildkite/ftr_platform_stateful_configs.yml LGTM

kibanamachine · 2025-06-25T19:01:52Z

Starting backport for target branches: 8.19

https://github.com/elastic/kibana/actions/runs/15884860731

elasticmachine · 2025-06-25T19:02:10Z

💚 Build Succeeded

Buildkite Build
Commit: 9fdc36b

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`lens`	561	563	+2

Unknown metric groups

API count

id	before	after	diff
`lens`	660	662	+2

History

💛 Build #311819 was flaky 2cac74c
💔 Build #311808 failed 38a5438
💛 Build #309759 was flaky fb73fc2
💔 Build #309696 failed baef217

kibanamachine · 2025-06-25T19:08:26Z

💔 All backports failed

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts You might need to backport the following PRs to 8.19: - [ska] relocate x-pack/test/cases_api_integration (#225056) - [ska] [xpack] relocate platform tests (#225223) - Move apps/security and apps/spaces tests under platform

Manual backport

To create the backport manually run:

node scripts/backport --pr 223296

Questions ?

Please refer to the Backport tool documentation

nickofthyme · 2025-06-26T14:01:16Z

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2025-06-27T19:48:39Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.
cc: @nickofthyme

kibanamachine · 2025-06-30T19:48:53Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.
cc: @nickofthyme

kibanamachine · 2025-07-02T14:49:55Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 223296 locally
cc: @nickofthyme

feat: add internal lens api routes

7f86834

nickofthyme commented Jun 10, 2025

View reviewed changes

nickofthyme changed the title ~~feat: add internal lens api routes~~ [Lens] Add internal CRUD api routes Jun 10, 2025

nickofthyme added Feature:Lens backport:version Backport to applied version labels v8.19.0 v9.2.0 v9.1.0 release_note:feature Makes this part of the condensed release notes and removed v9.2.0 labels Jun 10, 2025

nickofthyme added 3 commits June 17, 2025 11:30

chore: update api specs and error handling

9c9754d

test: add basic lens api integration tests

058f4b2

Merge branch 'main' into new-lens-api

6e2df00

nickofthyme marked this pull request as ready for review June 18, 2025 01:23

nickofthyme requested review from a team as code owners June 18, 2025 01:23

nickofthyme and others added 3 commits June 17, 2025 20:26

chore: fix test title

30a61d2

[CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'

baef217

update codeowners file

fb73fc2

dmlemeshko reviewed Jun 18, 2025

View reviewed changes

src/platform/test/api_integration/apis/lens/visualizations/create/index.ts Show resolved Hide resolved

dmlemeshko approved these changes Jun 18, 2025

View reviewed changes

ppisljar approved these changes Jun 19, 2025

View reviewed changes

afharo reviewed Jun 20, 2025

View reviewed changes

src/platform/test/api_integration/fixtures/kbn_archiver/saved_objects/lens.json Show resolved Hide resolved

nickofthyme added 5 commits June 23, 2025 19:49

chore: assign vis team as fixture CO

fe1b2d4

Merge branch 'main' into new-lens-api

11baffc

Merge remote-tracking branch 'origin/new-lens-api' into new-lens-api

cabf404

chore: fix bad CO merge

4cab983

chore: fix bad CO merge

38a5438

nickofthyme removed the request for review from afharo June 24, 2025 00:56

chore: move lens api tests under x-pack

6cefe39

- fix paths - update files after move - move fixtures - add lens test config - update CO file with move

nickofthyme requested a review from a team as a code owner June 24, 2025 01:46

nickofthyme and others added 3 commits June 23, 2025 20:49

chore: update COs again

8ce00c8

[CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'

06a6a19

[CI] Auto-commit changed files from 'node scripts/styled_components_m…

2cac74c

…apping'

jbudz approved these changes Jun 24, 2025

View reviewed changes

nickofthyme added 3 commits June 25, 2025 12:22

Merge branch 'main' into new-lens-api

812c299

chore: remove co presentation review changes

af410d9

Merge remote-tracking branch 'origin/new-lens-api' into new-lens-api

9fdc36b

nickofthyme removed the request for review from a team June 25, 2025 17:28

nickofthyme enabled auto-merge (squash) June 25, 2025 17:28

nickofthyme merged commit 17c2556 into elastic:main Jun 25, 2025
10 checks passed

nickofthyme deleted the new-lens-api branch June 25, 2025 19:01

This was referenced Jun 26, 2025

[Security Solution] Adds ability to revert prebuilt rules to their base version #223301

Merged

[Oblt Onboarding] Add more errors logging for Auto Detect flow #222948

Merged

nickofthyme mentioned this pull request Jun 26, 2025

[8.19] [Lens] Add internal CRUD api routes (#223296) #225463

Closed

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jun 27, 2025

kibanamachine mentioned this pull request Jul 1, 2025

[Inference] Move tracing config to @kbn/tracing #225417

Merged

nickofthyme removed the v8.19.0 label Jul 1, 2025

nickofthyme added backport:skip This PR does not require backporting and removed backport missing Added to PRs automatically when the are determined to be missing a backport. backport:version Backport to applied version labels labels Jul 2, 2025

Comments

Conversation

nickofthyme commented Jun 10, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes to Lens Content Management

Testing

Checklist

Uh oh!

nickofthyme left a comment

Choose a reason for hiding this comment

Uh oh!

nickofthyme Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nickofthyme Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nickofthyme Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ppisljar Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

dej611 Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

nickpeihl Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

nickofthyme Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ppisljar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jbudz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kibanamachine commented Jun 25, 2025

Uh oh!

elasticmachine commented Jun 25, 2025

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

API count

History

Uh oh!

kibanamachine commented Jun 25, 2025

💔 All backports failed

Manual backport

Questions ?

Uh oh!

nickofthyme commented Jun 26, 2025

💚 All backports created successfully

Questions ?

Uh oh!

kibanamachine commented Jun 27, 2025

Uh oh!

kibanamachine commented Jun 30, 2025

Uh oh!

kibanamachine commented Jul 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

nickofthyme commented Jun 10, 2025 •

edited by kibanamachine

Loading

nickofthyme Jun 10, 2025 •

edited

Loading

nickofthyme Jun 10, 2025 •

edited

Loading