Is there a way to add documentation to the schema?...
# prisma-whats-newm
Michael Jones
03/23/2018, 8:54 PMIs there a way to add documentation to the schema? For instance, add a description of what each field is for.
d
Daniel K.
03/23/2018, 9:11 PMjust a regular comment for a field and it will get parsed into a documentation
m
Michael Jones
03/23/2018, 9:16 PMThank you! Do you know if there is any way to add comments that aren't added to the documentation? Or possibly add comments that separate the fields into different categories?
d
Daniel K.
03/23/2018, 9:20 PMwell, that mostly depends on a software that will parse and display that documentation, eg. graphiql will do only plain comments, not sure if there some other tools that would provide something more complex
Daniel K.
03/23/2018, 9:24 PMeither way, I would say this is one of great benefits of GraphQL, the schema itself (without comments) is self documented pretty well ... in case you need to add more information, there is a possibility that by clearly naming the field you might get more benefit than some long comment
m
Michael Jones
03/23/2018, 9:24 PMYeah it does seem very nice so far! That clears that up, thank you 🙂
2 Views