com.mulesoft.connectivity.rest.sdk.internal.webapi.model

Class APIOperationModel

java.lang.Object

com.mulesoft.connectivity.rest.sdk.internal.webapi.model.APIOperationModel

Direct Known Subclasses:

AMFOperationModel

public abstract class APIOperationModel
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected APIDocumentationModel	apiDocumentationModel
protected List<String>	baseUris
protected String	description
protected List<APIParameterModel>	headersModel
protected String	httpMethod
protected List<APITypeModel>	inputMetadataModel
protected String	name
protected String	operationId
protected List<APITypeModel>	outputMetadataModel
protected String	path
protected List<APIParameterModel>	queryParamsModel
protected List<APISecuritySchemeModel>	securitySchemesModel
protected String	summary
protected List<APIParameterModel>	uriParamsModel

Constructor Summary

Constructors

Constructor and Description
APIOperationModel()

Method Summary

Modifier and Type	Method and Description
APIDocumentationModel	getAPIDocumentationModel()
List<String>	getBaseUris()
String	getDescription()
List<APIParameterModel>	getHeadersModel()
String	getHttpMethod()
List<APITypeModel>	getInputMetadataModel()
abstract APILocation	getLocation() Retrieves the location in the API Spec this element was parsed from.
String	getName()
String	getOperationId()
List<APITypeModel>	getOutputMetadataModel()
Optional<APIParameterModel>	getParameter(APIParameterType apiParameterType, String name) Retrieves a parameter by its name and type.
String	getPath()
List<APIParameterModel>	getQueryParamsModel()
List<APISecuritySchemeModel>	getSecuritySchemesModel()
String	getSummary()
List<APIParameterModel>	getUriParamsModel()
protected <T> List<T>	selectSecurityRequirements(List<T> operationSchemes, List<T> endPointSchemes, List<T> globalSchemes)

Methods inherited from class java.lang.Object

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

Field Detail

operationId

protected String operationId

name

protected String name

description

protected String description

summary

protected String summary

path

protected String path

httpMethod

protected String httpMethod

baseUris

protected List<String> baseUris

uriParamsModel

protected List<APIParameterModel> uriParamsModel

queryParamsModel

protected List<APIParameterModel> queryParamsModel

headersModel

protected List<APIParameterModel> headersModel

inputMetadataModel

protected List<APITypeModel> inputMetadataModel

outputMetadataModel

protected List<APITypeModel> outputMetadataModel

securitySchemesModel

protected List<APISecuritySchemeModel> securitySchemesModel

apiDocumentationModel

protected APIDocumentationModel apiDocumentationModel

Constructor Detail

APIOperationModel

public APIOperationModel()

Method Detail

getOperationId

public String getOperationId()

getName

public String getName()

getDescription

public String getDescription()

getSummary

public String getSummary()

getPath

public String getPath()

getHttpMethod

public String getHttpMethod()

getBaseUris

public List<String> getBaseUris()

getUriParamsModel

public List<APIParameterModel> getUriParamsModel()

getQueryParamsModel

public List<APIParameterModel> getQueryParamsModel()

getHeadersModel

public List<APIParameterModel> getHeadersModel()

getInputMetadataModel

public List<APITypeModel> getInputMetadataModel()

getOutputMetadataModel

public List<APITypeModel> getOutputMetadataModel()

getSecuritySchemesModel

public List<APISecuritySchemeModel> getSecuritySchemesModel()

getAPIDocumentationModel

public APIDocumentationModel getAPIDocumentationModel()

selectSecurityRequirements

protected <T> List<T> selectSecurityRequirements(List<T> operationSchemes,
                                                 List<T> endPointSchemes,
                                                 List<T> globalSchemes)

getParameter

public Optional<APIParameterModel> getParameter(APIParameterType apiParameterType,
                                                String name)

Retrieves a parameter by its name and type.

Different parameter types have different case sensitivity (see ComparisonUtil.externalNameParamsComparison()).

Parameters:

apiParameterType - the type of the parameter, e.g. header, query, uri (i.e. path), body, etc.

name - the name to look for

Returns:

the parameter

getLocation

public abstract APILocation getLocation()

Retrieves the location in the API Spec this element was parsed from.