Skip to content

docs: add OpenAPI 3 spec for miner HTTP API + Redoc reference + CI validation#38

Open
laeeH wants to merge 1 commit into
Dipraise1:mainfrom
laeeH:feat/openapi-miner-spec
Open

docs: add OpenAPI 3 spec for miner HTTP API + Redoc reference + CI validation#38
laeeH wants to merge 1 commit into
Dipraise1:mainfrom
laeeH:feat/openapi-miner-spec

Conversation

@laeeH

@laeeH laeeH commented Jun 14, 2026

Copy link
Copy Markdown

Summary

This PR adds a complete OpenAPI 3.0 specification for the Engram Miner HTTP API (served on port 8091) and a rendered Redoc reference page.

Changes

  1. docs/openapi.yaml — Full OpenAPI 3.0 spec covering all miner endpoints:

    • Public: /health, /stats, /metagraph
    • Authenticated (sr25519 signed): /IngestSynapse, /QuerySynapse, /ChallengeSynapse, /retrieve/{cid}
    • Namespace & key mgmt: /namespace, /AttestNamespace, /attestation/{namespace}, /KeyShareSynapse, /KeyShareRetrieve
    • Repair & replication: /RepairSynapse, /list
    • Merkle proofs: /commitment, /prove-memory
  2. docs/api-reference.html — Interactive Redoc page for browsing the API

  3. docs/miner.md — Added API Reference section with links

  4. .github/workflows/ci.yml — Added openapi-lint job using Spectral to validate the spec on every PR

Related Issue

Addresses #23 (OpenAPI spec for miner HTTP endpoints)

Bounty

This PR addresses the bounty listed in ROADMAP.md for generating an OpenAPI spec from the miner's route definitions.

@vercel

vercel Bot commented Jun 14, 2026

Copy link
Copy Markdown

Someone is attempting to deploy a commit to the praise's projects Team on Vercel.

A member of the Team first needs to authorize it.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant