com.symphony.api.pod.SystemApi Maven / Gradle / Ivy
package com.symphony.api.pod;
import com.symphony.api.model.Error;
import com.symphony.api.model.Protocol;
import com.symphony.api.model.StringList;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.Map;
import javax.ws.rs.*;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
import org.apache.cxf.jaxrs.ext.multipart.*;
import io.swagger.v3.oas.annotations.Operation;
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;
/**
* Pod API
*
* This document refers to Symphony API calls that do not need encryption or decryption of content. - sessionToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have made no change to the system even if ome subset of the request would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X.
*
*/
@Path("/")
public interface SystemApi {
/**
* Get the full set of Symphony features available for this pod
*
*/
@GET
@Path("/v1/admin/system/features/list")
@Produces({ "application/json" })
@Operation(summary = "Get the full set of Symphony features available for this pod", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "The list of valid feature entitlement names.", content = @Content(schema = @Schema(implementation = StringList.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public StringList v1AdminSystemFeaturesListGet(@HeaderParam("sessionToken") String sessionToken);
/**
* Get a list of all URI protocols supported by the company (pod)
*
*/
@GET
@Path("/v1/admin/system/protocols/list")
@Produces({ "application/json" })
@Operation(summary = "Get a list of all URI protocols supported by the company (pod)", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success", content = @Content(schema = @Schema(implementation = StringList.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public StringList v1AdminSystemProtocolsListGet(@HeaderParam("sessionToken") String sessionToken);
/**
* Add an entry to URI protocols supported by the company (pod)
*
*/
@POST
@Path("/v1/admin/system/protocols")
@Consumes({ "application/json" })
@Produces({ "application/json" })
@Operation(summary = "Add an entry to URI protocols supported by the company (pod)", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success", content = @Content(schema = @Schema(implementation = Protocol.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public Protocol v1AdminSystemProtocolsPost(Protocol body, @HeaderParam("sessionToken") String sessionToken);
/**
* Remove an entry from URI protocols supported by the company (pod)
*
*/
@DELETE
@Path("/v1/admin/system/protocols/{scheme}")
@Produces({ "application/json" })
@Operation(summary = "Remove an entry from URI protocols supported by the company (pod)", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "204 response"),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public void v1AdminSystemProtocolsSchemeDelete(@HeaderParam("sessionToken") String sessionToken, @PathParam("scheme") String scheme);
/**
* Get a list of URI protocols supported by the company (pod)
*
*/
@GET
@Path("/v2/system/protocols")
@Produces({ "application/json" })
@Operation(summary = "Get a list of URI protocols supported by the company (pod)", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success", content = @Content(schema = @Schema(implementation = StringList.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public StringList v2SystemProtocolsGet(@HeaderParam("sessionToken") String sessionToken, @QueryParam("skip")Integer skip, @QueryParam("limit")Integer limit);
}