Sebastián Ramírez <******@****.***> 1731896744 +0100

Rishat-F <******@****.***> 1737747871 +0300

Sebastián Ramírez <******@****.***> 1731896744 +0100

## Documentation Deprecate a *Path Operation* - OpenAPI { #documentation-deprecate-a-path-operation-openapi }

To deprecate a *path operation*, and show it in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Deprecation](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank}.

## Convert any Data to JSON-compatible { #convert-any-data-to-json-compatible }

```

...eso es porque el generador del cliente usa el **operation ID** interno de OpenAPI para cada *path operation*.

OpenAPI requiere que cada operation ID sea único a través de todas las *path operations*, por lo que FastAPI usa el **nombre de la función**, el **path**, y el **método/operación HTTP** para generar ese operation ID, porque de esa manera puede asegurarse de que los operation IDs sean únicos.

## Documentar la Deprecación de una *Path Operation* - OpenAPI

Para deprecar una *path operation*, y mostrarla en la interfaz de usuario de la documentación, lee la documentación para [Tutorial - Configuraciones de Path Operation - Deprecación](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank}.

## Convertir cualquier Dato a Compatible con JSON

Es solo una función que puede tomar todos los mismos parámetros que una *path operation function* puede tomar:

{* ../../docs_src/dependencies/tutorial001_an_py310.py hl[8:9] *}

Eso es todo.

**2 líneas**.

Y tiene la misma forma y estructura que todas tus *path operation functions*.

Puedes pensar en ella como una *path operation function* sin el "decorador" (sin el `@app.get("/some-path")`).

    // MS-SWN RPC Operation Numbers
    /** WitnessRegister operation number */
    public static final int WITNESS_REGISTER = 0;
    /** WitnessUnregister operation number */
    public static final int WITNESS_UNREGISTER = 1;
    /** WitnessAsyncNotify operation number */
    public static final int WITNESS_ASYNC_NOTIFY = 2;
    /** Witness heartbeat operation number */

    }

    /**
     * Get total number of RDMA read operations
     *
     * @return read operation count
     */
    public long getRdmaReads() {
        return rdmaReads.get();
    }

    /**
     * Get total number of RDMA write operations
     *
     * @return write operation count
     */
    public long getRdmaWrites() {
        return rdmaWrites.get();
    }

```

...that's because the client generator uses the OpenAPI internal **operation ID** for each *path operation*.

OpenAPI requires that each operation ID is unique across all the *path operations*, so FastAPI uses the **function name**, the **path**, and the **HTTP method/operation** to generate that operation ID, because that way it can make sure that the operation IDs are unique.

But I'll show you how to improve that next. 🤓