# ADR-0006 - Use of Provider APIs in Gradle

## Status

- ACCEPTED on 2024-06-21

## Context

        String[] fields = { "api1", "api2", "api1", "api3", "api2" };
        queryFieldConfig.setApiResponseFields(fields);

        // Set should contain unique values only
        assertEquals(3, queryFieldConfig.apiResponseFieldSet.size());
        assertTrue(queryFieldConfig.apiResponseFieldSet.contains("api1"));
        assertTrue(queryFieldConfig.apiResponseFieldSet.contains("api2"));

3. **Gradually migrate** from GSA query format to Fess's native API

**Alternative Approach**: Instead of relying on GSA API compatibility, we recommend migrating client applications to use Fess's modern JSON API (`/api/v1/documents`), which provides more features and better performance.

---

### Google Site Search (GSS) / Google Custom Search (GSE)

platforms/documentation/docs/src/docs/userguide/reference/dsl-apis/kotlin_dsl.adoc                          @gradle/bt-docs-reviewers @gradle/bt-tide
platforms/documentation/docs/src/docs/userguide/reference/dsl-apis/migrating_from_groovy_to_kotlin_dsl.adoc @gradle/bt-docs-reviewers @gradle/bt-tide

    protected String[] acceptedRoles = { "admin" };

    /**
     * Default constructor.
     * Initializes the API manager with the admin server path prefix.
     */
    public SearchEngineApiManager() {
        super();
        setPathPrefix(ADMIN_SERVER);
    }

    /**
     * Registers this API manager with the web API manager factory.

            if (stage.specificBuilds.contains(SpecificBuild.SanityCheck)) {
                buildReportTab(
                    "API Compatibility Report",
                    "$HIDDEN_ARTIFACT_DESTINATION/report-architecture-test-binary-compatibility-report.html",
                )
                buildReportTab("Incubating APIs Report", "incubation-reports/all-incubating.html")
            }
            if (stage.performanceTests.isNotEmpty()) {

import org.codelibs.fess.it.CrawlTestBase;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;

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

/**

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

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

/**
 * Integration tests for the Favorites API (/api/v1/favorites and /api/v1/documents/{docId}/favorite)

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Order;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestMethodOrder;

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

/**
 * Integration Tests which need an execution of crawler
 * - /api/admin/joblog
 * - /api/admin/crawlinginfo

import org.codelibs.fess.app.web.CrudMode;
import org.codelibs.fess.app.web.admin.badword.UploadForm;
import org.codelibs.fess.app.web.api.ApiResult;
import org.codelibs.fess.app.web.api.ApiResult.ApiUpdateResponse;
import org.codelibs.fess.app.web.api.ApiResult.Status;
import org.codelibs.fess.app.web.api.admin.FessApiAdminAction;
import org.codelibs.fess.exception.FessSystemException;
import org.codelibs.fess.helper.SuggestHelper;