graphql/graphiql

Unify doc explorer navigation around schema reference concept

Open

#298 geöffnet am 25. Jan. 2017

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)TypeScript (15.473 Stars) (1.785 Forks)batch import
enhancementgraphiqlhelp wantedresolved-by-monaco

Beschreibung

As defined in https://github.com/graphql/codemirror-graphql/blob/master/src/utils/SchemaReference.js - SchemaReference gives us a serializable way to refer to different parts of a schema.

Ideally this general utility is moved into a place where it can be leveraged more broadly (graphql-js perhaps) along with serialization and deserialization utilities.

This would make a better general public API for navigating to any element, and would give codemirror-graphql a better interface for interoperating with any kind of documentation browser.

It would also unlock issues like #77 by allowing a serialization of the currently viewed doc

Contributor Guide

Tech Stack
javascripttypescript
Domain
frontenddeveloper experiencedocumentation
Issue Type
refactor
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
GraphQL schema conceptsJavaScript/TypeScriptcodebase navigationrefactoring experience
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
25
Research-Richtung
Examine the SchemaReference utility in codemirror graphql (utils/SchemaReference.js) to understand its current interface and functionality. Study the graphql js repository to identify an appropriate location for the moved utility. Review issue #77 for context on serialization needs. Investigate if any existing serialization utilities in graphql js can be leveraged or extended. Engage with maintainers to clarify the desired API and acceptance criteria before implementation.