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 }

///

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

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

{* ../../docs_src/path_operation_configuration/tutorial002_py310.py hl[15,20,25] *}

Diese werden zum OpenAPI-Schema hinzugefügt und von den automatischen Dokumentations-Benutzeroberflächen verwendet:

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

### Tags mittels Enumeration { #tags-with-enums }

///

## `Request`-Dokumentation { #request-documentation }

Weitere Details zum <a href="https://www.starlette.dev/requests/" class="external-link" target="_blank">`Request`-Objekt finden Sie in der offiziellen Starlette-Dokumentation</a>.

/// note | Technische Details

Sie können auch `from starlette.requests import Request` verwenden.

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

### Crear metadata para etiquetas { #create-metadata-for-tags }