///

### Documenta en OpenAPI y sobrescribe `Response`

Si quieres sobrescribir el response desde dentro de la función pero al mismo tiempo documentar el "media type" en OpenAPI, puedes usar el parámetro `response_class` Y devolver un objeto `Response`.

El `response_class` solo se usará para documentar el OpenAPI *path operation*, pero tu `Response` se usará tal cual.

Dessa forma:

* Este código de status será retornado na resposta.
* Será documentado como tal no esquema OpenAPI (e, portanto, nas interfaces do usuário):

<img src="/img/tutorial/response-status-code/image01.png">

/// note | Nota

Alguns códigos de resposta (consulte a próxima seção) indicam que a resposta não possui um corpo.

O FastAPI sabe disso e produzirá documentos OpenAPI informando que não há corpo de resposta.

///

    //                                                                      ==============
    /**
     * Handles document redirection requests.
     * Validates the document ID, logs click events if enabled, and redirects
     * to the target URL or serves file content directly if configured.
     *
     * @param form the go form containing document ID and tracking parameters
     * @return action response for redirection or content streaming

```Python
q: Union[str, None] = Query(default=None, max_length=50)
```

Cela va valider les données, montrer une erreur claire si ces dernières ne sont pas valides, et documenter le paramètre dans le schéma `OpenAPI` de cette *path operation*.

## Rajouter plus de validation

Vous pouvez aussi rajouter un second paramètre `min_length` :

 * the number of total, document, and query words.
 */
public class SuggestBody extends SuggestForm {
    /**
     * Constructs a new suggest body.
     */
    public SuggestBody() {
        // do nothing
    }

    /** The total number of words in the suggest index. */
    public Long totalWordsNum;

    /** The number of words from documents. */
    public Long documentWordsNum;

        // Default constructor
    }

    /**
     * Enable or disable incremental crawling.
     * When enabled, only new or modified documents are crawled.
     */
    @Size(max = 10)
    public String incrementalCrawling;

    /**
     * Number of days to keep crawled documents before cleanup.
     * Set to -1 to disable automatic cleanup.
     */
    @Required
    @Min(-1)
    @Max(1000)
    @ValidateTypeFailure

        };
    }

    /**
     * Parses a search hit from OpenSearch and converts it to a document map.
     *
     * @param fessConfig the Fess configuration
     * @param hlPrefix the highlight prefix for field names
     * @param searchHit the search hit to parse
     * @return the parsed document as a map
     */

labels.dict_stopwords_button_download = Download
labels.dict_stopwords_button_upload = Upload
labels.dict_stopwords_file = Stopwords File
labels.boost_document_rule_configuration=Document Boost
labels.boost_document_rule_title_details=Document Boost
labels.boost_document_rule_list_url_expr=Condition
labels.boost_document_rule_url_expr=Condition
labels.boost_document_rule_boost_expr=Boost Expression

                // Simulate storing documents
                Map<String, Object> doc1 = new HashMap<>();
                doc1.put("id", "1");
                doc1.put("title", "Document 1");
                callback.store(initParamMap, doc1);

                Map<String, Object> doc2 = new HashMap<>();
                doc2.put("id", "2");
                doc2.put("title", "Document 2");

## Escribir el código de documentación del callback

Este código no se ejecutará en tu aplicación, solo lo necesitamos para *documentar* cómo debería verse esa *API externa*.

Pero, ya sabes cómo crear fácilmente documentación automática para una API con **FastAPI**.