Skip to content

docs(api): Change /docs to /api for API display #238

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
maxachis merged 1 commit into from
Apr 17, 2025
Merged

docs(api): Change /docs to /api for API display #238

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
6 changes: 6 additions & 0 deletions api/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import aiohttp
import uvicorn
from fastapi import FastAPI
from starlette.responses import RedirectResponse

from api.routes.annotate import annotate_router
from api.routes.batch import batch_router
Expand Down Expand Up @@ -110,10 +111,15 @@
app = FastAPI(
title="Source Collector API",
description="API for collecting data sources",
docs_url='/api',
version="0.1.0",
lifespan=lifespan
)

@app.get("/docs", include_in_schema=False)
async def redirect_docs():

Check warning on line 120 in api/main.py

View workflow job for this annotation

GitHub Actions / flake8

[flake8] api/main.py#L120 <103> 

Missing docstring in public function
Raw output 
./api/main.py:120:1: D103 Missing docstring in public function
return RedirectResponse(url="/api")


routers = [
root_router,
Expand Down