String CRAWLER_DOCUMENT_MAX_SITE_LENGTH = "crawler.document.max.site.length";

    /** The key of the configuration. e.g. UTF-8 */
    String CRAWLER_DOCUMENT_SITE_ENCODING = "crawler.document.site.encoding";

    /** The key of the configuration. e.g. unknown */
    String CRAWLER_DOCUMENT_UNKNOWN_HOSTNAME = "crawler.document.unknown.hostname";

    /** The key of the configuration. e.g. false */

 * This class provides comprehensive search functionality including document search,
 * scroll search, and bulk operations. It handles search request parameter processing,
 * query building, response formatting, and search log management.
 *
 * Key features:
 * - Document search with pagination and faceting
 * - Scroll search for large result sets
 * - Document retrieval by ID
 * - Bulk document updates

        };
    }

    /**
     * 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
     */

    }

    /**
     * Returns the additional data for the response.
     * @param responseData The response data.
     * @param document The document.
     * @return The additional data.
     */
    protected String getAdditionalData(final ResponseData responseData, final Document document) {
        return "";
    }

    /**
     * Returns the result data footer.
     * @return The result data footer.
     */

This code won't be executed in your app, we only need it to *document* how that *external API* should look like.

But, you already know how to easily create automatic documentation for an API with **FastAPI**.

 * <p>Strategies work with domtrip Documents for perfect formatting preservation.
 * Individual strategies can create domtrip Editors from Documents as needed:
 * <pre>
 * Editor editor = new Editor(document);
 * // ... perform domtrip operations ...
 * // Document is automatically updated
 * </pre>
 */
public interface UpgradeStrategy {

    /**
     * Applies the upgrade strategy to all eligible POMs.
     *

 */
package org.codelibs.core.xml;

import javax.xml.parsers.DocumentBuilder;

import junit.framework.TestCase;

import org.codelibs.core.io.ResourceUtil;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * @author higa
 *
 */
public class DomUtilTest extends TestCase {

    /**
     * @throws Exception
     */

        _ * classDoc.classMethods >> []
        _ * classDoc.classBlocks >> []
        _ * classDoc.classExtensions >> []
        _ * classDoc.subClasses >> []

        when:
        def result = parse('<chapter/>', document)
        withCategories {
            renderer.merge(classDoc, result)
        }

        then:
        formatTree(result) == '''<chapter>
    <section>
        <title>Properties</title>

 */
public class SuggestItem {

    /**
     * The kind of suggest item.
     */
    public enum Kind {
        /** Document kind. */
        DOCUMENT("document"),
        /** Query kind. */
        QUERY("query"),
        /** User kind. */
        USER("user");

        private final String kind;

        /**
         * Constructor for Kind.

 */
package org.codelibs.fess.app.web.api.admin.boostdoc;

import org.codelibs.fess.app.web.api.admin.BaseSearchBody;

/**
 * Search request body for boost document administration.
 * Extends BaseSearchBody with boost document-specific search parameters.
 */
public class SearchBody extends BaseSearchBody {

    /** The URL expression pattern to search for in boost documents. */
    public String urlExpr;