Uses of Interface
org.eclipse.microprofile.openapi.models.Operation
Packages that use Operation
Package
Description
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.
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 OperationModifier and TypeMethodDescriptionstatic OperationOASFactory.createOperation()This method creates a newOperationinstance.default OperationOASFilter.filterOperation(Operation operation) Allows filtering of a particular Operation.Methods in org.eclipse.microprofile.openapi with parameters of type OperationModifier and TypeMethodDescriptiondefault OperationOASFilter.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 OperationModifier and TypeMethodDescriptionOperation.addCallback(String key, Callback callback) Adds the given callback item to this Operation's map of callbacks.Operation.addParameter(Parameter parameter) Adds the given parameter item to this Operation's list of parameters.Operation.addSecurityRequirement(SecurityRequirement securityRequirement) Adds the given security requirement item to this Operation's list of security mechanisms.Adds the given server to this Operation's list of servers.Adds the given tag to this Operation's list of tags.default OperationSets this Operation's callbacks property to the given map.default OperationOperation.deprecated(Boolean deprecated) Sets this Operation's deprecated property to the given value.default OperationOperation.description(String description) Sets this Operation's description property to the given string.default OperationOperation.externalDocs(ExternalDocumentation externalDocs) Sets this Operation's externalDocs property to the given object.PathItem.getDELETE()Returns the delete property from a PathItem instance.PathItem.getGET()Returns the get property from a PathItem instance.PathItem.getHEAD()Returns the head property from a PathItem instance.PathItem.getOPTIONS()Returns the options property from a PathItem instance.PathItem.getPATCH()Returns the patch property from a PathItem instance.PathItem.getPOST()Returns the post property from a PathItem instance.PathItem.getPUT()Returns the put property from a PathItem instance.PathItem.getTRACE()Returns the trace property from a PathItem instance.default OperationOperation.operationId(String operationId) Sets this Operation's operationId property to the given string.default OperationOperation.parameters(List<Parameter> parameters) Sets this Operation's parameters property to the given parameter list.default OperationOperation.requestBody(RequestBody requestBody) Sets this Operation's requestBody property to the given object.default OperationOperation.responses(APIResponses responses) Sets this Operation's responses property to the given responses.default OperationOperation.security(List<SecurityRequirement> security) Sets this Operation's security property to the given list.default OperationSets this Operation's servers property to the given list.default OperationSets this Operation's summary property to the given string.default OperationSets this Operation's tags property to the given tags.Methods in org.eclipse.microprofile.openapi.models that return types with arguments of type OperationModifier and TypeMethodDescriptionPathItem.getOperations()Returns a map with all the operations for this path where the keys arePathItem.HttpMethoditemsMethods in org.eclipse.microprofile.openapi.models with parameters of type OperationModifier and TypeMethodDescriptiondefault PathItemSets this PathItem's delete property to the given operation.default PathItemSets this PathItem's get property to the given operation.default PathItemSets this PathItem's head property to the given operation.default PathItemSets this PathItem's options property to the given operation.default PathItemSets this PathItem's patch property to the given operation.default PathItemSets this PathItem's post property to the given operation.default PathItemSets this PathItem's put property to the given operation.voidSets this PathItem's delete property to the given operation.voidSets this PathItem's get property to the given operation.voidSets this PathItem's head property to the given operation.voidPathItem.setOperation(PathItem.HttpMethod httpMethod, Operation operation) Sets an operation for a given http method.voidPathItem.setOPTIONS(Operation options) Sets this PathItem's options property to the given operation.voidSets this PathItem's patch property to the given operation.voidSets this PathItem's post property to the given operation.voidSets this PathItem's put property to the given operation.voidSets this PathItem's trace property to the given operation.default PathItemSets this PathItem's trace property to the given operation.