uk.gov.gchq.gaffer.rest.controller.IGraphConfigurationController Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-rest Show documentation
There is a newer version: 2.3.1
/*
 * Copyright 2020-2023 Crown Copyright
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package uk.gov.gchq.gaffer.rest.controller;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;

import org.springframework.web.bind.annotation.RequestMapping;

import uk.gov.gchq.gaffer.store.StoreTrait;
import uk.gov.gchq.gaffer.store.schema.Schema;

import java.util.Map;
import java.util.Set;

import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
import static org.springframework.http.MediaType.TEXT_PLAIN_VALUE;
import static org.springframework.web.bind.annotation.RequestMethod.GET;

@Tag(name = "config")
@RequestMapping("/graph/config")
public interface IGraphConfigurationController {

    @RequestMapping(
            path = "/schema",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets the schema"
    )
    Schema getSchema();

    @RequestMapping(
            path = "/description",
            method = GET,
            produces = TEXT_PLAIN_VALUE
    )
    @Operation(
            summary = "Gets the graph description"
    )
    String getDescription();

    @RequestMapping(
            path = "/graphId",
            method = GET,
            produces = TEXT_PLAIN_VALUE
    )
    @Operation(
            summary = "Gets the graph Id"
    )
    String getGraphId();

    @RequestMapping(
            path = "/filterFunctions",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets the available filter functions"
    )
    Set getFilterFunctions();

    @RequestMapping(
            path = "/elementGenerators",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets the available element generators"
    )
    Set getElementGenerators();

    @RequestMapping(
            path = "/filterFunctions/{inputClass}",
            produces = APPLICATION_JSON_VALUE,
            method = GET
    )
    @Operation(
            summary = "Gets the available filter functions for a given input class"
    )
    Set getFilterFunctions(final String inputClass);

    @RequestMapping(
            path = "/objectGenerators",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets the available object generators"
    )
    Set getObjectGenerators();

    @RequestMapping(
            path = "/serialisedFields/{className}",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets the serialised fields for a given class"
    )
    Set getSerialisedFields(final String className);

    @RequestMapping(
            path = "/serialisedFields/{className}/classes",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets the serialised fields and their classes for a given class"
    )
    Map getSerialisedFieldClasses(final String className);

    @RequestMapping(
            path = "/storeType",
            method = GET,
            produces = TEXT_PLAIN_VALUE
    )
    @Operation(
            summary = "Gets the store type"
    )
    String getStoreType();

    @RequestMapping(
            path = "/storeTraits",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets all store traits supported by this store"
    )
    Set getStoreTraits();

    @RequestMapping(
            path = "/transformFunctions",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets the available transform functions"
    )
    Set getTransformFunctions();

    @RequestMapping(
            path = "/aggregationFunctions",
            method = GET,
            produces = APPLICATION_JSON_VALUE
    )
    @Operation(
            summary = "Gets the available aggregation functions"
    )
    Set getAggregationFunctions();
}