Merge pull request lightspeed-core#383 from tisnik/lcore-433-ability-to-generate-openapi-documentation

LCORE-433: ability to generate OpenAPI documentation

Author: tisnik

Makefile

@@ -37,6 +37,9 @@ format: ## Format the code into unified format
 schema:	## Generate OpenAPI schema file
 	uv run scripts/generate_openapi_schema.py docs/openapi.json
 
+openapi-doc:	docs/openapi.json	## Generate OpenAPI documentation
+	openapi-to-markdown --input_file docs/openapi.json --output_file docs/output.md
+
 # TODO uv migration
 requirements.txt:	pyproject.toml pdm.lock ## Generate requirements.txt file containing hashes for all non-devel packages
 	pdm export --prod --format requirements --output requirements.txt --no-extras --without evaluation

README.md

@@ -261,6 +261,7 @@ check-types                       Checks type hints in sources
 security-check                    Check the project for security issues
 format                            Format the code into unified format
 schema                            Generate OpenAPI schema file
+openapi-doc                       Generate OpenAPI documentation
 requirements.txt                  Generate requirements.txt file containing hashes for all non-devel packages
 shellcheck                        Run shellcheck
 verify                            Run all linters

pyproject.toml

@@ -76,6 +76,7 @@ dev = [
     "types-cachetools>=6.1.0.20250717",
     "build>=1.2.2.post1",
     "twine>=6.1.0",
+    "openapi-to-md>=0.1.0b2",
 ]
 llslibdev = [
     "fastapi>=0.115.12",