Skip to content

Add miner OpenAPI spec generation #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
go165 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add miner OpenAPI spec generation #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,8 @@ engram/
|-------|-------------|
| [docs/architecture.md](docs/architecture.md) | System design, data flows, Arweave integration |
| [docs/miner.md](docs/miner.md) | Miner setup, configuration, systemd, Docker |
| [docs/openapi.json](docs/openapi.json) | OpenAPI 3.1 spec for miner HTTP endpoints |
| [docs/miner-openapi.html](docs/miner-openapi.html) | Redoc viewer for the miner HTTP API |
| [docs/validator.md](docs/validator.md) | Validator setup and scoring loop |
| [docs/sdk.md](docs/sdk.md) | Python SDK full reference |
| [docs/cli.md](docs/cli.md) | CLI command reference |
Expand Down
12 changes: 12 additions & 0 deletions docs/miner-openapi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Engram Miner HTTP API</title>
</head>
<body>
<redoc spec-url="./openapi.json"></redoc>
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
</body>
</html>
17 changes: 17 additions & 0 deletions docs/miner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,23 @@ curl http://localhost:8091/health

---

## HTTP API Reference

The miner HTTP API is documented as OpenAPI 3.1 in [`openapi.json`](openapi.json).
Browse it locally through the Redoc page at [`miner-openapi.html`](miner-openapi.html).

Regenerate the spec after changing miner routes:

```bash
python scripts/generate_openapi.py
python scripts/generate_openapi.py --check
```

The OpenAPI generator reads the same route registry used by `neurons/miner.py`,
so CI can catch stale docs when an endpoint is added, removed, or renamed.

---

## systemd Service

```ini
Expand Down
Loading