Skip to content

docs(router): demand control#91

Open
ardatan wants to merge 3 commits intomainfrom
demand-control-docs
Open

docs(router): demand control#91
ardatan wants to merge 3 commits intomainfrom
demand-control-docs

Conversation

@ardatan
Copy link
Copy Markdown
Member

@ardatan ardatan commented Apr 15, 2026

Documentation for graphql-hive/router#902

Copilot AI review requested due to automatic review settings April 15, 2026 15:46
@ardatan ardatan added the waits for release Represents changes in a library that have not yet been released label Apr 15, 2026
@ardatan ardatan temporarily deployed to storybook-preview April 15, 2026 15:46 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 15, 2026

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for the Router “Demand Control” feature and wires it into the security and configuration docs navigation.

Changes:

  • Add a new Demand Control security guide explaining the cost model, directives, enforcement modes, and observability.
  • Add a new demand_control configuration reference page and link it from the guide.
  • Update existing security docs/navigation to reference and include the new Demand Control docs.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/documentation/content/docs/router/security/operation-complexity.mdx Adds a section pointing readers to Demand Control as complementary protection.
packages/documentation/content/docs/router/security/meta.json Adds the new demand-control page to the Security nav.
packages/documentation/content/docs/router/security/demand-control.mdx New conceptual + how-to documentation for Demand Control.
packages/documentation/content/docs/router/configuration/meta.json Adds demand_control to the Configuration nav ordering.
packages/documentation/content/docs/router/configuration/demand_control.mdx New configuration reference page for demand_control.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +522 to +526
}
],
// If `include_extension_metadata` is enabled, you can also see the cost breakdown in extensions
"extensions": {
"cost": {
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

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

The fenced block is labeled as json, but it includes comment syntax (e.g. the // If include_extension_metadata... line, and also # ... comments elsewhere in the same snippet). That makes the example invalid JSON and may confuse readers/copy-paste. Consider removing comments from the snippet (move notes to surrounding prose) or switch the fence language to jsonc/javascript to match the syntax shown.

Copilot uses AI. Check for mistakes.
Comment on lines +693 to +697
],
// If `include_extension_metadata` is enabled
"extensions": {
"cost": {
"estimated": 480,
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

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

This block is marked as json, but it contains a // If include_extension_metadata... comment line, which is not valid JSON. Move the note outside the snippet or change the code fence language to jsonc/javascript so the example remains copy-pastable.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waits for release Represents changes in a library that have not yet been released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants