<commit_before>package stroom.pipeline.refdata;

import stroom.pipeline.refdata.store.RefStoreEntry;
import stroom.pipeline.refdata.store.RefStreamProcessingInfo;
import stroom.util.shared.ResourcePaths;
import stroom.util.shared.RestResource;

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

import java.util.List;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;

@Tag(name = "Reference Data")
@Path(ReferenceDataResource.BASE_PATH)
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface ReferenceDataResource extends RestResource {

    String BASE_PATH = "/refData" + ResourcePaths.V1;

    String ENTRIES_SUB_PATH = "/entries";
    String REF_STREAM_INFO_SUB_PATH = "/refStreamInfo";
    String LOOKUP_SUB_PATH = "/lookup";
    String PURGE_SUB_PATH = "/purge";

    @GET
    @Path(ENTRIES_SUB_PATH)
    @Operation(
            summary = "List entries from the reference data store on the node called.",
            description = "This is primarily intended  for small scale debugging in non-production environments. If " +
                    "no limit is set a default limit is applied else the results will be limited to limit entries.",
            operationId = "getReferenceStoreEntries")
    List<RefStoreEntry> entries(@QueryParam("limit") final Integer limit,
                                @QueryParam("refStreamId") final Long refStreamId,
                                @QueryParam("mapName") final String mapName);

    @GET
    @Path(REF_STREAM_INFO_SUB_PATH)
    @Operation(
            summary = "List processing info entries for all ref streams",
            description = "This is primarily intended  for small scale debugging in non-production environments. If " +
                    "no limit is set a default limit is applied else the results will be limited to limit entries.",
            operationId = "getReferenceStreamProcessingInfoEntries")
    List<RefStreamProcessingInfo> refStreamInfo(@QueryParam("limit") final Integer limit,
                                                @QueryParam("refStreamId") final Long refStreamId,
                                                @QueryParam("mapName") final String mapName);

    @POST
    @Path(LOOKUP_SUB_PATH)
    @Operation(
            summary = "Perform a reference data lookup using the supplied lookup request.",
            operationId = "lookupReferenceData")
    String lookup(@Valid @NotNull final RefDataLookupRequest refDataLookupRequest);

    @DELETE
    @Path(PURGE_SUB_PATH + "/{purgeAge}")
    @Operation(
            summary = "Explicitly delete all entries that are older than purgeAge.",
            operationId = "purgeReferenceData")
    boolean purge(@NotNull @PathParam("purgeAge") final String purgeAge);
}<commit_msg>Update resource description<commit_after>package stroom.pipeline.refdata;

import stroom.pipeline.refdata.store.RefStoreEntry;
import stroom.pipeline.refdata.store.RefStreamProcessingInfo;
import stroom.util.shared.ResourcePaths;
import stroom.util.shared.RestResource;

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

import java.util.List;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;

@Tag(name = "Reference Data")
@Path(ReferenceDataResource.BASE_PATH)
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface ReferenceDataResource extends RestResource {

    String BASE_PATH = "/refData" + ResourcePaths.V1;

    String ENTRIES_SUB_PATH = "/entries";
    String REF_STREAM_INFO_SUB_PATH = "/refStreamInfo";
    String LOOKUP_SUB_PATH = "/lookup";
    String PURGE_SUB_PATH = "/purge";

    @GET
    @Path(ENTRIES_SUB_PATH)
    @Operation(
            summary = "List entries from the reference data store on the node called.",
            description = "This is primarily intended  for small scale debugging in non-production environments. If " +
                    "no limit is set a default limit is applied else the results will be limited to limit entries.",
            operationId = "getReferenceStoreEntries")
    List<RefStoreEntry> entries(@QueryParam("limit") final Integer limit,
                                @QueryParam("refStreamId") final Long refStreamId,
                                @QueryParam("mapName") final String mapName);

    @GET
    @Path(REF_STREAM_INFO_SUB_PATH)
    @Operation(
            summary = "List processing info entries for all ref streams",
            description = "This is primarily intended  for small scale debugging in non-production environments. If " +
                    "no limit is set a default limit is applied else the results will be limited to limit entries.",
            operationId = "getReferenceStreamProcessingInfoEntries")
    List<RefStreamProcessingInfo> refStreamInfo(@QueryParam("limit") final Integer limit,
                                                @QueryParam("refStreamId") final Long refStreamId,
                                                @QueryParam("mapName") final String mapName);

    @POST
    @Path(LOOKUP_SUB_PATH)
    @Operation(
            summary = "Perform a reference data lookup using the supplied lookup request. " +
                    "Reference data will be loaded if required using the supplied reference pipeline.",
            operationId = "lookupReferenceData")
    String lookup(@Valid @NotNull final RefDataLookupRequest refDataLookupRequest);

    @DELETE
    @Path(PURGE_SUB_PATH + "/{purgeAge}")
    @Operation(
            summary = "Explicitly delete all entries that are older than purgeAge.",
            operationId = "purgeReferenceData")
    boolean purge(@NotNull @PathParam("purgeAge") final String purgeAge);
}
{'fraction_non_alphanumeric': 0.08739708676377454, 'fraction_numerical': 0.0009499683343888537, 'mean_word_length': 3.1179921773142114, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2657072', 'n_tokens_mistral': 1690, 'n_tokens_neox': 1657, 'n_words': 470}