stage: Stage,
) : OsAwareBaseGradleBuildType(os = Os.LINUX, stage = stage, failStage = false, init = {
        id("${model.projectId}_CheckLinks")
        name = "CheckLinks"
        description = "Check links in documentations"

        applyDefaults(
            model,
            this,
            ":docs:checkLinks",
            extraParameters =
                listOf(
                    buildScanTagParam("CheckLinks"),

## Documentation automatique

Les schémas JSON de vos modèles seront intégrés au schéma OpenAPI global de votre application, et seront donc affichés dans la documentation interactive de l'API :

<img src="/img/tutorial/body/image01.png">

Et seront aussi utilisés dans chaque *opération de chemin* de la documentation utilisant ces modèles :

## Beschreibung der Response in der Dokumentation – OpenAPI { #documentation-response-description-openapi }

* `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.

### Metadaten für Tags erstellen { #create-metadata-for-tags }

Para personalizar la URL de OpenAPI (o eliminarla), lee la documentación para [Tutorial - Metadatos y URLs de Documentación](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}.

## URLs de Documentación de OpenAPI { #openapi-docs-urls }

Esto es increíblemente útil mientras desarrollas y depuras código que interactúa con tu API.

///

## Documentación { #documentation }

Y cuando abras tu navegador en <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>, verás una documentación de API automática e interactiva como:

<img src="/img/tutorial/path-params/image01.png">

/// check | Revisa

///

## Dokumentation { #documentation }

Wenn Sie die Seite <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a> in Ihrem Browser öffnen, sehen Sie eine automatische, interaktive API-Dokumentation:

<img src="/img/tutorial/path-params/image01.png">

/// check | Testen

///

## Documentación de `Request` { #request-documentation }

Puedes leer más detalles sobre el <a href="https://www.starlette.dev/requests/" class="external-link" target="_blank">objeto `Request` en el sitio de documentación oficial de Starlette</a>.

/// note | Detalles Técnicos

Podrías también usar `from starlette.requests import Request`.

Sie können das Attribut `model_config` verwenden, das ein <abbr title="Dictionary – Zuordnungstabelle: In anderen Sprachen auch Hash, Map, Objekt, Assoziatives Array genannt">`dict`</abbr> akzeptiert, wie beschrieben in <a href="https://docs.pydantic.dev/latest/api/config/" class="external-link" target="_blank">Pydantic-Dokumentation: Configuration</a>.

Wenn Sie zur **API-Dokumentations-UI** unter `/docs` gehen, können Sie die **Dokumentation** zu Cookies für Ihre *Pfadoperationen* sehen.