Skip to content

docs(router): circuit breaker in subgraph execution#86

Open
Copilot wants to merge 10 commits intomainfrom
copilot/create-documentation-for-feature
Open

docs(router): circuit breaker in subgraph execution#86
Copilot wants to merge 10 commits intomainfrom
copilot/create-documentation-for-feature

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 9, 2026

  • Merge main branch and resolve conflicts (d328cf2)
  • Update circuit breaker docs for router PR #900 field type changes (74c48ab)
  • Add error_status_codes field documentation to traffic_shaping.mdx
  • Add error_status_codes to the configuration table in performance-tuning.mdx
  • Run oxfmt - formatting verified

@ardatan ardatan added the waits for release Represents changes in a library that have not yet been released label Apr 9, 2026
@ardatan ardatan changed the title docs(router): sync circuit breaker docs with PR #900 changes docs(router): circuit breaker in subgraph execution Apr 9, 2026
@ardatan ardatan marked this pull request as ready for review April 9, 2026 12:27
Copilot AI review requested due to automatic review settings April 9, 2026 12:27
Copilot AI temporarily deployed to storybook-preview April 9, 2026 12:27 Inactive
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 9, 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 Router documentation describing the new circuit breaker behavior for subgraph execution and exposes the related traffic_shaping.circuit_breaker configuration in the reference docs (supporting graphql-hive/router#900).

Changes:

  • Add a new “Circuit Breaker” section to the Performance Tuning guide (states, configuration examples, tuning guidance, and a metric mention).
  • Extend the traffic_shaping configuration reference to document the circuit_breaker option and its fields.
  • Update the “Outbound Options” section to include circuit_breaker among globally/per-subgraph overrideable settings.

Reviewed changes

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

File Description
packages/documentation/content/docs/router/guides/performance-tuning.mdx Introduces circuit breaker guide content, examples, and metrics/tuning notes.
packages/documentation/content/docs/router/configuration/traffic_shaping.mdx Documents traffic_shaping.*.circuit_breaker config schema and links to the tuning guide.

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

Comment thread packages/documentation/content/docs/router/guides/performance-tuning.mdx Outdated
Comment thread packages/documentation/content/docs/router/guides/performance-tuning.mdx Outdated
Comment thread packages/documentation/content/docs/router/guides/performance-tuning.mdx Outdated
…tuning.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…tuning.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…tuning.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@ardatan
Copy link
Copy Markdown
Member

ardatan commented Apr 9, 2026

@copilot fix linting

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 9, 2026

@copilot fix linting

Fixed in d96c94a — ran oxfmt to correct table column alignment and YAML comment spacing in performance-tuning.mdx.

Copilot AI requested a review from ardatan April 9, 2026 13:52
@ardatan
Copy link
Copy Markdown
Member

ardatan commented Apr 30, 2026

@copilot resolve the merge conflicts in this pull request, and update documentation based on the recent changes in graphql-hive/router#900

Copilot AI and others added 2 commits April 30, 2026 11:29
…r documentation

Co-authored-by: ardatan <20847995+ardatan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 30, 2026

@copilot resolve the merge conflicts in this pull request, and update documentation based on the recent changes in graphql-hive/router#900

Done in 74c48ab. Merged main into the branch (resolved a conflict in traffic_shaping.mdx where the outbound options section diverged) and updated the circuit breaker docs based on router PR #900's recent changes:

  • circuit_breaker.enabled type updated to boolean | null — at the subgraph level, omitting this field now inherits the global value (instead of defaulting to false)
  • circuit_breaker.volume_threshold type updated to integer | null with the same inheritance note
  • All subgraph-level field descriptions clarify they fall back to the global config when omitted
  • Example YAML updated to demonstrate clean field inheritance (no redundant enabled: true in subgraph override)

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.

3 participants