Package io.vertx.openapi.contract
Interface Operation
-
- All Superinterfaces:
OpenAPIObject
public interface Operation extends OpenAPIObject
This interface represents the most important attributes of an OpenAPI Operation.
Operation V3.1
Operation V3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getAbsoluteOpenAPIPath()
Response
getDefaultResponse()
HttpMethod
getHttpMethod()
String
getOpenAPIPath()
String
getOperationId()
List<Parameter>
getParameters()
RequestBody
getRequestBody()
Response
getResponse(int responseCode)
Returns the response to the passed response code or null.List<SecurityRequirement>
getSecurityRequirements()
Returns the applicable list of security requirements (scopes) or empty list.List<String>
getTags()
-
Methods inherited from interface io.vertx.openapi.contract.OpenAPIObject
getExtensions, getOpenAPIModel
-
-
-
-
Method Detail
-
getOperationId
String getOperationId()
- Returns:
- operationId of this operation
-
getHttpMethod
HttpMethod getHttpMethod()
- Returns:
- http method of this operation
-
getOpenAPIPath
String getOpenAPIPath()
- Returns:
- path in OpenAPI style
-
getAbsoluteOpenAPIPath
String getAbsoluteOpenAPIPath()
- Returns:
- absolute path in OpenAPI style
-
getRequestBody
RequestBody getRequestBody()
- Returns:
- request body of the operation, or null if no request body is defined
-
getDefaultResponse
Response getDefaultResponse()
- Returns:
- the default response, or null if no default response is defined.
-
getResponse
Response getResponse(int responseCode)
Returns the response to the passed response code or null.- Parameters:
responseCode
- The related response code- Returns:
- The related response, or null.
-
getSecurityRequirements
List<SecurityRequirement> getSecurityRequirements()
Returns the applicable list of security requirements (scopes) or empty list.- Returns:
- The related security requirement.
-
-