Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 12 for externalDocs (0.07 seconds)

The search processing time has exceeded the limit. The displayed results may be partial.

  1. 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: Discriminator | None = None
        xml: XML | None = None
        externalDocs: ExternalDocumentation | None = None
        example: Annotated[
            Any | None,
            typing_deprecated(
                "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 15 11:44:39 GMT 2026
    - 14.2K bytes
    - Click Count (0)
  2. docs/zh-hant/docs/tutorial/metadata.md

    它接收一個 list,其中每個標籤對應一個 dictionary。
    
    每個 dictionary 可包含:
    
    * `name`(**必填**):一個 `str`,其值需與你在路徑操作與 `APIRouter`s 的 `tags` 參數中使用的標籤名稱相同。
    * `description`:一個 `str`,為該標籤的簡短描述。可使用 Markdown,並會顯示在文件介面中。
    * `externalDocs`:一個 `dict`,描述外部文件,包含:
        * `description`:一個 `str`,外部文件的簡短描述。
        * `url`(**必填**):一個 `str`,外部文件的 URL。
    
    ### 建立標籤的中繼資料 { #create-metadata-for-tags }
    
    我們用 `users` 與 `items` 兩個標籤來示範。
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 17:05:38 GMT 2026
    - 5.6K bytes
    - Click Count (0)
  3. docs/ja/docs/tutorial/metadata.md

    それぞれのタグごとに1つの辞書を含むリストを取ります。
    
    それぞれの辞書は以下を含められます:
    
    * `name` (**必須**): *path operation* および `APIRouter` の `tags` パラメータで使用するのと同じタグ名の `str`。
    * `description`: タグの短い説明の `str`。Markdownを含められ、ドキュメントUIに表示されます。
    * `externalDocs`: 外部ドキュメントを説明する `dict`。以下を含みます:
        * `description`: 外部ドキュメントの短い説明の `str`。
        * `url` (**必須**): 外部ドキュメントのURLの `str`。
    
    ### タグのメタデータの作成 { #create-metadata-for-tags }
    
    `users` と `items` のタグを使った例で試してみましょう。
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 14:07:17 GMT 2026
    - 6.9K bytes
    - Click Count (0)
  4. docs/ko/docs/tutorial/metadata.md

    리스트는 각 태그에 대해 하나의 딕셔너리를 포함합니다.
    
    각 딕셔너리에는 다음이 포함될 수 있습니다:
    
    * `name` (**필수**): *경로 처리* 및 `APIRouter`의 `tags` 매개변수에서 사용하는 태그 이름과 동일한 `str`입니다.
    * `description`: 태그에 대한 간단한 설명을 담은 `str`입니다. 마크다운을 포함할 수 있으며 문서 UI에 표시됩니다.
    * `externalDocs`: 외부 문서를 설명하는 `dict`이며:
        * `description`: 외부 문서에 대한 간단한 설명을 담은 `str`입니다.
        * `url` (**필수**): 외부 문서의 URL을 담은 `str`입니다.
    
    ### 태그에 대한 메타데이터 생성 { #create-metadata-for-tags }
    
    `users` 및 `items`에 대한 태그 예시로 시도해 보겠습니다.
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 14:06:26 GMT 2026
    - 6.6K bytes
    - Click Count (0)
  5. fastapi/openapi/utils.py

            output["components"] = components
        output["paths"] = paths
        if webhook_paths:
            output["webhooks"] = webhook_paths
        if tags:
            output["tags"] = tags
        if external_docs:
            output["externalDocs"] = external_docs
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 15 11:44:39 GMT 2026
    - 25.6K bytes
    - Click Count (0)
  6. docs/ru/docs/tutorial/metadata.md

    * `description`: `str`-значение с кратким описанием для тега. Может содержать Markdown и будет отображаться в UI документации.
    * `externalDocs`:  `dict`-значение описывающее внешнюю документацию. Включает в себя:
        * `description`: `str`-значение с кратким описанием для внешней документации.
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 17:56:20 GMT 2026
    - 9.2K bytes
    - Click Count (0)
  7. docs/tr/docs/tutorial/metadata.md

    * `description`: tag için kısa bir açıklama içeren `str`. Markdown içerebilir ve doküman arayüzünde gösterilir.
    * `externalDocs`: harici dokümanları tanımlayan bir `dict`:
        * `description`: harici dokümanlar için kısa açıklama içeren `str`.
        * `url` (**zorunlu**): harici dokümantasyonun URL'sini içeren `str`.
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 07:53:17 GMT 2026
    - 6.2K bytes
    - Click Count (0)
  8. CHANGELOG/CHANGELOG-1.36.md

    - Kubectl explain: when a schema or field includes an externalDocs section, it is now displayed as:
      
      
          EXTERNAL DOCS:
              <description>
              URL: <url>
      
      
      This appears after the DESCRIPTION block for top-level resources and
      after the field description for individual fields. The section is
    Created: Fri Apr 03 09:05:14 GMT 2026
    - Last Modified: Thu Mar 19 23:38:00 GMT 2026
    - 142.1K bytes
    - Click Count (0)
  9. 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 Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 18:20:43 GMT 2026
    - 6.2K bytes
    - Click Count (0)
  10. docs/fr/docs/tutorial/metadata.md

    * `description` : un `str` avec une courte description pour le tag. Il peut contenir du Markdown et sera affiché dans l’interface utilisateur de la documentation.
    * `externalDocs` : un `dict` décrivant une documentation externe avec :
        * `description` : un `str` avec une courte description pour la documentation externe.
        * `url` (**requis**) : un `str` avec l’URL de la documentation externe.
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 18:37:13 GMT 2026
    - 6.6K bytes
    - Click Count (0)
Back to Top