Comments (5)
The latest version is showing the comments correctly.
https://2fd.github.io/graphdoc/shopify/mutation.doc.html
Which one are you using?
From what scheme are you generating the documentation? IDL, HTTP or JSON?
from graphdoc.
I installed it as a dependence: "@2fd/graphdoc": "^2.4.0"
for my project and then add this script to my package.json
:
"graphdoc": {
"endpoint": "http://localhost:5000/graphql",
"output": "./doc/schema"
},
"scripts": {
"doc": "graphdoc -f"
},
And that's what I got when running npm run doc
.
from graphdoc.
Could you run the following query and post the result?
fragment FullType on __Type {
fields(includeDeprecated: true) {
name
description
args {
...InputValue
}
type {
...TypeRef
}
isDeprecated
deprecationReason
}
inputFields {
...InputValue
}
interfaces {
...TypeRef
}
enumValues(includeDeprecated: true) {
name
description
isDeprecated
deprecationReason
}
possibleTypes {
...TypeRef
}
}
fragment InputValue on __InputValue {
name
description
type {
...TypeRef
}
defaultValue
}
fragment TypeRef on __Type {
kind
name
description
ofType {
kind
name
description
ofType {
kind
name
description
ofType {
kind
name
description
ofType {
kind
name
description
ofType {
kind
name
description
ofType {
kind
name
description
ofType {
kind
name
description
}
}
}
}
}
}
}
}
{
__type(name: "Mutation") {
name
kind
description
...FullType
}
}
from graphdoc.
Thank you for the response, here is the result:
"data": {
"__type": {
"name": "Mutation",
"kind": "OBJECT",
"description": "",
"fields": [
{
"name": "register",
"description": "Register new user, need to remove Authorization and RefreshToken headers",
"args": [
{
"name": "firstname",
"description": "",
"type": {
"kind": "NON_NULL",
"name": null,
"description": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "lastname",
"description": "",
"type": {
"kind": "NON_NULL",
"name": null,
"description": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "email",
"description": "",
"type": {
"kind": "NON_NULL",
"name": null,
"description": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "password",
"description": "",
"type": {
"kind": "NON_NULL",
"name": null,
"description": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"description": null,
"ofType": {
"kind": "OBJECT",
"name": "User",
"description": "",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "login",
"description": "Login to system, need to remove Authorization and RefreshToken headers",
"args": [
{
"name": "email",
"description": "",
"type": {
"kind": "NON_NULL",
"name": null,
"description": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "password",
"description": "",
"type": {
"kind": "NON_NULL",
"name": null,
"description": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "LoginResponse",
"description": "",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
}
}
}
from graphdoc.
In your schema all parameter descriptions are empty strings
{
"name": "firstname",
"description": "", // <--- Parameter description is empty string
"type": {
"kind": "NON_NULL",
"name": null,
"description": null,
"ofType": { /* ... */ }
},
"defaultValue": null
}
How are you generating your schema?
from graphdoc.
Related Issues (20)
- Comments and Nulls HOT 2
- What if my endpoint requires an oAuth token? HOT 3
- Attribute not documented HOT 2
- Expected Name, found String HOT 2
- Doesn't support comments in """ blocks HOT 4
- Syntax Error GraphQL (740:50) Unexpected character "&". HOT 1
- Support piped input for generating documentation HOT 1
- Drop support for older node versions
- Last published to npm 3 years ago
- Prettier config: Default config + run once on codebase
- Remove bluebird?
- Request more clear documentation for how to use headers when connecting to an endpoint.
- While creating doc, getting error Error: Invalid character Code: 800A03F6 Source: Microsoft JScript compilation error
- I get the following error: Type "AWSJSON" not found in document. HOT 3
- Arguments not showing for all queries and mutations
- Ability to filter out "Not documented"
- [Security] Workflow pull_request.yml is using vulnerable action actions/checkout
- [Security] Workflow release.yml is using vulnerable action actions/checkout
- [Feature Request] - link to the line number on a given docs page
- allow to explicitly specify schema extension
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from graphdoc.