For the more details, see the implementation code in [GsaApiManager](/src/main/java/org/codelibs/fess/api/gsa/GsaApiManager.java).

    }

    /**
     * Deletes documents matching the given query from the search index.
     *
     * @param body the search parameters defining which documents to delete
     * @return JSON response containing the count of deleted documents
     */
    // DELETE /api/admin/searchlist/query
    @Execute
    public JsonResponse<ApiResult> delete$query(final SearchBody body) {
        validateApi(body, messages -> {});

        });

    }

    /**
     * Sets up the search conditions for retrieving file authentication configurations.
     * This method configures the query conditions and ordering for the database query.
     *
     * @param cb the condition bean for building the query
     * @param fileAuthenticationPager the pager containing search criteria
     */

    }

    /**
     * Gets the search query string that was used to generate these results.
     *
     * @return the search query string
     */
    public String getSearchQuery() {
        return searchQuery;
    }

    /**
     * Sets the search query string that was used to generate these results.
     *
     * @param searchQuery the search query string
     */

And it can return anything you want.

In this case, this dependency expects:

* An optional query parameter `q` that is a `str`.
* An optional query parameter `skip` that is an `int`, and by default is `0`.
* An optional query parameter `limit` that is an `int`, and by default is `100`.

And then it just returns a `dict` containing those values.

/// info

    /**
     * Default constructor.
     */
    public SearchBody() {
        super();
    }

    /** Search term for key matching */
    public String term;

    /** Query pattern for key matching */
    public String query;

 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.codelibs.fess.query;

import org.codelibs.fess.unit.UnitFessTestCase;
import org.opensearch.index.query.QueryBuilders;

public class DefaultQueryBuilderTest extends UnitFessTestCase {
    public void test_invalid_null() {
        try {
            new DefaultQueryBuilder(null);

{* ../../docs_src/request_files/tutorial001_an_py39.py hl[9] *}

/// info | Informação

`File` é uma classe que herda diretamente de `Form`.

Mas lembre-se que quando você importa `Query`,`Path`, `File`, entre outros, do `fastapi`, essas são na verdade funções que retornam classes especiais.

///

/// tip | Dica

import org.codelibs.fess.app.web.admin.relatedquery.EditForm;

/**
 * Request body class for related query edit operations in the admin REST API.
 * This class extends EditForm to inherit the necessary form validation and binding capabilities
 * for related query management operations.
 */
public class EditBody extends EditForm {

    /**
     * Default constructor.
     */

    * It depends on the `query_extractor`, and assigns the value returned by it to the parameter `q`.
* It also declares an optional `last_query` cookie, as a `str`.
    * If the user didn't provide any query `q`, we use the last query used, which we saved to a cookie before.

## Use the dependency { #use-the-dependency }

Then we can use the dependency with:

{* ../../docs_src/dependencies/tutorial005_an_py310.py hl[23] *}