import org.codelibs.fess.suggest.request.Response;

/**
 * Represents the response of a suggest index operation.
 * This class contains information about the number of suggest documents,
 * the number of input documents, any errors that occurred during the operation,
 * and the time taken to complete the operation.
 */
public class SuggestIndexResponse implements Response {
    /** The number of suggest documents. */

You can set the *path operation decorator* parameter `response_model_exclude_unset=True`:

{* ../../docs_src/response_model/tutorial004_py310.py hl[22] *}

and those default values won't be included in the response, only the values actually set.

So, if you send a request to that *path operation* for the item with ID `foo`, the response (not including default values) will be:

    /** The requested operation was unsuccessful */
    int NT_STATUS_UNSUCCESSFUL = 0xC0000001;
    /** The requested operation is not implemented */
    int NT_STATUS_NOT_IMPLEMENTED = 0xC0000002;
    /** The specified information class is invalid */
    int NT_STATUS_INVALID_INFO_CLASS = 0xC0000003;
    /** Invalid access to memory location */
    int NT_STATUS_ACCESS_VIOLATION = 0xC0000005;
    /** The handle is invalid */

servers:
  - url: http://localhost:8080/api/v1
tags:
  - name: search
    description: Search operations
  - name: popularword
    description: Popular word operations
  - name: monitor
    description: Monitoring operations
  - name: suggest
    description: Suggest operations
  - name: favorite
    description: Favorite operations
paths:
  /documents:
    get:
      tags:
        - search

        @Test
        @DisplayName("delete operation should work correctly")
        void testDelete() throws CIFSException {
            // When/Then
            assertDoesNotThrow(() -> mockResource.delete(), "Delete operation should not throw exception");
            verify(mockResource).delete();
        }

        @Test
        @DisplayName("copy operation should work correctly")

import org.apache.maven.api.services.Request;
import org.apache.maven.api.services.Result;

/**
 * Exception thrown when a batch request operation fails. This exception contains the results
 * of all requests that were attempted, including both successful and failed operations.
 * <p>
 * The exception provides access to detailed results through {@link #getResults()}, allowing
 * callers to determine which specific requests failed and why.

    end
    dep ->> operation: Run dependency, e.g. DB session
    opt raise
        operation -->> dep: Raise HTTPException
        dep -->> handler: Auto forward exception
        handler -->> client: HTTP error response
        operation -->> dep: Raise other exception
        dep -->> handler: Auto forward exception
    end
    operation ->> client: Return response to client

```mermaid
sequenceDiagram

participant client as Client
participant handler as Exception handler
participant dep as Dep with yield
participant operation as Path Operation
participant tasks as Background tasks

    Note over client,operation: Puede lanzar excepciones, incluyendo HTTPException
    client ->> dep: Iniciar request
    Note over dep: Ejecutar código hasta yield
    opt raise Exception

        dep -->> dep: Raise other exception
    end
    dep ->> operation: Run dependency, e.g. DB session
    opt raise
        operation -->> handler: Raise HTTPException
        handler -->> client: HTTP error response
        operation -->> dep: Raise other exception
    end
    operation ->> client: Return response to client
    Note over client,operation: Response is already sent, can't change it anymore
    opt Tasks

Swagger UI lo manejará detrás de escena para ti, pero necesita este auxiliar de "redirección".

///

### Crea una *path operation* para probarlo

Ahora, para poder probar que todo funciona, crea una *path operation*:

{* ../../docs_src/custom_docs_ui/tutorial001.py hl[36:38] *}

### Pruébalo