import org.lastaflute.web.validation.Required;

/**
 * The download form for protected words dictionary.
 * This form is used for downloading protected words dictionary files from the admin interface.
 *
 */
public class DownloadForm {

    /**
     * Dictionary ID for identifying the protected words dictionary to download.
     */
    @Required
    public String dictId;

    /**

 *   <li>{@code ELEVATE_WORD_TAGS} - The key for elevate word tags.</li>
 *   <li>{@code ELEVATE_WORD_ROLES} - The key for elevate word roles.</li>
 * </ul>
 *
 * <p>Methods:</p>
 * <ul>
 *   <li>{@code get()} - Retrieves an array of elevate words from the settings.</li>
 *   <li>{@code add(ElevateWord elevateWord)} - Adds a new elevate word to the settings.</li>

/**
 * The BadWordSettings class manages the settings related to bad words.
 * It allows adding, deleting, and retrieving bad words from the settings.
 * It also supports loading default bad words from a file.
 */
public class BadWordSettings {
    private static final Logger logger = LogManager.getLogger(BadWordSettings.class);

    /** Key for bad word settings. */
    public static final String BAD_WORD_SETTINGS_KEY = "badword";

    /**
     * Gets a specific protected words item by ID.
     * @param dictId the dictionary ID
     * @param id the item ID
     * @return the protected words item if found
     */
    public OptionalEntity<ProtwordsItem> getProtwordsItem(final String dictId, final long id) {
        return getProtwordsFile(dictId).map(file -> file.get(id).get());
    }

    /**
     * Stores a protected words item (insert or update).

/**
 * Form for uploading protected words files to the Fess search engine.
 * Protected words are terms that should not be stemmed or modified during text analysis.
 * This form is used in the admin interface to upload custom protected words dictionary files.
 */
public class UploadForm {

    /**
     * The dictionary ID that identifies which protected words dictionary configuration to update.

public interface ContentsParser {
    /**
     * Parses the given search words and creates a SuggestItem.
     *
     * @param words the array of search words
     * @param readings the array of readings corresponding to the search words
     * @param fields the array of fields associated with the search words
     * @param tags the array of tags associated with the search words
     * @param roles the array of roles associated with the search words

import org.opensearch.transport.client.Client;

/**
 * Represents a request for popular words. This class extends {@link Request} and is parameterized
 * with {@link PopularWordsResponse}. It allows specifying various criteria for retrieving popular words,
 * such as index, size, tags, roles, fields, languages, and exclusion words.
 *
 * <p>Key functionalities include:</p>
 * <ul>
 *   <li>Setting the target index for the search.</li>

import org.lastaflute.web.validation.theme.conversion.ValidateTypeFailure;

/**
 * Form class for editing protected words dictionary entries in the admin interface.
 * This form extends CreateForm to include fields necessary for updating existing protected words entries.
 * Protected words are terms that should not be stemmed or modified during text analysis.
 *
 */
public class EditForm extends CreateForm {

    /**

     *
     * @param word        The elevate word.
     * @param reading     The reading of the word.
     * @param tags        The tags associated with the word.
     * @param permissions The permissions for the word.
     * @param boost       The boost value for the word.
     * @param apply       true to apply the changes immediately.
     */

import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;

import io.restassured.RestAssured;
import io.restassured.path.json.JsonPath;

/**
 * Integration tests for the Popular Words API (/api/v1/popular-words)
 */
@Tag("it")
public class PopularWordsApiTests extends ITBase {

    @BeforeAll
    protected static void initAll() {
        RestAssured.baseURI = getFessUrl();
        settingTestToken();