/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech) (5.3.1).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.openslx.bwlp.sat.api.handler;
import java.util.UUID;
import io.swagger.annotations.*;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.multipart.MultipartFile;
import javax.validation.Valid;
import javax.validation.constraints.*;
import java.util.List;
import java.util.Map;
import java.util.Optional;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.SpringCodegen", date = "2021-12-23T15:12:42.264617368+01:00[Europe/Berlin]")
@Validated
@Api(value = "do", description = "the do API")
public interface DoApi {
default Optional<NativeWebRequest> getRequest() {
return Optional.empty();
}
/**
* POST /do/delete-images : Delete old images on the bwLehrpool-Server
*
* @return Successful operation (status code 200)
* or Failed to delete old images (status code 500)
*/
@ApiOperation(value = "Delete old images on the bwLehrpool-Server", nickname = "doDeleteOldImagesOnFileserver", notes = "", tags={ "server", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Successful operation"),
@ApiResponse(code = 500, message = "Failed to delete old images") })
@RequestMapping(
method = RequestMethod.POST,
value = "/do/delete-images",
produces = { "text/plain" }
)
default ResponseEntity<Void> doDeleteOldImagesOnFileserver() {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
/**
* POST /do/mailtest : Send a test mail from the bwLehrpool-Server
*
* @param host Domain of SMTP mail server (required)
* @param port Port of SMTP mail server (required)
* @param ssl Encryption mode for the SMTP mail server (required)
* @param serverName Name of the SMTP mail server (required)
* @param username Username for the SMTP mail server (required)
* @param password Password for the SMTP mail server (required)
* @param senderAddress Sender address for the test mail (required)
* @param recipient Recipient for the test mail (required)
* @param replyTo Reply-To address for the test mail (required)
* @return Successful operation (status code 200)
* or Failed to send test mail (status code 400)
*/
@ApiOperation(value = "Send a test mail from the bwLehrpool-Server", nickname = "doMailtestOnFileserver", notes = "", tags={ "server", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Successful operation"),
@ApiResponse(code = 400, message = "Failed to send test mail") })
@RequestMapping(
method = RequestMethod.POST,
value = "/do/mailtest",
produces = { "text/plain" }
)
default ResponseEntity<Void> doMailtestOnFileserver(@NotNull @ApiParam(value = "Domain of SMTP mail server", required = true) @Valid @RequestParam(value = "host", required = true) String host
,@NotNull @ApiParam(value = "Port of SMTP mail server", required = true) @Valid @RequestParam(value = "port", required = true) Integer port
,@NotNull @ApiParam(value = "Encryption mode for the SMTP mail server", required = true, allowableValues = "NONE, IMPLICIT, EXPLICIT") @Valid @RequestParam(value = "ssl", required = true) String ssl
,@NotNull @ApiParam(value = "Name of the SMTP mail server", required = true) @Valid @RequestParam(value = "serverName", required = true) String serverName
,@NotNull @ApiParam(value = "Username for the SMTP mail server", required = true) @Valid @RequestParam(value = "username", required = true) String username
,@NotNull @ApiParam(value = "Password for the SMTP mail server", required = true) @Valid @RequestParam(value = "password", required = true) String password
,@NotNull @ApiParam(value = "Sender address for the test mail", required = true) @Valid @RequestParam(value = "senderAddress", required = true) String senderAddress
,@NotNull @ApiParam(value = "Recipient for the test mail", required = true) @Valid @RequestParam(value = "recipient", required = true) String recipient
,@NotNull @ApiParam(value = "Reply-To address for the test mail", required = true) @Valid @RequestParam(value = "replyTo", required = true) String replyTo
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
/**
* POST /do/query-image-check : Query image check on the bwLehrpool-Server
*
* @param versionid Query image check for specified image version (optional)
* @return Successful operation (status code 200)
* or Failed to query image check (status code 500)
*/
@ApiOperation(value = "Query image check on the bwLehrpool-Server", nickname = "doQueryImageCheckOnFileserver", notes = "", tags={ "server", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Successful operation"),
@ApiResponse(code = 500, message = "Failed to query image check") })
@RequestMapping(
method = RequestMethod.POST,
value = "/do/query-image-check",
produces = { "application/json" }
)
default ResponseEntity<Void> doQueryImageCheckOnFileserver(@ApiParam(value = "Query image check for specified image version") @Valid @RequestParam(value = "versionid", required = false) UUID versionid
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
/**
* POST /do/reset-mail-templates : Rest mail templates on the bwLehrpool-Server
*
* @return Successful operation (status code 200)
* or Failed to reset mail templates (status code 500)
*/
@ApiOperation(value = "Rest mail templates on the bwLehrpool-Server", nickname = "doResetMailTemplatesOnFileserver", notes = "", tags={ "server", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Successful operation"),
@ApiResponse(code = 500, message = "Failed to reset mail templates") })
@RequestMapping(
method = RequestMethod.POST,
value = "/do/reset-mail-templates",
produces = { "text/plain" }
)
default ResponseEntity<Void> doResetMailTemplatesOnFileserver() {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
/**
* POST /do/scan-orphaned-files : Scan orphaned files on the bwLehrpool-Server
*
* @param action Action for orphaned files (optional)
* @return Successful operation (status code 200)
* or Failed to scan orphaned files (status code 500)
*/
@ApiOperation(value = "Scan orphaned files on the bwLehrpool-Server", nickname = "doScanOrphanedFilesOnFileserver", notes = "", tags={ "server", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Successful operation"),
@ApiResponse(code = 500, message = "Failed to scan orphaned files") })
@RequestMapping(
method = RequestMethod.POST,
value = "/do/scan-orphaned-files",
produces = { "application/json" }
)
default ResponseEntity<Void> doScanOrphanedFilesOnFileserver(@ApiParam(value = "Action for orphaned files", allowableValues = "delete") @Valid @RequestParam(value = "action", required = false) String action
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
/**
* POST /do/start-image-check : Start image check on the bwLehrpool-Server
*
* @param versionid Image version for the image check (required)
* @param hash Check hashes of images (required)
* @param update Update state of images (required)
* @return Successful operation (status code 200)
* or Failed to start image check (status code 500)
*/
@ApiOperation(value = "Start image check on the bwLehrpool-Server", nickname = "doStartImageCheckOnFileserver", notes = "", tags={ "server", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Successful operation"),
@ApiResponse(code = 500, message = "Failed to start image check") })
@RequestMapping(
method = RequestMethod.POST,
value = "/do/start-image-check",
produces = { "text/plain" }
)
default ResponseEntity<Void> doStartImageCheckOnFileserver(@NotNull @ApiParam(value = "Image version for the image check", required = true) @Valid @RequestParam(value = "versionid", required = true) UUID versionid
,@NotNull @ApiParam(value = "Check hashes of images", required = true) @Valid @RequestParam(value = "hash", required = true) Boolean hash
,@NotNull @ApiParam(value = "Update state of images", required = true) @Valid @RequestParam(value = "update", required = true) Boolean update
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
}
