vespa-engine/vespa

Schema browser with syntax highlighting

Open

#16,870 opened on Mar 10, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (4,948 stars) (561 forks)batch import
good first issue

Description

One can browse schemas using http://localhost:19071/application/v2/tenant/default/session/2/content/schemas/ (replace 2 with current session) or support reading (a) file(s). Add pretty-print and syntax highlighting. Maybe write a .sd-to-json converter, so easy to build a schema object model from json in other code.

Serving the code can be done like the querybuilder / https://github.com/vespa-engine/vespa/blob/master/container-search-gui/src/main/java/com/yahoo/search/query/gui/GUIHandler.java - need to add a binding in services.xml that maps to the code, put (javascript) in src/main/resources.

Then we can consider integrating this deeper in Vespa later, and still get started easy "on the outside" using the current interfaces

Document Types in Schemas can be inherited, build support for visualizing this / what the final schema resolves to.

Contributor guide

Tech stack
javajavascripthtmlcss
Domain
frontendtooling
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-2 days
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.
mostly clear
Prerequisites
Basic JavaBasic JavaScriptUnderstanding of Vespa schema files
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Start by examining the existing GUIHandler in container search gui/src/main/java/com/yahoo/search/query/gui/GUIHandler.java for structure. Create a similar handler for schema browsing. Add a binding in services.xml. For syntax highlighting, include a JavaScript library. Consider writing a .sd to json converter to simplify schema object model creation. The issue suggests integrating later, but initial implementation can be external.