Skip to content

docs: Auto-generated OpenAPI spec for miner HTTP endpoints (Fixes #23) #52

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
shadow6427 wants to merge 2 commits into
base: main
Choose a base branch
from
+678 −0
Open

docs: Auto-generated OpenAPI spec for miner HTTP endpoints (Fixes #23) #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24bc048
docs: Add OpenAPI 3 spec for miner endpoints
shadow6427 Jun 21, 2026
eef752b
docs: Auto-generate OpenAPI spec and add CI sync check
shadow6427 Jun 21, 2026
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
28 changes: 28 additions & 0 deletions .github/workflows/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: OpenAPI Sync Check

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
check-openapi:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.10"
cache: 'pip'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pyyaml pydantic numpy

- name: Verify OpenAPI sync
run: |
python scripts/generate_openapi.py --check
Loading