Skip to content

docs: add missing directive documentation#2721

Closed
jensneuse wants to merge 1 commit intomainfrom
foregoing-dogwood
Closed

docs: add missing directive documentation#2721
jensneuse wants to merge 1 commit intomainfrom
foregoing-dogwood

Conversation

@jensneuse
Copy link
Copy Markdown
Member

@jensneuse jensneuse commented Apr 1, 2026

Summary

  • Add documentation pages for 4 previously undocumented directives:
    • @deprecated — standard GraphQL spec directive for marking schema elements as deprecated
    • @specifiedBy — standard GraphQL spec directive for linking custom scalars to their specification
    • @connect__fieldResolver — Cosmo Connect directive for dedicated gRPC field resolution with parent context
    • @openfed__requireFetchReasons — OpenFed directive for fetch reason propagation to subgraphs (compliance/observability)
  • Update the Directives Reference index with entries for all 4 directives
  • Add all 4 pages to the docs navigation in docs.json

Test plan

  • Verify mintlify dev renders all new pages without errors
  • Check all internal links resolve correctly
  • Review protobuf example in @connect__fieldResolver matches actual tooling output

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added comprehensive documentation for four GraphQL directives: @deprecated (field/argument deprecation), @specifiedBy (scalar specification linking), @connect__fieldResolver (field resolution via separate RPC), and @openfed__requireFetchReasons (fetch reason propagation).
    • Updated directive index with new entries and enhanced coverage.

…dResolver, and @openfed__requireFetchReasons directives

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jensneuse jensneuse requested review from a team as code owners April 1, 2026 07:26
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wundergraphinc 🟡 Building Apr 1, 2026, 7:26 AM

@jensneuse jensneuse closed this Apr 1, 2026
@jensneuse jensneuse deleted the foregoing-dogwood branch April 1, 2026 07:26
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d4d2bfa2-0736-4a67-a5d2-6b3f4ef65b30

📥 Commits

Reviewing files that changed from the base of the PR and between 1a182a7 and 90cfe7f.

📒 Files selected for processing (6)
  • docs-website/docs.json
  • docs-website/federation/directives/connect__fieldresolver.mdx
  • docs-website/federation/directives/deprecated.mdx
  • docs-website/federation/directives/openfed__requirefetchreasons.mdx
  • docs-website/federation/directives/specifiedby.mdx
  • docs-website/federation/federation-directives-index.mdx

Walkthrough

This pull request adds documentation for four federation directives: @deprecated, @specifiedBy, @connect__fieldResolver, and @openfed__requireFetchReasons. The navigation configuration and directives index are updated to reflect these new documentation pages.

Changes

Cohort / File(s) Summary
Navigation Configuration
docs-website/docs.json
Updated GraphQL Federation directives navigation pages list with four new directive routes: federation/directives/deprecated, federation/directives/specifiedby, federation/directives/connect__fieldresolver, federation/directives/openfed__requirefetchreasons.
Directive Documentation
docs-website/federation/directives/deprecated.mdx, docs-website/federation/directives/specifiedby.mdx, docs-website/federation/directives/connect__fieldresolver.mdx, docs-website/federation/directives/openfed__requirefetchreasons.mdx
Added new directive documentation pages with GraphQL definitions, argument descriptions, usage examples, and federation/composition behavior. Includes detailed explanations of directive semantics: deprecation signaling, scalar specification linking, field resolver gRPC calls, and fetch reason propagation.
Directives Index
docs-website/federation-directives-index.mdx
Updated the directives reference index table with entries for the four new directives in GraphQL Specification and Federation categories.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs


Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant