Skip to content

DX-088: Generate the indexer GraphQL schema reference #600

Description

@IbrahimIjai

Context

The indexer's schema is generated by codegen and its types are gitignored
(AGENTS.md §5). A hand-written schema page would be stale within a sprint, so
this one is generated from the same source and drift-checked in CI.

Scope

  • A generator producing content/reference/graphql.generated.mdx from the
    indexer's schema, with a "do not edit" banner.
  • Document every type, field, query, and argument, with descriptions taken from
    schema comments so they live next to the code.
  • Include example queries for the common cases: positions by account, recent
    trades, market state.
  • Run indexer codegen before generating — any script compiling the indexer must
    (AGENTS.md §5).
  • CI fails on drift between committed output and a fresh run.

Acceptance criteria

  • Generated output matches the live schema, enforced by the CI drift check.
  • Every type and field appears; count asserted against the schema.
  • Example queries were executed against a local indexer and their responses
    are shown.
  • The generator runs codegen first and fails clearly if it cannot.

Out of scope

  • Running the indexer locally (DX-089).

Spec: docs/dx_1/001_docs_site.md §6 · Depends on: DX-087

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions