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 (1 785 forks)batch import
enhancementgraphiqlhelp wantedresolved-by-monaco

Métriques du dépôt

Stars
 (15 473 stars)
Métriques de merge PR
 (Merge moyen 3j 23h) (50 PRs mergées en 30 j)

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

Direction de recherche
Analyser l'utilitaire SchemaReference actuel dans codemirror graphql et son utilisation. Proposer une stratégie pour le déplacer vers graphql js ou un emplacement partagé, en incluant des utilitaires de sérialisation et de désérialisation pour une utilisation plus large.
Stack technique
typescript
Domaine
developer experience
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
TypeScriptGitGraphQL
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60