## Résumé et description de la documentation - OpenAPI { #documentation-summary-and-description-openapi }

Pour ajouter un résumé et une description à vos *chemins d'accès* et les afficher dans l'interface utilisateur de la documentation, lisez les documents [Tutoriel - Configurations de chemin d'accès - Résumé et description](../tutorial/path-operation-configuration.md#summary-and-description).

## Resumo e Descrição da documentação - OpenAPI { #documentation-summary-and-description-openapi }

Para adicionar um resumo e uma descrição às suas *operações de rota* e exibi-los na UI da documentação, leia a documentação de [Tutorial - Configurações da Operação de Rota - Resumo e Descrição](../tutorial/path-operation-configuration.md#summary-and-description).

## Resumen y Descripción de Documentación - OpenAPI { #documentation-summary-and-description-openapi }

Para agregar un resumen y descripción a tus *path operations*, y mostrarlos en la interfaz de usuario de la documentación, lee la documentación para [Tutorial - Configuraciones de Path Operation - Resumen y Descripción](../tutorial/path-operation-configuration.md#summary-and-description).

**FastAPI** le prend en charge de la même manière qu'avec des chaînes simples :

{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *}

## Ajouter un résumé et une description { #summary-and-description }

Vous pouvez ajouter un `summary` et une `description` :

{* ../../docs_src/path_operation_configuration/tutorial003_py310.py hl[17:18] *}

Como `stored_item_model.model_copy(update=update_data)`:

{* ../../docs_src/body_updates/tutorial002_py310.py hl[33] *}

### Resumen de actualizaciones parciales { #partial-updates-recap }

En resumen, para aplicar actualizaciones parciales deberías:

* (Opcionalmente) usar `PATCH` en lugar de `PUT`.
* Recuperar los datos almacenados.
* Poner esos datos en un modelo de Pydantic.

**FastAPI** soporta eso de la misma manera que con strings normales:

{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *}

## Resumen y Descripción { #summary-and-description }

Puedes añadir un `summary` y `description`:

{* ../../docs_src/path_operation_configuration/tutorial003_py310.py hl[17:18] *}

* `version` : La version de votre API, p. ex. `2.5.0`.
* `openapi_version` : La version de la spécification OpenAPI utilisée. Par défaut, la plus récente : `3.1.0`.
* `summary` : Un court résumé de l'API.
* `description` : La description de votre API ; elle peut inclure du markdown et sera affichée dans la documentation.

## Résumé { #recap }

Esto no es una limitación de **FastAPI**, es parte del protocolo HTTP.

///

## Resumen { #recap }

### Resumen { #summary }

Solía decir que no me gustaba mucho la historia... y mírame ahora dando lecciones de "historia tecnológica". 😅