[Python] Changing schema name in OpenAPI docs generated by FastAPI

I'm using FastAPI to create backend for my project. I have a method that allows to upload a file. I implemented it as follows:

from fastapi import APIRouter, UploadFile, File

from app.models.schemas.files import FileInResponse

router = APIRouter()


@router.post("", name="files:create-file", response_model=FileInResponse)
async def create(file: UploadFile = File(...)) -> FileInResponse:
pass


As you can see, I use a dedicated pydantic model for a method result—FileInResponse:

from pathlib import Path

from pydantic import BaseModel


class FileInResponse(BaseModel):
path: Path


And I follow this naming pattern for models (naming models as <Entity>InCreate, <Entity>InResponse, and so on) throughout the API. However, I couldn't create a pydantic model with a field of the type File, so I had to declare it directly in the route definition (i.e. without a model containing it). As a result, I have this long auto generated name Body_files_create_file_api_files_post in the OpenAPI docs:



Is there a way to change the schema name?

Continue reading...