com.wordnik.swagger.models

Class Operation

java.lang.Object

com.wordnik.swagger.models.Operation

public class Operation
extends Object

Constructor Summary

Constructors

Constructor and Description
Operation()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConsumes(String consumes)
void	addParameter(Parameter parameter)
void	addProduces(String produces)
void	addResponse(String key, Response response)
void	addScheme(Scheme scheme)
void	addSecurity(String name, List<String> scopes)
void	addTag(String tag)
Operation	consumes(List<String> consumes)
Operation	consumes(String consumes)
Operation	defaultResponse(Response response)
Operation	deprecated(Boolean deprecated)
Operation	description(String description)
Operation	externalDocs(ExternalDocs externalDocs)
List<String>	getConsumes()
String	getDescription()
ExternalDocs	getExternalDocs()
String	getOperationId()
List<Parameter>	getParameters()
List<String>	getProduces()
Map<String,Response>	getResponses()
List<Scheme>	getSchemes()
List<Map<String,List<String>>>	getSecurity()
String	getSummary()
List<String>	getTags()
Map<String,Object>	getVendorExtensions()
Boolean	isDeprecated()
Operation	operationId(String operationId)
Operation	parameter(Parameter parameter)
Operation	produces(List<String> produces)
Operation	produces(String produces)
Operation	response(int key, Response response)
Operation	scheme(Scheme scheme)
Operation	schemes(List<Scheme> schemes)
Operation	security(SecurityRequirement security)
void	setConsumes(List<String> consumes)
void	setDeprecated(Boolean value)
void	setDescription(String description)
void	setExternalDocs(ExternalDocs value)
void	setOperationId(String operationId)
void	setParameters(List<Parameter> parameters)
void	setProduces(List<String> produces)
void	setResponses(Map<String,Response> responses)
void	setSchemes(List<Scheme> schemes)
void	setSecurity(List<Map<String,List<String>>> security)
void	setSummary(String summary)
void	setTags(List<String> tags)
void	setVendorExtension(String name, Object value)
Operation	summary(String summary)
Operation	tag(String tag)
Operation	tags(List<String> tags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Operation

public Operation()

Method Detail

summary

public Operation summary(String summary)

description

public Operation description(String description)

operationId

public Operation operationId(String operationId)

schemes

public Operation schemes(List<Scheme> schemes)

scheme

public Operation scheme(Scheme scheme)

consumes

public Operation consumes(List<String> consumes)

consumes

public Operation consumes(String consumes)

produces

public Operation produces(List<String> produces)

produces

public Operation produces(String produces)

security

public Operation security(SecurityRequirement security)

parameter

public Operation parameter(Parameter parameter)

response

public Operation response(int key,
                 Response response)

defaultResponse

public Operation defaultResponse(Response response)

tags

public Operation tags(List<String> tags)

tag

public Operation tag(String tag)

externalDocs

public Operation externalDocs(ExternalDocs externalDocs)

deprecated

public Operation deprecated(Boolean deprecated)

getTags

public List<String> getTags()

setTags

public void setTags(List<String> tags)

addTag

public void addTag(String tag)

getSummary

public String getSummary()

setSummary

public void setSummary(String summary)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getOperationId

public String getOperationId()

setOperationId

public void setOperationId(String operationId)

getSchemes

public List<Scheme> getSchemes()

setSchemes

public void setSchemes(List<Scheme> schemes)

addScheme

public void addScheme(Scheme scheme)

getConsumes

public List<String> getConsumes()

setConsumes

public void setConsumes(List<String> consumes)

addConsumes

public void addConsumes(String consumes)

getProduces

public List<String> getProduces()

setProduces

public void setProduces(List<String> produces)

addProduces

public void addProduces(String produces)

getParameters

public List<Parameter> getParameters()

setParameters

public void setParameters(List<Parameter> parameters)

addParameter

public void addParameter(Parameter parameter)

getResponses

public Map<String,Response> getResponses()

setResponses

public void setResponses(Map<String,Response> responses)

addResponse

public void addResponse(String key,
               Response response)

getSecurity

public List<Map<String,List<String>>> getSecurity()

setSecurity

public void setSecurity(List<Map<String,List<String>>> security)

addSecurity

public void addSecurity(String name,
               List<String> scopes)

getExternalDocs

public ExternalDocs getExternalDocs()

setExternalDocs

public void setExternalDocs(ExternalDocs value)

isDeprecated

public Boolean isDeprecated()

setDeprecated

public void setDeprecated(Boolean value)

getVendorExtensions

public Map<String,Object> getVendorExtensions()

setVendorExtension

public void setVendorExtension(String name,
                      Object value)