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

[Docs] [Codegen] Document using types with direct API access #2183

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lizkenyon
Copy link
Contributor

WHY are these changes introduced?

Related to Codegen doesn't work out of the box with direct access graphql client

WHAT is this pull request doing?

  • Because direct API access uses the Fetch API directly, the response types cannot be automatically inferred, like when using the admin.graphql
  • Developers could also consider creating a custom wrapper client around fetch

Type of change

  • Patch: Bug (non-breaking change which fixes an issue)
  • Minor: New feature (non-breaking change which adds functionality)
  • Major: Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have used pnpm changeset to create a draft changelog entry (do NOT update the CHANGELOG.md files manually)
  • I have added/updated tests for this change
  • I have documented new APIs/updated the documentation for modified APIs (for public APIs)

@lizkenyon lizkenyon requested a review from a team as a code owner March 5, 2025 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant