org.lockss.laaws.poller.api.PeersApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of laaws-poller Show documentation

LOCKSS Poller Service

There is a newer version: 2.7.1

/**
 * NOTE: This class is auto generated by the swagger code generator program (2.4.18).
 * https://github.com/swagger-api/swagger-codegen
 * Do not edit the class manually.
 */
package org.lockss.laaws.poller.api;

import org.lockss.ws.entities.PeerWsResult;
import io.swagger.annotations.*;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.multipart.MultipartFile;

import javax.validation.Valid;
import javax.validation.constraints.*;
import java.util.List;

@Api(value = "peers", description = "the peers API")
@RequestMapping(value = "")
public interface PeersApi {

    PeersApiDelegate getDelegate();

    @ApiOperation(value = "Query for peer properties", nickname = "getPeers", notes = "Query for peers that meet a set of specified conditions", response = PeerWsResult.class, responseContainer = "List", authorizations = {
        @Authorization(value = "basicAuth")
    }, tags={ "service", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Information about the requested peers", response = PeerWsResult.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Bad Request"),
        @ApiResponse(code = 401, message = "Unauthorized"),
        @ApiResponse(code = 500, message = "Internal Server Error") })
    @RequestMapping(value = "/peers",
        produces = { "application/json" }, 
        method = RequestMethod.GET)
    default ResponseEntity> getPeers(@NotNull @ApiParam(value = "The query that specifies the peers to be returned", required = true) @Valid @RequestParam(value = "peerQuery", required = true) String peerQuery) {
        return getDelegate().getPeers(peerQuery);
    }

}