Skip to content

[PB-2846] Temporarily hide Cursor Origin GraphQL types - #3154

Closed
hannahcancode wants to merge 1 commit into
mainfrom
agent/temporarily-hide-cursor-origin-graphql-types
Closed

[PB-2846] Temporarily hide Cursor Origin GraphQL types#3154
hannahcancode wants to merge 1 commit into
mainfrom
agent/temporarily-hide-cursor-origin-graphql-types

Temporarily hide Cursor Origin GraphQL types

e1add63
Select commit
Loading
Failed to load commit list.
buildsworth-bk-app / Buildsworth review succeeded Aug 14, 2026 in 2m 52s

Review submitted — approved

Review summary

Change reviewed

PR buildkite/docs#3154 temporarily removes the three Cursor Origin GraphQL object types from the checked-in documentation schema while the durable documentation-only schema filtering changes are reviewed in related repositories. The public GraphQL API remains unchanged.

The change removes:

  • OrganizationRepositoryProviderCursorOrigin
  • RepositoryProviderCursorOrigin
  • RepositoryProviderCursorOriginSettings

It also removes the organization provider type from AuditSubjectNode, regenerates the relevant interface and union reference pages, deletes the three generated object pages, and removes their entries from data/nav_graphql.yml.

What I examined

  • Read the complete PR diff and all remaining changed generated pages.
  • Inspected data/graphql/schema.graphql around the removed type definitions and AuditSubjectNode membership.
  • Checked the GraphQL documentation generator in scripts/generate_graphql_api_content.rb, its schema and navigation helpers, and the graphql:generate Rake task to confirm how schema removals propagate to generated pages and navigation.
  • Confirmed the generator removes the existing schemas directory before rebuilding it, so deleting these types from the source schema is expected to delete their object pages and remove them from interface possible-type lists.
  • Searched the repository for all three removed type names. No residual schema references, generated links, navigation entries, or other references remain.
  • Inspected the related Linear issue PB-2846 and the coordinated buildkite/docs-private#1956 and buildkite/buildkite#32363 PR descriptions. Those changes establish the longer-term documentation-specific schema view while preserving normal schema introspection and Terraform compatibility.
  • Ran git diff --check; it passed.
  • Confirmed the commit status for Buildkite docs build #8813 is successful.

Checks not run locally

I attempted the PR's mise exec -- bundle exec rake graphql:generate command, but this review environment does not have mise, Ruby, or Bundler available on PATH. I therefore did not independently rerun the generator or the GraphQL content specs locally. The PR reports 30 passing GraphQL content examples, and the successful Buildkite docs build includes the generated GraphQL documentation consistency check.

Findings and verdict

No actionable issues were found. The schema, generated reference pages, deleted object pages, and GraphQL navigation are internally consistent with the stated temporary hiding behavior. I submitted an approval with no inline comments.

Trigger source: automatic.