Guides RFC - #6 GraphQL

[anastasiya29]

RFC background

We have published the 1st version of JSS Guides & Recommended Practices. This content will ultimately be merged into the JSS Documentation site, and we'd love for the community to be a part of this milestone. We welcome your feedback, questions, change suggestions, and additional content.

Category - GraphQL

We’ve create GitHub issues for the 7 topic categories to facilitate group discussion - this issue is for discussing the GraphQL category.

Topics in this category:

• Guide to Extending GraphQL
• GraphQL Security Guide
• Query Recipes
• More resources

How to contribute

• Post your comments here, or
• Use this link to leave inline comments in the markdown files, or
• Use the Edit this on GitHub link at the bottom of each guide page to submit edits for specific pages, or
• Submit pull requests to the guides branch

---

:arrow_left: Go to previous category ----- Go to next category :arrow_right:

[AlexKasaku]

These are all under the section of disabling GraphiQL in Production:

<graphiql role:require=“ContentDelivery”>false</graphiql>
<enableSchemaExport role:require=“ContentDelivery”>false</enableSchemaExport>
<enableStats role:require=“ContentDelivery”>false</enableStats>
<enableCacheStats role:require=“ContentDelivery”>false</enableCacheStats>
<disableIntrospection role:require=“ContentDelivery”>true</disableIntrospection>

But are they all related to graphiql, or just the first line? If the others aren't, perhaps separate them with additional note on what is being disabled and why?

[AlexKasaku]

As GraphQL relates to the LayoutService and can be consumed outside of JSS - e.g. the aspnetcore rendering host - is it worth considering if this documentation belongs to JSS or sits outside of it? If it is part of JSS docs, an immediate question would be - does this only apply to JSS, or does it equally apply to aspnet core?

I've picked GraphQL as an example there but this likely applies to other areas too. Anything that sits under JSS docs may be missed when it equally applies elsewhere and would be helpful. This seems like a good opportunity to avoid confusion going forward - as it wouldn't be great to have to sift through JSS docs for aspnet core and working out what does apply and what doesn't.

[stale[bot]]

This has been automatically marked as stale because it has not had recent activity. It will be closed if there is no further activity within 30 days. You may add comments or the 'keep' label to prevent it from closing. Thank you for your contributions.