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

import org.lastaflute.web.util.LaRequestUtil;

import jakarta.servlet.http.HttpServletRequest;

/**
 * Utility class for document data manipulation and type conversion.
 * This class provides static methods for extracting typed values from document maps,
 * URL encoding, and other document-related operations. It's designed as a final
 * utility class with only static methods.
 *
 */
public final class DocumentUtil {

    }

    /**
     * Deletes document words (words with DOC_FREQ >= 1 that don't have QUERY or USER kinds).
     *
     * @param index The index name
     * @return The SuggestDeleteResponse
     */
    public SuggestDeleteResponse deleteDocumentWords(final String index) {
        if (logger.isInfoEnabled()) {
            logger.info("Deleting document words: index={}", index);
        }

    //                                                                      ==============

    /**
     * Returns the OSDD document.
     *
     * @return the OSDD document as a stream response
     */
    @Execute
    public ActionResponse index() {
        if (isLoginRequired()) {
            return redirectToLogin();
        }

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

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

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

    /**
     * Default constructor.
     */

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

                SuggestItem.Kind.DOCUMENT);
    }

    private SuggestItem createItemWithTags(String text, String... tags) {
        String[] texts = { text };
        String[][] readings = { { "reading" } };
        String[] fields = { "field" };

        return new SuggestItem(texts, readings, fields, 1L, 1L, 1.0f, tags, new String[0], new String[0], SuggestItem.Kind.DOCUMENT);
    }

 * Typically used when a document or resource is not available during crawling or indexing.
 */
public class ContentNotFoundException extends FessSystemException {

    private static final long serialVersionUID = 1L;

    /**
     * Constructs a new ContentNotFoundException with the specified parent URL and URL.
     *
     * @param parentUrl the URL of the parent document

    assert "Error processing docs/lang/docs/doc.md" in result.output
    assert (
        "Number of headers with permalinks does not match the number "
        "in the original document (5 vs 4)"
    ) in result.output


@pytest.mark.parametrize(
    "copy_test_files",
    [(f"{data_path}/en_doc.md", f"{data_path}/translated_doc_number_lt.md")],
    indirect=True,
)

    Fail if the number or level of headers does not match the original.
    """

    modified_text: list[str] = text.copy()

    if len(header_permalinks) != len(original_header_permalinks):
        raise ValueError(
            "Number of headers with permalinks does not match the number in the "
            "original document "