Skip to content

📝 Replace the API description by the README.md content #13

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
SebastienCozeDev merged 1 commit into from
Mar 3, 2026
Merged

📝 Replace the API description by the README.md content #13

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
12 changes: 9 additions & 3 deletions main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,16 @@
},
]

with open("README.md", "r", encoding="utf-8") as f:
readme_content = f.read()
lines = readme_content.split('\n')
roadmap_index = next((i for i, line in enumerate(lines) if "🎯 Roadmap" in line), 0)
readme_content = '\n'.join(lines[roadmap_index:])

app = FastAPI(
title="RAGE Data API",
description="An API to access RAGE data such as blip models, colors, markers, ped models, and weapons.",
summary="An API for RAGE data retrieval.",
title="⚙️ RAGE Data API",
summary="RAGE Data API allows you to retrieve useful information from video games using the RAGE game engine. This information helps, in particular, mod developers to simplify their research.",
description=readme_content,
version="0.1.1",
openapi_tags=tags_metadata,
docs_url="/",
Expand Down