com.smartbear.swagger4j
Interface Operation

All Known Implementing Classes:
OperationImpl

public interface Operation

Holds a Swagger operation - see https://github.com/wordnik/swagger-core/wiki/API-Declaration


Nested Class Summary
static class Operation.Method
          These are the methods supported by Swagger 1.2 - more to come
 
Method Summary
 void addConsumes(String consumes)
           
 ErrorResponse addErrorResponse(int errorCode, String reason)
           
 Parameter addParameter(String name, Parameter.ParamType type)
           
 void addProduces(String produces)
           
 Collection<String> getConsumes()
           
 ErrorResponse getErrorResponse(int code)
           
 List<ErrorResponse> getErrorResponses()
           
 Operation.Method getMethod()
           
 String getNickName()
           
 String getNotes()
           
 Parameter getParameter(String name)
           
 List<Parameter> getParameters()
           
 Collection<String> getProduces()
           
 String getResponseClass()
           
 String getSummary()
           
 void removeConsumes(String consumes)
           
 void removeErrorResponse(ErrorResponse errorResponse)
           
 void removeParameter(Parameter parameter)
           
 void removeProduces(String produces)
           
 void setMethod(Operation.Method method)
           
 void setNickName(String nickName)
           
 void setNotes(String notes)
           
 void setResponseClass(String responseClass)
           
 void setSummary(String summary)
           
 

Method Detail

getMethod

Operation.Method getMethod()

setMethod

void setMethod(Operation.Method method)

getNickName

String getNickName()

setNickName

void setNickName(String nickName)

getResponseClass

String getResponseClass()

setResponseClass

void setResponseClass(String responseClass)

getSummary

String getSummary()

setSummary

void setSummary(String summary)

getNotes

String getNotes()

setNotes

void setNotes(String notes)

getProduces

Collection<String> getProduces()

removeProduces

void removeProduces(String produces)

addProduces

void addProduces(String produces)

getConsumes

Collection<String> getConsumes()

removeConsumes

void removeConsumes(String consumes)

addConsumes

void addConsumes(String consumes)

getParameters

List<Parameter> getParameters()

getParameter

Parameter getParameter(String name)

removeParameter

void removeParameter(Parameter parameter)

addParameter

Parameter addParameter(String name,
                       Parameter.ParamType type)

getErrorResponses

List<ErrorResponse> getErrorResponses()

getErrorResponse

ErrorResponse getErrorResponse(int code)

removeErrorResponse

void removeErrorResponse(ErrorResponse errorResponse)

addErrorResponse

ErrorResponse addErrorResponse(int errorCode,
                               String reason)


Copyright © 2013. All Rights Reserved.