com.github.dinuta.estuary.testrunner.api.TestApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of testrunner Show documentation
RestAPI service which runs commands and tests
The newest version!
/**
 * NOTE: This class is auto generated by the swagger code generator program (2.4.13).
 * https://github.com/swagger-api/swagger-codegen
 * Do not edit the class manually.
 */
package com.github.dinuta.estuary.testrunner.api;

import com.github.dinuta.estuary.testrunner.model.ApiResponse;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponses;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

@javax.annotation.Generated(value = "io.swagger.codegen.languages.SpringCodegen", date = "2020-06-14T18:02:50.529Z")

@Api(value = "test", description = "the test API")
@RequestMapping(value = "")
public interface TestApi {

    @ApiOperation(value = "Stops all commands/tests previously started", nickname = "testDelete", notes = "", response = ApiResponse.class, tags = {"estuary-testrunner",})
    @ApiResponses(value = {
            @io.swagger.annotations.ApiResponse(code = 200, message = "test stop success", response = ApiResponse.class),
            @io.swagger.annotations.ApiResponse(code = 404, message = "test stop failure", response = ApiResponse.class)})
    @RequestMapping(value = "/test",
            produces = {"application/json"},
            method = RequestMethod.DELETE)
    default ResponseEntity testDelete(@ApiParam(value = "") @RequestHeader(value = "Token", required = false) String token) {
        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
    }


    @ApiOperation(value = "Gets information about running tests, running processes, test status", nickname = "testGet", notes = "", response = ApiResponse.class, tags = {"estuary-testrunner",})
    @ApiResponses(value = {
            @io.swagger.annotations.ApiResponse(code = 200, message = "Get test info success", response = ApiResponse.class),
            @io.swagger.annotations.ApiResponse(code = 404, message = "Get test info failure", response = ApiResponse.class)})
    @RequestMapping(value = "/test",
            produces = {"application/json"},
            method = RequestMethod.GET)
    default ResponseEntity testGet(@ApiParam(value = "") @RequestHeader(value = "Token", required = false) String token) {
        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
    }


    @ApiOperation(value = "Starts the tests / commands in detached mode and sequentially", nickname = "testIdPost", notes = "", response = ApiResponse.class, tags = {"estuary-testrunner",})
    @ApiResponses(value = {
            @io.swagger.annotations.ApiResponse(code = 200, message = "commands start success", response = ApiResponse.class),
            @io.swagger.annotations.ApiResponse(code = 404, message = "commands start failure", response = ApiResponse.class)})
    @RequestMapping(value = "/test/{id}",
            produces = {"application/json"},
            consumes = {"text/plain"},
            method = RequestMethod.POST)
    default ResponseEntity testIdPost(@ApiParam(value = "Test id set by the user", required = true) @PathVariable("id") String id, @ApiParam(value = "List of commands to run one after the other. E.g. make/mvn/sh/npm", required = true) @Valid @RequestBody String testFileContent, @ApiParam(value = "") @RequestHeader(value = "Token", required = false) String token) {
        return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
    }

}