Skip to content

[docs] Add OpenAPI spec for miner HTTP endpoints#46

Open
zjwjing wants to merge 6 commits into
Dipraise1:mainfrom
zjwjing:main
Open

[docs] Add OpenAPI spec for miner HTTP endpoints#46
zjwjing wants to merge 6 commits into
Dipraise1:mainfrom
zjwjing:main

Conversation

@zjwjing

@zjwjing zjwjing commented Jun 17, 2026

Copy link
Copy Markdown

What does this PR do?

Adds OpenAPI 3.0 specification for Engram miner HTTP endpoints, enabling machine-readable API documentation for third-party clients and SDK development.

Closes #23

Changes

  • Added docs/openapi.yaml - Complete OpenAPI 3.0 spec covering 23 miner endpoints
  • Added docs/index.html - Redoc documentation page for visual API browsing

Endpoints Documented

Core Operations

  • POST /IngestSynapse - Store embedding, return CID
  • POST /QuerySynapse - ANN search, return top-K results
  • POST /ChallengeSynapse - Storage proof response
  • GET/DELETE /retrieve/{cid} - Data retrieval and deletion
  • POST /RepairSynapse, /list

Chat & Conversations

  • CRUD operations for /conversations and /chat-history

Key Share Management

  • POST /KeyShareSynapse, /KeyShareRetrieve

Namespace & Attestation

  • POST /namespace, /AttestNamespace
  • GET /attestation/{namespace}

System & Monitoring

  • GET /health, /stats, /metagraph, /metrics, /wallet-stats, /commitment
  • POST /prove-memory

How to test

# View documentation locally
cd docs && python -m http.server 8080
# Open http://localhost:8080

# Validate OpenAPI spec
python -c "import yaml; yaml.safe_load(open('docs/openapi.yaml'))"

@vercel

vercel Bot commented Jun 17, 2026

Copy link
Copy Markdown

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

A member of the Team first needs to authorize it.

@zjwjing zjwjing left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi maintainers,

I have completed all the requested changes and the PR is ready for review.

Please let me know if you need any additional modifications.

Thank you!

@zjwjing

zjwjing commented Jun 23, 2026

Copy link
Copy Markdown
Author

Hi @Dipraise1 — checking in on this PR. The OpenAPI spec is ready for review. Happy to make any changes needed. Thanks!

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.

[docs] OpenAPI spec for miner HTTP endpoints

1 participant