Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 10 for externalDocs (0.26 sec)

  1. docs_src/metadata/tutorial004.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)
    
    
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Jun 13 11:58:06 GMT 2020
    - 693 bytes
    - Viewed (0)
  2. 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/",
                    },
                },
            ],
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Fri Jun 30 18:25:16 GMT 2023
    - 2K bytes
    - Viewed (0)
  3. 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, "
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 22:49:33 GMT 2024
    - 15K bytes
    - Viewed (0)
  4. docs/em/docs/tutorial/metadata.md

    ⚫️ ✊ 📇 ⚗ 1️⃣ 📖 🔠 🔖.
    
    🔠 📖 💪 🔌:
    
    * `name` (**✔**): `str` ⏮️ 🎏 📛 👆 ⚙️ `tags` 🔢 👆 *➡ 🛠️* & `APIRouter`Ⓜ.
    * `description`: `str` ⏮️ 📏 📛 🔖. ⚫️ 💪 ✔️ ✍ & 🔜 🎦 🩺 🎚.
    * `externalDocs`: `dict` 🔬 🔢 🧾 ⏮️:
        * `description`: `str` ⏮️ 📏 📛 🔢 🩺.
        * `url` (**✔**): `str` ⏮️ 📛 🔢 🧾.
    
    ### ✍ 🗃 🔖
    
    ➡️ 🔄 👈 🖼 ⏮️ 🔖 `users` & `items`.
    
    ✍ 🗃 👆 🔖 & 🚶‍♀️ ⚫️ `openapi_tags` 🔢:
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 4.2K bytes
    - Viewed (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` のタグを使った例でメタデータの追加を試してみましょう。
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 4.6K bytes
    - Viewed (0)
  6. 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.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 5.8K bytes
    - Viewed (0)
  7. docs/ru/docs/tutorial/metadata.md

    * `description`: `str`-значение с кратким описанием для тега. Может содержать Markdown и будет отображаться в UI документации.
    * `externalDocs`:  `dict`-значение описывающее внешнюю документацию. Включает в себя:
        * `description`: `str`-значение с кратким описанием для внешней документации.
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 8.3K bytes
    - Viewed (0)
  8. 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.
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Mar 30 20:25:38 GMT 2024
    - 6.6K bytes
    - Viewed (0)
  9. src/main/config/openapi/openapi-user.yaml

    info:
      title: Fess - User API
      description: |-
        This is a Fess Server based on the OpenAPI 3.0 specification.  
      license:
        name: Apache 2.0
        url: http://www.apache.org/licenses/LICENSE-2.0.html
      version: 14.8.0
    externalDocs:
      description: API Documentation
      url: https://fess.codelibs.org/14.8/api/
    servers:
      - url: http://localhost:8080/api/v1
    tags:
      - name: search
        description: Search operations
      - name: popularword
    Others
    - Registered: Mon Apr 29 08:04:11 GMT 2024
    - Last Modified: Mon Jun 19 13:30:00 GMT 2023
    - 21.6K bytes
    - Viewed (1)
  10. fastapi/applications.py

                    * `description`: A short description of the tag.
                        [CommonMark syntax](https://commonmark.org/) MAY be used for rich
                        text representation.
                    * `externalDocs`: Additional external documentation for this tag. If
                        provided, it would contain a `dict` with:
                        * `description`: A short description of the target documentation.
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 172.2K bytes
    - Viewed (0)
Back to top