graphql/graphiql

Allow the schema to be displayed in IDL format

Open

#582 opened on Aug 24, 2017

View on GitHub
 (5 comments) (5 reactions) (0 assignees)TypeScript (15,473 stars) (1,785 forks)batch import
enhancementgraphiqlhelp wantedpotential plugin

Description

Today we have the documentation view of the schema rendered as HTML

It would be great to have a link that showed the IDL view of the schema or type

eg

 type Person {
      # The name of this person.
      name: String
      # The year were born
      birthYear: String
      eyeColor: String
      gender: String
      hairColor: String
      height: Int
      mass: Float
      skinColor: String
      homeworld: Planet
}

This would allow you to capture the schema in IDL format as well as given you a way to stare at the schema as a whole versus the in detail view of today

Contributor guide

Tech stack
typescriptreactgraphql
Domain
frontenddeveloper experiencetoolingdocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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.
clear
Prerequisites
GraphQL schema syntaxReact and TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the GraphiQL codebase to locate the component responsible for the current HTML schema documentation view, likely in the 'doc explorer' directory. Use the `printSchema` function from graphql js to generate the IDL format. Implement a button or link to toggle between HTML and IDL views. Review comments on issue 582 for any prior discussion or design suggestions.