Package org.springdoc.core.service
Class OperationService
java.lang.Object
org.springdoc.core.service.OperationService
The type Operation builder.
- Author:
- bnasslahsen
-
Constructor Summary
ConstructorDescriptionOperationService
(GenericParameterService parameterBuilder, RequestBodyService requestBodyService, SecurityService securityParser, PropertyResolverUtils propertyResolverUtils) Instantiates a new Operation builder. -
Method Summary
Modifier and TypeMethodDescriptionbuildCallbacks
(Set<io.swagger.v3.oas.annotations.callbacks.Callback> apiCallbacks, io.swagger.v3.oas.models.OpenAPI openAPI, MethodAttributes methodAttributes) Build callbacks optional.Gets javadoc provider.getOperationId
(String operationId, io.swagger.v3.oas.models.OpenAPI openAPI) Gets operation id.getOperationId
(String operationId, String oldOperationId, io.swagger.v3.oas.models.OpenAPI openAPI) Gets operation id.boolean
Is hidden boolean.io.swagger.v3.oas.models.Operation
mergeOperation
(io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.Operation operationModel) Merge operation.io.swagger.v3.oas.models.OpenAPI
parse
(io.swagger.v3.oas.annotations.Operation apiOperation, io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.OpenAPI openAPI, MethodAttributes methodAttributes) Parse open api.
-
Constructor Details
-
OperationService
public OperationService(GenericParameterService parameterBuilder, RequestBodyService requestBodyService, SecurityService securityParser, PropertyResolverUtils propertyResolverUtils) Instantiates a new Operation builder.- Parameters:
parameterBuilder
- the parameter builderrequestBodyService
- the request body buildersecurityParser
- the security parserpropertyResolverUtils
- the property resolver utils
-
-
Method Details
-
parse
public io.swagger.v3.oas.models.OpenAPI parse(io.swagger.v3.oas.annotations.Operation apiOperation, io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.OpenAPI openAPI, MethodAttributes methodAttributes) Parse open api.- Parameters:
apiOperation
- the api operationoperation
- the operationopenAPI
- the open apimethodAttributes
- the method attributes- Returns:
- the open api
-
isHidden
Is hidden boolean.- Parameters:
method
- the method- Returns:
- the boolean
-
buildCallbacks
public Optional<Map<String,io.swagger.v3.oas.models.callbacks.Callback>> buildCallbacks(Set<io.swagger.v3.oas.annotations.callbacks.Callback> apiCallbacks, io.swagger.v3.oas.models.OpenAPI openAPI, MethodAttributes methodAttributes) Build callbacks optional.- Parameters:
apiCallbacks
- the api callbacksopenAPI
- the open apimethodAttributes
- the method attributes- Returns:
- the optional
-
getOperationId
Gets operation id.- Parameters:
operationId
- the operation idopenAPI
- the open api- Returns:
- the operation id
-
getOperationId
public String getOperationId(String operationId, String oldOperationId, io.swagger.v3.oas.models.OpenAPI openAPI) Gets operation id.- Parameters:
operationId
- the operation idoldOperationId
- the old operation idopenAPI
- the open api- Returns:
- the operation id
-
mergeOperation
public io.swagger.v3.oas.models.Operation mergeOperation(io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.Operation operationModel) Merge operation.- Parameters:
operation
- the operationoperationModel
- the operation model- Returns:
- the operation
-
getJavadocProvider
Gets javadoc provider.- Returns:
- the javadoc provider
-