graphql/graphiql

Unify doc explorer navigation around schema reference concept

Open

#298 opened on Jan 25, 2017

View on GitHub
 (1 comment) (1 reaction) (0 assignees)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

Contributor guide

Tech stack
javascripttypescript
Domain
frontenddeveloper experiencedocumentation
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 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
GraphQL schema conceptsJavaScript/TypeScriptcodebase navigationrefactoring experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
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.