Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[schema] lack of comments/description of GraphQL objects when schema is generated from endpoint #150

Closed
ojczeo opened this issue Apr 20, 2018 · 1 comment

Comments

@ojczeo
Copy link

ojczeo commented Apr 20, 2018

This is my config:

{
  "info": "graphQL api config for IDEs",
  "schema": {
    "request": {
      "url": "http://localhost:8182/api/graphql?",
      "method": "POST",
      "postIntrospectionQuery": true,
      "options": {
        "headers": {
          "user-agent": "JS GraphQL"
        }
      }
    }
  },
  "endpoints" : [
    {
      "name": "GraphQL API",
      "url": "http://localhost:8182/api/graphql",
      "options" : {
        "headers": {
          "user-agent" : "JS GraphQL"
        }
      }
    }
  ]
}

Unfortunately when plugin loading schema it drops the description of types definitions and props
defined in backend schema:

type File {
    # File id - it is file key name at storage service
    id: ID!
    # File name - display name
    name: String!

in generated schema:

type File {
    id: ID!
    name: String!
@ojczeo ojczeo changed the title [schema] lack of comments/description of GraphQL objects when schema is Generated from endpoint [schema] lack of comments/description of GraphQL objects when schema is generated from endpoint Apr 20, 2018
@jimkyndemeyer
Copy link
Collaborator

Fixed in https://github.com/jimkyndemeyer/js-graphql-intellij-plugin/releases/tag/2.0.0-alpha-3 which uses the quoted/triple quoted schema descriptions as outlined in the latest GraphQL draft spec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants