40 lines
1.7 KiB
Java
40 lines
1.7 KiB
Java
package com.inteligr8.alfresco.acs.api;
|
|
|
|
import com.inteligr8.alfresco.acs.model.Error;
|
|
import com.inteligr8.alfresco.acs.model.ProbeEntry;
|
|
import io.swagger.annotations.Api;
|
|
import io.swagger.annotations.ApiOperation;
|
|
import io.swagger.annotations.ApiResponse;
|
|
import io.swagger.annotations.ApiResponses;
|
|
import javax.ws.rs.*;
|
|
|
|
/**
|
|
* Alfresco Content Services REST API
|
|
*
|
|
* <p>**Core API** Provides access to the core features of Alfresco Content Services.
|
|
*
|
|
*/
|
|
@Path("/api/-default-/public/alfresco/versions/1")
|
|
@Api(value = "/api/-default-/public/alfresco/versions/1", description = "")
|
|
public interface ProbesApi {
|
|
|
|
/**
|
|
* Check readiness and liveness of the repository
|
|
*
|
|
* **Note:** this endpoint is available in Alfresco 6.0 and newer versions. Returns a status of 200 to indicate success and 503 for failure. The readiness probe is normally only used to check repository startup. The liveness probe should then be used to check the repository is still responding to requests. **Note:** No authentication is required to call this endpoint.
|
|
*
|
|
*/
|
|
@GET
|
|
@Path("/probes/{probeId}")
|
|
@Consumes({ "application/json" })
|
|
@Produces({ "application/json" })
|
|
@ApiOperation(value = "Check readiness and liveness of the repository", tags={ })
|
|
@ApiResponses(value = {
|
|
@ApiResponse(code = 200, message = "Successful response", response = ProbeEntry.class),
|
|
@ApiResponse(code = 404, message = "**probeId** does not exist "),
|
|
@ApiResponse(code = 503, message = "Service Unavailable - Probe failure status."),
|
|
@ApiResponse(code = 200, message = "Unexpected error", response = Error.class) })
|
|
public ProbeEntry getProbe(@PathParam("probeId") String probeId);
|
|
}
|
|
|