Package com.atlassian.oai.validator.model

Class ApiOperation

java.lang.Object

com.atlassian.oai.validator.model.ApiOperation

public class ApiOperation
extends Object

A container representing a single API operation.

This includes the path, method and operation components from the OAI spec object. Used as a convenience to hold related information in one place.

Constructor Summary

Constructors

Constructor	Description
ApiOperation(ApiPath apiPath, NormalisedPath requestPath, io.swagger.v3.oas.models.PathItem.HttpMethod method, io.swagger.v3.oas.models.Operation operation)

Method Summary

Modifier and Type	Method	Description
ApiPath	getApiPath()
io.swagger.v3.oas.models.PathItem.HttpMethod	getMethod()
io.swagger.v3.oas.models.Operation	getOperation()
NormalisedPath	getRequestPath()

Methods inherited from class java.lang.Object

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

Constructor Details

ApiOperation

public ApiOperation(@Nonnull
 ApiPath apiPath,
 @Nonnull
 NormalisedPath requestPath,
 @Nonnull
 io.swagger.v3.oas.models.PathItem.HttpMethod method,
 @Nonnull
 io.swagger.v3.oas.models.Operation operation)

Method Details

getApiPath

@Nonnull
public ApiPath getApiPath()

Returns:

The path the operation is on

getRequestPath

@Nonnull
public NormalisedPath getRequestPath()

Returns:

The normalised path from original request

getMethod

@Nonnull
public io.swagger.v3.oas.models.PathItem.HttpMethod getMethod()

Returns:

The method the operation is on

getOperation

@Nonnull
public io.swagger.v3.oas.models.Operation getOperation()

Returns:

The operation object from the OAI specification