]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
馃寪 Add Spanish translation for `advanced/path-operation-advanced-configuration.md...
authorJuan Funez <juan.funez@gmail.com>
Sun, 4 Jul 2021 12:49:31 +0000 (14:49 +0200)
committerGitHub <noreply@github.com>
Sun, 4 Jul 2021 12:49:31 +0000 (14:49 +0200)
Co-authored-by: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
Co-authored-by: Sebasti谩n Ram铆rez <tiangolo@gmail.com>
Co-authored-by: Camila Gutierrez <mariacamilagl30@gmail.com>
docs/es/docs/advanced/path-operation-advanced-configuration.md [new file with mode: 0644]

diff --git a/docs/es/docs/advanced/path-operation-advanced-configuration.md b/docs/es/docs/advanced/path-operation-advanced-configuration.md
new file mode 100644 (file)
index 0000000..e4edcc5
--- /dev/null
@@ -0,0 +1,52 @@
+# Configuraci贸n avanzada de las operaciones de path
+
+## OpenAPI operationId
+
+!!! warning "Advertencia"
+    Si no eres una persona "experta" en OpenAPI, probablemente no necesitas leer esto.
+
+Puedes asignar el `operationId` de OpenAPI para ser usado en tu *operaci贸n de path* con el par谩metro `operation_id`.
+
+En este caso tendr铆as que asegurarte de que sea 煤nico para cada operaci贸n.
+
+```Python hl_lines="6"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial001.py!}
+```
+
+### Usando el nombre de la *funci贸n de la operaci贸n de path* en el operationId
+
+Si quieres usar tus nombres de funciones de API como `operationId`s, puedes iterar sobre todos ellos y sobrescribir `operation_id` de cada *operaci贸n de path* usando su `APIRoute.name`.
+
+Deber铆as hacerlo despu茅s de adicionar todas tus *operaciones de path*.
+
+```Python hl_lines="2 12 13 14 15 16 17 18 19 20 21 24"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
+```
+
+!!! tip "Consejo"
+    Si llamas manualmente a `app.openapi()`, debes actualizar el `operationId`s antes de hacerlo.
+
+!!! warning "Advertencia"
+    Si haces esto, debes asegurarte de que cada una de tus *funciones de las operaciones de path* tenga un nombre 煤nico.
+
+    Incluso si est谩n en diferentes m贸dulos (archivos Python).
+
+## Excluir de OpenAPI
+
+Para excluir una *operaci贸n de path* del esquema OpenAPI generado (y por tanto del la documentaci贸n generada autom谩ticamente), usa el par谩metro `include_in_schema` y asigna el valor como `False`;
+
+```Python hl_lines="6"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial003.py!}
+```
+
+## Descripci贸n avanzada desde el docstring
+
+Puedes limitar las l铆neas usadas desde el docstring de una *operaci贸n de path* para OpenAPI.
+
+Agregar un `\f` (un car谩cter de "form feed" escapado) hace que **FastAPI** trunque el output utilizada para OpenAPI en ese punto.
+
+No ser谩 mostrado en la documentaci贸n, pero otras herramientas (como Sphinx) ser谩n capaces de usar el resto.
+
+```Python hl_lines="19 20 21 22 23 24 25 26 27 28 29"
+{!../../../docs_src/path_operation_advanced_configuration/tutorial004.py!}
+```