Package springfox.documentation.service

Class Operation

java.lang.Object

springfox.documentation.service.Operation

All Implemented Interfaces:

org.springframework.core.Ordered

public class Operation
extends java.lang.Object
implements org.springframework.core.Ordered

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor

Description

Operation(org.springframework.http.HttpMethod method, java.lang.String summary, java.lang.String notes, ExternalDocumentation externalDocumentation, ModelReference responseModel, java.lang.String uniqueId, int position, java.util.Set<java.lang.String> tags, java.util.Set<java.lang.String> produces, java.util.Set<java.lang.String> consumes, java.util.Set<java.lang.String> protocol, java.util.List<SecurityReference> securityReferences, java.util.List<Parameter> parameters, java.util.Set<ResponseMessage> responseMessages, java.lang.String deprecated, boolean isHidden, java.util.Collection<VendorExtension> vendorExtensions, java.util.Set<RequestParameter> requestParameters, RequestBody body, java.util.Set<Response> responses)

Method Summary

Modifier and Type	Method	Description
RequestBody	getBody()
java.util.Set<java.lang.String>	getConsumes()
java.lang.String	getDeprecated()
ExternalDocumentation	getExternalDocumentation()
org.springframework.http.HttpMethod	getMethod()
java.lang.String	getNotes()
int	getOrder()
java.util.List<Parameter>	getParameters()
int	getPosition()
java.util.Set<java.lang.String>	getProduces()
java.util.Set<java.lang.String>	getProtocol()
java.util.SortedSet<RequestParameter>	getQueryParameters()
java.util.Set<RequestParameter>	getRequestParameters()
java.util.Set<ResponseMessage>	getResponseMessages()	Deprecated.
ModelReference	getResponseModel()	Deprecated.
java.util.SortedSet<Response>	getResponses()
java.util.Map<java.lang.String,java.util.List<AuthorizationScope>>	getSecurityReferences()
java.lang.String	getSummary()
java.util.Set<java.lang.String>	getTags()
java.lang.String	getUniqueId()
java.util.List<VendorExtension>	getVendorExtensions()
boolean	isHidden()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Operation

public Operation(org.springframework.http.HttpMethod method,
                 java.lang.String summary,
                 java.lang.String notes,
                 ExternalDocumentation externalDocumentation,
                 ModelReference responseModel,
                 java.lang.String uniqueId,
                 int position,
                 java.util.Set<java.lang.String> tags,
                 java.util.Set<java.lang.String> produces,
                 java.util.Set<java.lang.String> consumes,
                 java.util.Set<java.lang.String> protocol,
                 java.util.List<SecurityReference> securityReferences,
                 java.util.List<Parameter> parameters,
                 java.util.Set<ResponseMessage> responseMessages,
                 java.lang.String deprecated,
                 boolean isHidden,
                 java.util.Collection<VendorExtension> vendorExtensions,
                 java.util.Set<RequestParameter> requestParameters,
                 RequestBody body,
                 java.util.Set<Response> responses)

Method Detail

isHidden

public boolean isHidden()

getResponseModel

@Deprecated
public ModelReference getResponseModel()

Deprecated.

Returns:

model reference

Since:

3.0.0 Use @see getResponses()

getTags

public java.util.Set<java.lang.String> getTags()

getMethod

public org.springframework.http.HttpMethod getMethod()

getSummary

public java.lang.String getSummary()

getNotes

public java.lang.String getNotes()

getUniqueId

public java.lang.String getUniqueId()

getPosition

public int getPosition()

getProduces

public java.util.Set<java.lang.String> getProduces()

getConsumes

public java.util.Set<java.lang.String> getConsumes()

getProtocol

public java.util.Set<java.lang.String> getProtocol()

getSecurityReferences

public java.util.Map<java.lang.String,java.util.List<AuthorizationScope>> getSecurityReferences()

getParameters

public java.util.List<Parameter> getParameters()

getResponseMessages

@Deprecated
public java.util.Set<ResponseMessage> getResponseMessages()

Deprecated.

Returns:

model reference

Since:

3.0.0 Use @see getResponses()

getResponses

public java.util.SortedSet<Response> getResponses()

getDeprecated

public java.lang.String getDeprecated()

getVendorExtensions

public java.util.List<VendorExtension> getVendorExtensions()

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

getRequestParameters

public java.util.Set<RequestParameter> getRequestParameters()

getQueryParameters

public java.util.SortedSet<RequestParameter> getQueryParameters()

getBody

public RequestBody getBody()

getExternalDocumentation

public ExternalDocumentation getExternalDocumentation()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object