fi.metatavu.soteapi.server.rest.api.EventsApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of soteapi-spec Show documentation
Show all versions of soteapi-spec Show documentation
Specifications for Sote API
package fi.metatavu.soteapi.server.rest.api;
import java.util.UUID;
import fi.metatavu.soteapi.server.rest.model.*;
import javax.ws.rs.*;
import javax.ws.rs.core.Response;
import java.io.File;
import java.time.OffsetDateTime;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import java.util.Map;
import java.util.List;
import javax.validation.constraints.*;
import javax.validation.Valid;
@Path("/events")
@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaJAXRSSpecServerCodegen", date = "2019-05-02T19:05:47.365+03:00[Europe/Helsinki]")
public interface EventsApi {
@GET
@Path("/{eventId}")
@Produces({ "application/json;charset=utf-8" })
@Operation(summary = "Finds event", description = "Finds single event ", tags={ "Events" })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Returns a single event", content = @Content(schema = @Schema(implementation = Event.class))),
@ApiResponse(responseCode = "400", description = "Invalid request was sent to the server", content = @Content(schema = @Schema(implementation = BadRequest.class))),
@ApiResponse(responseCode = "403", description = "Attempted to make a call with unauthorized client", content = @Content(schema = @Schema(implementation = Forbidden.class))),
@ApiResponse(responseCode = "500", description = "Internal server error", content = @Content(schema = @Schema(implementation = InternalServerError.class))) })
Response findEvent( @PathParam("eventId")
@Parameter(description = "event id") Long eventId
);
@GET
@Produces({ "application/json;charset=utf-8" })
@Operation(summary = "Lists events", description = "Lists events ", tags={ "Events" })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Returns a list of events", content = @Content(array = @ArraySchema(schema = @Schema(implementation = Event.class)))),
@ApiResponse(responseCode = "400", description = "Invalid request was sent to the server", content = @Content(schema = @Schema(implementation = BadRequest.class))),
@ApiResponse(responseCode = "403", description = "Attempted to make a call with unauthorized client", content = @Content(schema = @Schema(implementation = Forbidden.class))),
@ApiResponse(responseCode = "500", description = "Internal server error", content = @Content(schema = @Schema(implementation = InternalServerError.class))) })
Response listEvents( @QueryParam("endsAfter")
String endsAfter
, @QueryParam("startsBefore")
String startsBefore
, @QueryParam("categorySlug")
@Parameter(description = "Filter by category slug") String categorySlug
, @QueryParam("firstResult")
@Parameter(description = "First result") Long firstResult
, @QueryParam("maxResults")
@Parameter(description = "Max results") Long maxResults
);}