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

platforms/ide/ide-native/         @gradle/bt-tide @gradle/bt-jvm

# Documentation
platforms/documentation/          @gradle/bt-docs-reviewers

platforms/documentation/docs/src/snippets/kotlinDsl/                                                        @gradle/bt-docs-reviewers @gradle/bt-tide

The same way, you can declare any other parameter as normally, and additionally, get the `Request` too.

///

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

You can read more details about the <a href="https://www.starlette.dev/requests/" class="external-link" target="_blank">`Request` object in the official Starlette documentation site</a>.

/// note | Technical Details

You could also use `from starlette.requests import Request`.

          args: >
            --no-progress --offline '**/*.md' --include-fragments
            --exclude-path 'platforms/documentation/docs/src/docs/release/notes.md'
            --exclude-path 'platforms/documentation/docs/src/docs/release/notes-template.md'
            --exclude-path 'platforms/documentation/docs/src/docs/kotlin/Module.md'

* **Existing code**: British English spellings in existing code should be updated opportunistically when those areas are modified, unless constrained by backward compatibility
* **Documentation**: Documentation should be updated to use American English, prioritizing user-facing documentation

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 }

though we use GitHub-flavored Markdown for internal documentation too.

You can generate docs by running `./gradlew :docs:docs`.
This will build the whole documentation locally in [platforms/documentation](./platforms/documentation).
For more commands and examples, including local development,
see [this guide](./platforms/documentation/docs/README.md).

### Creating commits and writing commit messages

This is incredibly helpful while developing and debugging code that interacts with your API.

///

## Documentation { #documentation }

And when you open your browser at <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>, you will see an automatic, interactive, API documentation like:

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

/// check

-->
```release-note

```

#### Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

<!--
This section can be blank if this pull request does not require a release note.

When adding links which point to resources within git repositories, like
KEPs or supporting documentation, please reference a specific commit and avoid

* **Facile** : Conçu pour être facile à utiliser et à apprendre. Moins de temps passé à lire la documentation.
* **Concis** : Diminue la duplication de code. De nombreuses fonctionnalités liées à la déclaration de chaque paramètre. Moins de bugs.
* **Robuste** : Obtenez un code prêt pour la production. Avec une documentation interactive automatique.