elastic/kibana

Saved object import: show validation errors in UI

Open

#166795 opened on Sep 20, 2023

View on GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (19,065 stars) (8,021 forks)batch import
Feature:Saved Objects ManagementTeam:Coregood first issue

Description

If importing saved objects results in the API returning validation errors these errors should be displayed in the UI so users can take action on them.

For example, importing a dashboard with kibanaSavedObjectMeta.searchSourceJSON as a object instead of a string causes the API to respond with:

{
    "successCount": 0,
    "success": false,
    "warnings": [],
    "errors": [
        {
            "id": "elasticsearch-storage-dashboard",
            "type": "dashboard",
            "meta": {
                "title": "Cluster Ingest Per Day (Technical Preview/Beta)",
                "icon": "dashboardApp"
            },
            "error": {
                "isBoom": true,
                "isServer": false,
                "data": null,
                "output": {
                    "statusCode": 400,
                    "payload": {
                        "message": "[attributes.kibanaSavedObjectMeta.searchSourceJSON]: expected value of type [string] but got [Object]: Bad Request",
                        "statusCode": 400,
                        "error": "Bad Request"
                    },
                    "headers": {}
                },
                "type": "unknown"
            }
        }
    ]
}

But the UI just shows "Error" without any explanation

Contributor guide

Tech stack
typescriptreactnodejsrest api
Domain
frontendbackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Kibana's saved object import flowReact knowledgeUnderstanding of API error response structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the UI component that handles saved object import results, likely in the saved objects management plugin. The API returns validation errors in a structured format as shown in the issue. The current UI displays a generic 'Error' message. The fix likely involves parsing the error response and displaying the specific error messages (e.g., from `error.output.payload.message`) in the import result flyout. Look at the import API client and the component that renders the import summary. Linked files: src/plugins/saved objects management/ or similar. No open PRs or assignees.