graphql/graphiql

Unify doc explorer navigation around schema reference concept

Open

#298 ouverte le 25 janv. 2017

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)TypeScript (15 473 stars) (1 785 forks)batch import
enhancementgraphiqlhelp wantedresolved-by-monaco

Description

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

Guide contributeur

Stack technique
javascripttypescript
Domaine
frontenddeveloper experiencedocumentation
Type d'issue
refactor
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
GraphQL schema conceptsJavaScript/TypeScriptcodebase navigationrefactoring experience
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
25
Direction de recherche
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.