Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 17 for externalDocs (0.06 seconds)

  1. docs_src/metadata/tutorial004_py39.py

            "description": "Operations with users. The **login** logic is also here.",
        },
        {
            "name": "items",
            "description": "Manage items. So _fancy_ they have their own docs.",
            "externalDocs": {
                "description": "Items external docs",
                "url": "https://fastapi.tiangolo.com/",
            },
        },
    ]
    
    app = FastAPI(openapi_tags=tags_metadata)
    
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 20:41:43 GMT 2025
    - 693 bytes
    - Click Count (0)
  2. fastapi/openapi/models.py

        # Ref: OpenAPI 3.1.0: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object
        # Schema Object
        discriminator: Optional[Discriminator] = None
        xml: Optional[XML] = None
        externalDocs: Optional[ExternalDocumentation] = None
        example: Annotated[
            Optional[Any],
            typing_deprecated(
                "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 15.1K bytes
    - Click Count (0)
  3. tests/test_tutorial/test_metadata/test_tutorial004.py

                },
                {
                    "name": "items",
                    "description": "Manage items. So _fancy_ they have their own docs.",
                    "externalDocs": {
                        "description": "Items external docs",
                        "url": "https://fastapi.tiangolo.com/",
                    },
                },
            ],
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 20:41:43 GMT 2025
    - 2K bytes
    - Click Count (0)
  4. docs/ru/docs/tutorial/metadata.md

    * `description`: `str`-значение с кратким описанием для тега. Может содержать Markdown и будет отображаться в UI документации.
    * `externalDocs`:  `dict`-значение описывающее внешнюю документацию. Включает в себя:
        * `description`: `str`-значение с кратким описанием для внешней документации.
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 20:41:43 GMT 2025
    - 9.3K bytes
    - Click Count (0)
  5. docs/ja/docs/tutorial/metadata.md

    それぞれのタグ毎にひとつの辞書を含むリストをとります。
    
    それぞれの辞書は以下をもつことができます:
    
    * `name` (**必須**): *path operations* および `APIRouter` の `tags` パラメーターで使用するのと同じタグ名である `str`。
    * `description`: タグの簡単な説明文である `str`。 Markdownで記述でき、ドキュメントUIに表示されます。
    * `externalDocs`: 外部ドキュメントを説明するための `dict`:
        * `description`: 外部ドキュメントの簡単な説明文である `str`。
        * `url` (**必須**): 外部ドキュメントのURLである `str`。
    
    ### タグのためのメタデータの作成
    
    `users` と `items` のタグを使った例でメタデータの追加を試してみましょう。
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Mon Nov 18 02:25:44 GMT 2024
    - 4.5K bytes
    - Click Count (0)
  6. docs/uk/docs/tutorial/metadata.md

    * `description`: `str` з коротким описом тегу. Може містити Markdown і буде відображено в інтерфейсі документації.
    * `externalDocs`: `dict` який описує зовнішню документацію з такими полями:
        * `description`: `str` з коротким описом зовнішньої документації.
        * `url` (**обов'язково**): `str`з URL-адресою зовнішньої документації.
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Mar 19 17:09:57 GMT 2025
    - 8.4K bytes
    - Click Count (0)
  7. docs/en/docs/tutorial/metadata.md

    * `description`: a `str` with a short description for the tag. It can have Markdown and will be shown in the docs UI.
    * `externalDocs`: a `dict` describing external documentation with:
        * `description`: a `str` with a short description for the external docs.
        * `url` (**required**): a `str` with the URL for the external documentation.
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 20:41:43 GMT 2025
    - 5.9K bytes
    - Click Count (0)
  8. docs/pt/docs/tutorial/metadata.md

    * `description`: uma `str` com uma breve descrição da tag. Pode conter Markdown e será exibido na interface de documentação.
    * `externalDocs`: um `dict` descrevendo a documentação externa com:
        * `description`: uma `str` com uma breve descrição da documentação externa.
        * `url` (**obrigatório**): uma `str` com a URL da documentação externa.
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 20:41:43 GMT 2025
    - 6.3K bytes
    - Click Count (0)
  9. docs/de/docs/tutorial/metadata.md

    * `description`: ein `str` mit einer kurzen Beschreibung für das Tag. Sie kann Markdown enthalten und wird in der Benutzeroberfläche der Dokumentation angezeigt.
    * `externalDocs`: ein `dict`, das externe Dokumentation beschreibt mit:
        * `description`: ein `str` mit einer kurzen Beschreibung für die externe Dokumentation.
        * `url` (**erforderlich**): ein `str` mit der URL für die externe Dokumentation.
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 20:41:43 GMT 2025
    - 6.9K bytes
    - Click Count (0)
  10. docs/es/docs/tutorial/metadata.md

    * `description`: un `str` con una breve descripción de la etiqueta. Puede tener Markdown y se mostrará en la interfaz de documentación.
    * `externalDocs`: un `dict` que describe documentación externa con:
        * `description`: un `str` con una breve descripción para la documentación externa.
        * `url` (**requerido**): un `str` con la URL para la documentación externa.
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 20:41:43 GMT 2025
    - 6.4K bytes
    - Click Count (0)
Back to Top