docs(router): Query Complexity

[ardatan]

Documentation of graphql-hive/router#623

[gemini-code-assist]

Summary of Changes

Hello @ardatan, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on enhancing the documentation for the GraphQL router by introducing detailed guides on query complexity limiting features. It covers how to configure max_depth, max_directives, and max_tokens to safeguard against overly complex or potentially malicious queries, thereby improving API security and stability. Additionally, a minor version update for a related dependency is included.

Highlights

• Dependency Update: The hive-apollo-router-plugin dependency has been updated to version 3.0.1 in the Cargo lock file.
• New Configuration Documentation: Comprehensive documentation for the new limits configuration has been added, detailing max_depth, max_directives, and max_tokens options to control GraphQL query complexity.
• Query Complexity Security Guide: A new security guide has been introduced to explain GraphQL query complexity, its potential risks, and how to mitigate them using the newly documented limits configuration.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

🚀 Snapshot Release (alpha)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package	Version	Info
hive	9.2.0-alpha-20260123102705-a80634c7419735f0c2d62968a408a2b64a5eebc4	npm ↗︎ unpkg ↗︎

[github-actions]

📚 Storybook Deployment

The latest changes are available as preview in: https://pr-7544.hive-storybook.pages.dev

[gemini-code-assist]

Code Review

This pull request adds documentation for the new query complexity limiting features in the router. The changes are well-structured, adding a new configuration page for limits and a security guide on query complexity. I've found a few typos and minor inconsistencies in the documentation content that should be addressed for clarity.

[github-actions]

🐋 This PR was built and pushed to the following Docker images:

Targets: apollo-router-hive-build

Platforms: linux/amd64

Image Tag: ef326adb822a89e512a19cbb4dc1a51bdc034066

[github-actions]

🐋 This PR was built and pushed to the following Docker images:

Targets: build

Platforms: linux/amd64

Image Tag: a80634c7419735f0c2d62968a408a2b64a5eebc4

[github-actions]

💻 Website Preview

The latest changes are available as preview in: https://pr-7544.hive-landing-page.pages.dev