Skip to content

Add make docs to render OpenAPI contracts as Swagger #601

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

Merged
marcvergees merged 1 commit into from
Jul 1, 2026
Merged

Add make docs to render OpenAPI contracts as Swagger #601

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
7 changes: 6 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: help init fireform build up down logs logs-app logs-ollama shell pull-model test clean super-clean status ready-banner sync
.PHONY: help init fireform build up down logs logs-app logs-ollama shell pull-model test clean super-clean status ready-banner sync docs

COMPOSE = docker compose -f docker/dev/compose.yml --env-file docker/.env.dev
ENV_DEV = docker/.env.dev
Expand Down Expand Up @@ -31,6 +31,7 @@ help:
@echo "make shell - Open shell in running app container"
@echo "make pull-model - Pull Ollama model from .env.dev ($(OLLAMA_MODEL))"
@echo "make test - Run test suite"
@echo "make docs - Serve interactive API docs from the OpenAPI contract"
@echo "make migrate - Run pending Alembic migrations"
@echo "make migration - Generate new migration (msg='description')"
@echo "make clean - Stop containers (preserves volumes)"
Expand Down Expand Up @@ -105,6 +106,10 @@ pull-model:
test:
@$(COMPOSE) exec -T app python3 -m pytest tests/ -v

docs:
@echo "Serving Swagger UI from contracts/openapi.yaml at http://localhost:8088"
@npx --yes swagger-ui-watcher contracts/openapi.yaml --port 8088

migrate:
@$(COMPOSE) exec -T app alembic upgrade head

Expand Down
Loading