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

Document graphql_type on @strawberry.field #3698

Conversation

ksylvest
Copy link
Contributor

@ksylvest ksylvest commented Nov 14, 2024

Description

This documents a use case where the GraphQL type is not the same as data being used. This is useful if you are using an ORM for your data and building an API layer against it.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Summary by Sourcery

Documentation:

  • Document the use of graphql_type in the @strawberry.field decorator to handle cases where the GraphQL type differs from the data type, particularly useful for ORM-based data models.

Copy link
Contributor

sourcery-ai bot commented Nov 14, 2024

Reviewer's Guide by Sourcery

This PR adds documentation for the graphql_type parameter in the @strawberry.field decorator, explaining how to handle cases where the GraphQL type differs from the underlying data type. The changes are implemented by adding a new code example in the queries documentation that demonstrates this use case.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for graphql_type parameter usage in field decorators
  • Added explanation of graphql_type parameter purpose
  • Included practical example showing User/UserType conversion
  • Demonstrated how to handle mismatched types between data model and GraphQL schema
docs/general/queries.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ksylvest - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

docs/general/queries.md Outdated Show resolved Hide resolved
docs/general/queries.md Outdated Show resolved Hide resolved
@ksylvest ksylvest force-pushed the ksylvest/document-strawberry-graphql-type branch from 3d43f54 to c0cf7d2 Compare November 14, 2024 22:19
This documents a use case where the GraphQL type is not the same as data
being used. This is useful if you are using an ORM for your data and
building an API layer against it.
@ksylvest ksylvest force-pushed the ksylvest/document-strawberry-graphql-type branch from c0cf7d2 to d178bf6 Compare November 14, 2024 22:19
Copy link
Member

@patrick91 patrick91 left a comment

Choose a reason for hiding this comment

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

Nice, thank you! 😊

@ksylvest
Copy link
Contributor Author

@patrick91 thanks for your help earlier and all the work you've put into the library!

@patrick91 patrick91 merged commit 4920f1e into strawberry-graphql:main Nov 14, 2024
4 checks passed
@botberry
Copy link
Member

Thanks for contributing to Strawberry! 🎉 You've been invited to join
the Strawberry GraphQL organisation 😊

You can also request a free sticker by filling this form: https://forms.gle/dmnfQUPoY5gZbVT67

And don't forget to join our discord server: https://strawberry.rocks/discord 🔥

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.

3 participants