vespa-engine/vespa

Schema browser with syntax highlighting

Chiusa

#16.870 aperta il 10 mar 2021

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Java (561 fork)batch import
good first issue

Metriche repository

Star
 (4948 stelle)
Metriche merge PR
 (Merge medio 1g 22h) (209 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
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.
Tech stack
javajavascripthtmlcss
Dominio
frontendtooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Basic JavaBasic JavaScriptUnderstanding of Vespa schema files
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30