Skip to content

docs(sdk): Migrate GraphQL spec to Writing SDK Specs guidelines - #20086

Closed
sentry-junior[bot] wants to merge 1 commit into
junior/migrate-feature-flags-specfrom
junior/migrate-graphql-spec
Closed

sentry-junior[bot] wants to merge 1 commit into
junior/migrate-feature-flags-specfrom
junior/migrate-graphql-spec

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Migrates the GraphQL spec to the Writing SDK Specs guidelines, using the writing-sdk-specs skill. It's stacked on the Feature Flags migration (#20085).

What changed in the spec:

  • Requirements now describe only what you can see in sent events, spans, breadcrumbs, and app behavior. How to hook into libraries, the error-detection regex, stream cloning, and library-specific tips moved to Implementation Guidance. Notes about product changes (syntax highlighting, performance issues) and the speculative Apollo tracing idea were removed.
  • Every requirement now has an explicit bold keyword. Requirement levels follow RFC 2119 Section 6. Almost everything is "SHOULD". "MUST" is kept for three things: setting request.api_target: "graphql", because Relay only scrubs GraphQL variables when it is set; not attaching request or response bodies, or graphql.document, unless the user's data collection settings allow it; and not stopping the app from reading a body the SDK reads.
  • Fixes found while checking SDK code and Relay:
    • The event key is fingerprint, not fingerprints, and it holds real values (["GetUser", "query", "200"]) instead of literal $operationName placeholders. This matches what Java Apollo and .NET send.
    • request.data and contexts.response.data should be JSON objects, because that is what Relay scrubs.
    • Server spans and transaction names are now described as spans, since "transaction description" isn't a real field. Span names follow the OpenTelemetry GraphQL conventions, where the operation name is optional because of cardinality.
  • Resolver and data loader spans are now "MAY". The JavaScript SDK ignores resolver spans by default. Breadcrumb type and category values, plus the resolver and data loader breadcrumb fields, moved to Implementation Guidance as the pattern Java and .NET use. They are not needed for interop, and Python and JavaScript use different values.
  • The page now follows the intro → Scope → Definitions → Requirements → Implementation Guidance → Changelog structure, declares spec_guidelines: writing-specs@0.1, and lists HTTP Client in spec_depends_on.

Because existing requirements changed, this is a major bump to 2.0.0, and every section's since is 2.0.0. Existing section anchors are unchanged. Two sections are new: graphql-http-client, which keeps the old "follow HTTP Client" overview as a requirement, and graphql-event-data, which holds the request and response data rules shared by clients and servers. SDK owners (Java, .NET, Python, JavaScript) should confirm the new requirement levels before this leaves draft.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

via @szokeasaurusrex.

--

View Junior Session [Sentry]

@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 19, 2026 4:15pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
sentry-docs Ignored Ignored Preview Oct 19, 2026 4:15pm UTC

Request Review

@github-actions github-actions Bot added the sdk-develop-docs PRs touching develop-docs/sdk label Oct 19, 2026
Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 19, 2026
@sentry-junior
sentry-junior Bot force-pushed the junior/migrate-graphql-spec branch from 128febf to 9216537 Compare October 19, 2026 16:12
@szokeasaurusrex
szokeasaurusrex deleted the junior/migrate-graphql-spec branch October 19, 2026 16:32

This branch was successfully deployed

1 active deployment
Preview – develop-docs — 92165373 Deployed Oct 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant