Script to fix OpenAPI documentation

Author: tisnik

Makefile

@@ -36,8 +36,10 @@ 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
+openapi-doc:	docs/openapi.json scripts/fix_openapi_doc.py	## Generate OpenAPI documentation
+	openapi-to-markdown --input_file docs/openapi.json --output_file output.md
+	python3 scripts/fix_openapi_doc.py <  output.md > docs/output.md
+	rm output.md
 
 # TODO uv migration
 requirements.txt:	pyproject.toml pdm.lock ## Generate requirements.txt file containing hashes for all non-devel packages

scripts/fix_openapi_doc.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+
+"""Filter to fix the generated OpenAPI documentation."""
+
+import fileinput
+
+TABLE_ROW_CONTINUATION_LINE = " |"
+
+lines = list(fileinput.input())
+
+lines_count = len(lines)
+
+for i in range(lines_count):
+    current_line = lines[i].rstrip("\r\n")
+
+    # limit check
+    if i == lines_count - 1:
+        print(current_line)
+        break
+
+    # the next line must exists -> read it
+    next_line = lines[i + 1].rstrip("\r\n")
+
+    # skip the continuation line as it was used already
+    # during previous line processing
+    if current_line == TABLE_ROW_CONTINUATION_LINE:
+        continue
+
+    # check if table row continuation line is present
+    if next_line == TABLE_ROW_CONTINUATION_LINE:
+        print(current_line + TABLE_ROW_CONTINUATION_LINE)
+    else:
+        print(current_line)