Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 113 for summary (0.03 sec)

  1. docs/en/docs/how-to/general.md

    ## Documentation Summary and Description - OpenAPI { #documentation-summary-and-description-openapi }
    
    To add a summary and description to your *path operations*, and show them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Summary and Description](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank}.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 2.6K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/metadata.md

    | Parameter | Type | Description |
    |------------|------|-------------|
    | `title` | `str` | The title of the API. |
    | `summary` | `str` | A short summary of the API. <small>Available since OpenAPI 3.1.0, FastAPI 0.99.0.</small> |
    | `description` | `str` | A short description of the API. It can use Markdown. |
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 5.9K bytes
    - Viewed (0)
  3. docs/em/docs/tutorial/metadata.md

    | `version` | `string` | ⏬ 🛠️. 👉 ⏬ 👆 👍 🈸, 🚫 🗄. 🖼 `2.5.0`. |
    | `terms_of_service` | `str` | 📛 ⚖ 🐕‍🦺 🛠️. 🚥 🚚, 👉 ✔️ 📛. |
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Mon Nov 18 02:25:44 UTC 2024
    - 4.1K bytes
    - Viewed (0)
  4. docs/ru/docs/tutorial/metadata.md

    | `terms_of_service` | `str` | Ссылка к условиям пользования API. Если указано, то это должен быть URL-адрес. |
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Mon Nov 18 02:25:44 UTC 2024
    - 8.2K bytes
    - Viewed (0)
  5. docs/en/docs/tutorial/path-operation-configuration.md

    **FastAPI** supports that the same way as with plain strings:
    
    {* ../../docs_src/path_operation_configuration/tutorial002b.py hl[1,8:10,13,18] *}
    
    ## Summary and description { #summary-and-description }
    
    You can add a `summary` and `description`:
    
    {* ../../docs_src/path_operation_configuration/tutorial003_py310.py hl[18:19] *}
    
    ## Description from docstring { #description-from-docstring }
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 4.1K bytes
    - Viewed (0)
  6. docs/uk/docs/tutorial/metadata.md

    | `terms_of_service` | `str` |  URL до умов використання API. Якщо вказано, має бути у форматі URL. |
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Wed Mar 19 17:09:57 UTC 2025
    - 8.4K bytes
    - Viewed (0)
  7. docs/ko/docs/tutorial/metadata.md

    | `terms_of_service` | `str` | API 이용 약관의 URL입니다. 제공하는 경우 URL 형식이어야 합니다. |
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Mon Nov 18 02:25:44 UTC 2024
    - 6.4K bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/query-param-models.md

            {
                "type": "extra_forbidden",
                "loc": ["query", "tool"],
                "msg": "Extra inputs are not permitted",
                "input": "plumbus"
            }
        ]
    }
    ```
    
    ## Summary { #summary }
    
    You can use **Pydantic models** to declare **query parameters** in **FastAPI**. 😎
    
    /// tip
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 2.2K bytes
    - Viewed (0)
  9. docs/es/docs/tutorial/metadata.md

    | `contact` | `dict` | La información de contacto para la API expuesta. Puede contener varios campos. <details><summary><code>contact</code> fields</summary><table><thead><tr><th>Parámetro</th><th>Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><code>name</code></td><td><code>str</code></td><td>El nombre identificativo de la persona/organización de contacto.</td></tr><tr><...
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Mon Dec 30 18:26:57 UTC 2024
    - 6.1K bytes
    - Viewed (0)
  10. docs/de/docs/tutorial/metadata.md

    | `contact` | `dict` | Die Kontaktinformationen für die verfügbar gemachte API. Kann mehrere Felder enthalten. <details><summary><code>contact</code>-Felder</summary><table><thead><tr><th>Parameter</th><th>Typ</th><th>Beschreibung</th></tr></thead><tbody><tr><td><code>name</code></td><td><code>str</code></td><td>Der identifizierende Name der Kontaktperson/Organisation.</td></tr><tr><td><cod...
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Mon Nov 18 02:25:44 UTC 2024
    - 6.5K bytes
    - Viewed (0)
Back to top