strawberry-graphql / strawberry

A GraphQL library for Python that leverages type annotations 🍓
https://strawberry.rocks
MIT License
4.02k stars 533 forks source link

update doc for Flask and Quart #3647

Closed catwell closed 1 month ago

catwell commented 1 month ago

Description

The graphiql -> graphql_ide had not been made for those views.

Types of Changes

Checklist

Summary by Sourcery

Update the documentation for Flask and Quart integrations to reflect the change from graphiql to graphql_ide, providing more options for selecting a GraphQL IDE interface.

Documentation:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request updates the documentation for Flask and Quart integrations in Strawberry GraphQL. The main change is replacing the graphiql option with a more flexible graphql_ide option, which allows users to choose between different GraphQL IDE interfaces or disable them entirely.

Sequence Diagram

No sequence diagram generated.

File-Level Changes

Change Details Files
Replace 'graphiql' option with 'graphql_ide' in Flask and Quart integrations
  • Update the option name from 'graphiql' to 'graphql_ide'
  • Change the default value from 'True' to '"graphiql"'
  • Add support for multiple GraphQL IDE interfaces: 'graphiql', 'apollo-sandbox', and 'pathfinder'
  • Allow disabling the GraphQL IDE by passing 'None'
docs/integrations/flask.md
docs/integrations/quart.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. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) 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 - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourceryai/) or [GitHub](https://github.com/sourcery-ai).