Skip to content

Update introspection docs #1812

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

Merged
merged 4 commits into from
Nov 15, 2024
Merged

Conversation

mandiwise
Copy link
Contributor

Description

This PR contains updated introspection content for the Learn docs. Key changes include:

  • A new section on type name introspection
  • Documentation comments in the demo schema have been turned into description strings so they may be queried in mini GraphiQL (fixes last example where description field returned null)
  • Added comment on why introspection may not be available in production
  • Light editing throughout the Introspection page

@benjie @jorydotcom

Copy link

vercel bot commented Nov 2, 2024

@mandiwise is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like this editorial and expansion, especially adding a section on disabling introspection in production (though I have comments on what that section should contain 😉)

Co-authored-by: Benjie <benjie@jemjie.com>
@mandiwise mandiwise mentioned this pull request Nov 8, 2024
Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work; I think this is good to go with or without the suggestion above 🙌

Copy link

vercel bot commented Nov 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
graphql-github-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 11, 2024 1:55pm

Co-authored-by: Benjie <benjie@jemjie.com>
@benjie benjie merged commit 649db0d into graphql:source Nov 15, 2024
4 checks passed
mandiwise added a commit to mandiwise/graphql.github.io that referenced this pull request Nov 19, 2024
Co-authored-by: Benjie <benjie@jemjie.com>
mandiwise added a commit to mandiwise/graphql.github.io that referenced this pull request Nov 22, 2024
Co-authored-by: Benjie <benjie@jemjie.com>
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

Successfully merging this pull request may close these issues.

2 participants