Deprecar una path operation

Deprecar una pieza de código sucede cuando:

1. Se encuentra un mejor método mas eficiente para resolver un problema que nosotros ya tenemos. Lo que hacemos no es eliminar dicho método si no la dejamos sin efecto. Para aprovechar el código posteriormente si lo requerimos nuevamente.
2. Una funcionalidad diferente de nuestro código a la que ya tenemos definidos.
3. Cuando se esta realizando una refactorización profunda del código, debido a que no tiene las mejores practicas, se define deprecar las path operation que se tienen por otras nuevas y se reemplazan. Nota: Siempre es mejor mantener el código que modificarlo desde cero.

Deprecar:
Es un termino generalmente aplicado al software y significa que ese recurso ha sido reemplazado en favor de algo mas nuevo, su uso ya no es recomendado o ya no tiene soporte. Uno hace esto (deprecar) cuando planea eliminar ese recurso, pero hacerlo es peligroso por el hecho de que ya es conocido por el publico.

@app.post(
    path='/post-image',
    status_code=status.HTTP_200_OK,
    tags=['Upload'], 
    summary='Upload image',
)
def post_image(
    image: UploadFile = File(...)
): 
    """
    #Upload Image

    Args:
        image -> Image to upload

    Returns:
        Type of the image and it´s weight
    """
    return {
    #getting the name of the file
    'filename': image.filename,
    #show the type of image
    'format': image.content_type,
    #convert bytes to kb
    'size(kb)': round(len(image.file.read()) / 1024, 2)
}

Tip profesional: Rara vez harás algo desde 0. Es mejor leer el código que ya hizo otra persona y trabajar sobre él.

Facundo dice la verdad, lo digo desde mi experiencia jajaaj

Me gusto este nuevo concepto lo sumo ahora para cuando me juegue con mis amigos y mi esposa, Los voy a deprecar… jajajajajaaj

No se le puede decir directamente “Depreciar”?
Al final que este obsoleto es una pérdida de valor

Marcar una Path Operation como Deprecated es indicar que está obsoleta y ya hay una nueva forma de hacer la misma operación.
Las funciones Deprecated serán removidas de la API luego de cierto tiempo, quienes no hayan prestado atención y adaptado sus implementaciones a tiempo se arriesgan a que su aplicación deje de funcionar correctamente.

Para deprecar una path operation se agrega el parámetro deprecated al path operation decorator asignándole el valor True.

@app.get(
    path='/person/detail',
    status_code=status.HTTP_200_OK,
    tags=['Persons'],
    deprecated=True
    )