Uses of Interface
org.eclipse.microprofile.openapi.models.Operation
-
Packages that use Operation Package Description org.eclipse.microprofile.openapi A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI v3.1 documents from their Jakarta REST applications.org.eclipse.microprofile.openapi.models A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library. -
-
Uses of Operation in org.eclipse.microprofile.openapi
Methods in org.eclipse.microprofile.openapi that return Operation Modifier and Type Method Description static Operation
OASFactory. createOperation()
This method creates a newOperation
instance.default Operation
OASFilter. filterOperation(Operation operation)
Allows filtering of a particular Operation.Methods in org.eclipse.microprofile.openapi with parameters of type Operation Modifier and Type Method Description default Operation
OASFilter. filterOperation(Operation operation)
Allows filtering of a particular Operation. -
Uses of Operation in org.eclipse.microprofile.openapi.models
Methods in org.eclipse.microprofile.openapi.models that return Operation Modifier and Type Method Description Operation
Operation. addCallback(String key, Callback callback)
Adds the given callback item to this Operation's map of callbacks.Operation
Operation. addParameter(Parameter parameter)
Adds the given parameter item to this Operation's list of parameters.Operation
Operation. addSecurityRequirement(SecurityRequirement securityRequirement)
Adds the given security requirement item to this Operation's list of security mechanisms.Operation
Operation. addServer(Server server)
Adds the given server to this Operation's list of servers.Operation
Operation. addTag(String tag)
Adds the given tag to this Operation's list of tags.default Operation
Operation. callbacks(Map<String,Callback> callbacks)
Sets this Operation's callbacks property to the given map.default Operation
Operation. deprecated(Boolean deprecated)
Sets this Operation's deprecated property to the given value.default Operation
Operation. description(String description)
Sets this Operation's description property to the given string.default Operation
Operation. externalDocs(ExternalDocumentation externalDocs)
Sets this Operation's externalDocs property to the given object.Operation
PathItem. getDELETE()
Returns the delete property from a PathItem instance.Operation
PathItem. getGET()
Returns the get property from a PathItem instance.Operation
PathItem. getHEAD()
Returns the head property from a PathItem instance.Operation
PathItem. getOPTIONS()
Returns the options property from a PathItem instance.Operation
PathItem. getPATCH()
Returns the patch property from a PathItem instance.Operation
PathItem. getPOST()
Returns the post property from a PathItem instance.Operation
PathItem. getPUT()
Returns the put property from a PathItem instance.Operation
PathItem. getTRACE()
Returns the trace property from a PathItem instance.default Operation
Operation. operationId(String operationId)
Sets this Operation's operationId property to the given string.default Operation
Operation. parameters(List<Parameter> parameters)
Sets this Operation's parameters property to the given parameter list.default Operation
Operation. requestBody(RequestBody requestBody)
Sets this Operation's requestBody property to the given object.default Operation
Operation. responses(APIResponses responses)
Sets this Operation's responses property to the given responses.default Operation
Operation. security(List<SecurityRequirement> security)
Sets this Operation's security property to the given list.default Operation
Operation. servers(List<Server> servers)
Sets this Operation's servers property to the given list.default Operation
Operation. summary(String summary)
Sets this Operation's summary property to the given string.default Operation
Operation. tags(List<String> tags)
Sets this Operation's tags property to the given tags.Methods in org.eclipse.microprofile.openapi.models that return types with arguments of type Operation Modifier and Type Method Description Map<PathItem.HttpMethod,Operation>
PathItem. getOperations()
Returns a map with all the operations for this path where the keys arePathItem.HttpMethod
itemsMethods in org.eclipse.microprofile.openapi.models with parameters of type Operation Modifier and Type Method Description default PathItem
PathItem. DELETE(Operation delete)
Sets this PathItem's delete property to the given operation.default PathItem
PathItem. GET(Operation get)
Sets this PathItem's get property to the given operation.default PathItem
PathItem. HEAD(Operation head)
Sets this PathItem's head property to the given operation.default PathItem
PathItem. OPTIONS(Operation options)
Sets this PathItem's options property to the given operation.default PathItem
PathItem. PATCH(Operation patch)
Sets this PathItem's patch property to the given operation.default PathItem
PathItem. POST(Operation post)
Sets this PathItem's post property to the given operation.default PathItem
PathItem. PUT(Operation put)
Sets this PathItem's put property to the given operation.void
PathItem. setDELETE(Operation delete)
Sets this PathItem's delete property to the given operation.void
PathItem. setGET(Operation get)
Sets this PathItem's get property to the given operation.void
PathItem. setHEAD(Operation head)
Sets this PathItem's head property to the given operation.void
PathItem. setOperation(PathItem.HttpMethod httpMethod, Operation operation)
Sets an operation for a given http method.void
PathItem. setOPTIONS(Operation options)
Sets this PathItem's options property to the given operation.void
PathItem. setPATCH(Operation patch)
Sets this PathItem's patch property to the given operation.void
PathItem. setPOST(Operation post)
Sets this PathItem's post property to the given operation.void
PathItem. setPUT(Operation put)
Sets this PathItem's put property to the given operation.void
PathItem. setTRACE(Operation trace)
Sets this PathItem's trace property to the given operation.default PathItem
PathItem. TRACE(Operation trace)
Sets this PathItem's trace property to the given operation.
-