Search code examples
pythonswaggerfastapi

fastapi swagger interface showing operation level options override server options


I have been recently finding a popup that tells me some operation level options override the global server options:

As per image:

enter image description here

I do not understand whether this is a bug in my application or anything but normal. I would not like to show the user that message.

EDIT:

This is my main.py file:

from fastapi import FastAPI,Depends
from ml.model_recommendation import predict_intention
from ml.training_ml import create_ml
import crud,models,schemas
from db import SessionLocal,engine
from sqlalchemy.orm import Session
from typing import Optional
from enum import Enum
import numpy as np

app = FastAPI(title="ML prediction",description="API to serve data used for prediction of intended remediation date (IRD)")

class Tags(Enum):
    ITEMS = "Retrieve ITSO and Software Versions"
    DELETE = "Delete Data"
    INSERT = "Get IRD predictions"
    DOWNLOAD = "Download Data"


@app.on_event("startup")
def on_startup():
    models.Base.metadata.create_all(bind=engine)

# Dependency
def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()


@app.get(
    "/service_owners/",
    response_model=list[schemas.Evergreen],
    tags=[Tags.ITEMS]
)
def read_owners(service_owner: str ,software_product_version_name: Optional[str] = None,db: Session = Depends(get_db),skip: int = 0, limit: int = 100):
    owners = crud.get_service_owners(db,service_owner=service_owner,software_product_version_name=software_product_version_name,skip=skip,limit=limit)
    return owners

This is my crud.py function:

import models
from sqlalchemy.orm import Session
from sqlalchemy import select
from typing import Optional

def get_service_owners(db: Session, service_owner: str,software_product_version_name: Optional[str] = None,skip: int = 0, limit: int = 100):
    if software_product_version_name:
        stmt = (select(models.Evergreen.service_owner,models.Evergreen.software_product_version_name)
                .where(models.Evergreen.service_owner.ilike(f'%{service_owner}%'))
                .where(models.Evergreen.software_product_version_name.ilike(f'%{software_product_version_name}%'))
                ).distinct().offset(skip).limit(limit)
            
        return db.execute(stmt).all()
    
    stmt = select(models.Evergreen.service_owner,models.Evergreen.software_product_version_name).where(models.Evergreen.service_owner.ilike(f'%{service_owner}%')).distinct().offset(skip).limit(limit)
    return db.execute(stmt).all()

And this my schema.py for validation:

from typing import Optional
from pydantic import BaseModel
from typing_extensions import TypedDict

class Evergreen(BaseModel):
    service_owner: Optional[str]
    software_product_version_name: Optional[str]

    class Config:
        from_attributes = True

class Items(TypedDict):
    service_owner: str 
    software_product_version_name: str 

class Pred(TypedDict):
    service_owner: str
    software_product_version_name: str 
    future_expectation: int 

Solution

  • This option seem to appear for OAS 3.1 documents. This must be a bug in swagger-ui. Although servers are not overridden on operation level, swagger-ui defaults to '/' and always displays the override.