Package io.swagger.codegen.v3
Class CodegenOperation
java.lang.Object
io.swagger.codegen.v3.CodegenObject
io.swagger.codegen.v3.CodegenOperation
- All Implemented Interfaces:
VendorExtendable
-
Field Summary
FieldsModifier and TypeFieldDescriptionio.swagger.v3.oas.models.media.Discriminatorio.swagger.v3.oas.models.ExternalDocumentationfinal List<CodegenProperty>booleanbooleanbooleanList<io.swagger.v3.oas.models.tags.Tag>Fields inherited from class io.swagger.codegen.v3.CodegenObject
vendorExtensionsFields inherited from interface io.swagger.codegen.v3.VendorExtendable
PREFIX_HAS, PREFIX_IS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanio.swagger.v3.oas.models.media.Discriminatorio.swagger.v3.oas.models.ExternalDocumentationbooleanCheck if there's at least one body parameterbooleanCheck if there's at least one cookie parameterbooleanCheck if there's at least one example parameterbooleanCheck if there's at least one form parameterbooleanCheck if there's at least one header parameterbooleanCheck if there's at least one path parameterbooleanCheck if there's at least one query parameterbooleanCheck if body param is allowed for the request methodbooleanCheck if Restful-stylebooleanCheck if act as Restful create methodbooleanCheck if act as Restful destroy methodbooleanCheck if act as Restful index methodbooleanCheck if act as Restful show methodbooleanCheck if act as Restful update methodgetNotes()getPath()booleanbooleanbooleanList<io.swagger.v3.oas.models.tags.Tag>getTags()inthashCode()toString()Methods inherited from class io.swagger.codegen.v3.CodegenObject
getBooleanValue, getHasHeaders, getHasInnerObject, getHasMore, getIsAlias, getIsArrayModel, getIsBinary, getIsBoolean, getIsByteArray, getIsCollectionFormatMulti, getIsContainer, getIsDate, getIsDateTime, getIsDefault, getIsDouble, getIsEnum, getIsFile, getIsFloat, getIsInteger, getIsListContainer, getIsLong, getIsMapContainer, getIsMultipart, getIsNotContainer, getIsNullable, getIsNumber, getIsNumeric, getIsObject, getIsPrimitiveType, getIsReadOnly, getIsResponseBinary, getIsResponseFile, getIsString, getIsUuid, getVendorExtensions, setVendorExtensions
-
Field Details
-
responseHeaders
-
returnTypeIsPrimitive
public boolean returnTypeIsPrimitive -
returnSimpleType
public boolean returnSimpleType -
subresourceOperation
public boolean subresourceOperation -
path
-
operationId
-
returnType
-
httpMethod
-
returnBaseType
-
returnContainer
-
summary
-
unescapedNotes
-
notes
-
baseName
-
defaultResponse
-
testPath
-
discriminator
public io.swagger.v3.oas.models.media.Discriminator discriminator -
consumes
-
produces
-
prioritizedContentTypes
-
bodyParam
-
contents
-
allParams
-
bodyParams
-
pathParams
-
queryParams
-
headerParams
-
cookieParams
-
formParams
-
requiredParams
-
authMethods
-
tags
-
responses
-
imports
-
examples
-
requestBodyExamples
-
externalDocs
public io.swagger.v3.oas.models.ExternalDocumentation externalDocs -
nickname
-
operationIdLowerCase
-
operationIdCamelCase
-
operationIdSnakeCase
-
-
Constructor Details
-
CodegenOperation
public CodegenOperation()
-
-
Method Details
-
getHasBodyParam
public boolean getHasBodyParam()Check if there's at least one body parameter- Returns:
- true if body parameter exists, false otherwise
-
getHasQueryParams
public boolean getHasQueryParams()Check if there's at least one query parameter- Returns:
- true if query parameter exists, false otherwise
-
getHasHeaderParams
public boolean getHasHeaderParams()Check if there's at least one header parameter- Returns:
- true if header parameter exists, false otherwise
-
getHasCookieParams
public boolean getHasCookieParams()Check if there's at least one cookie parameter- Returns:
- true if cookie parameter exists, false otherwise
-
getHasPathParams
public boolean getHasPathParams()Check if there's at least one path parameter- Returns:
- true if path parameter exists, false otherwise
-
getHasFormParams
public boolean getHasFormParams()Check if there's at least one form parameter- Returns:
- true if any form parameter exists, false otherwise
-
getHasExamples
public boolean getHasExamples()Check if there's at least one example parameter- Returns:
- true if examples parameter exists, false otherwise
-
getIsRestfulIndex
public boolean getIsRestfulIndex()Check if act as Restful index method- Returns:
- true if act as Restful index method, false otherwise
-
getIsRestfulShow
public boolean getIsRestfulShow()Check if act as Restful show method- Returns:
- true if act as Restful show method, false otherwise
-
getIsRestfulCreate
public boolean getIsRestfulCreate()Check if act as Restful create method- Returns:
- true if act as Restful create method, false otherwise
-
getIsRestfulUpdate
public boolean getIsRestfulUpdate()Check if act as Restful update method- Returns:
- true if act as Restful update method, false otherwise
-
getIsBodyAllowed
public boolean getIsBodyAllowed()Check if body param is allowed for the request method- Returns:
- true request method is PUT, PATCH or POST; false otherwise
-
getIsRestfulDestroy
public boolean getIsRestfulDestroy()Check if act as Restful destroy method- Returns:
- true if act as Restful destroy method, false otherwise
-
getIsRestful
public boolean getIsRestful()Check if Restful-style- Returns:
- true if Restful-style, false otherwise
-
toString
-
equals
-
hashCode
public int hashCode() -
getResponseHeaders
-
getPath
-
getOperationId
-
getReturnType
-
getHttpMethod
-
getReturnBaseType
-
getReturnContainer
-
getSummary
-
getUnescapedNotes
-
getNotes
-
getBaseName
-
getDefaultResponse
-
getTestPath
-
getDiscriminator
public io.swagger.v3.oas.models.media.Discriminator getDiscriminator() -
getConsumes
-
getProduces
-
getPrioritizedContentTypes
-
getBodyParam
-
getContents
-
getAllParams
-
getBodyParams
-
getPathParams
-
getQueryParams
-
getHeaderParams
-
getCookieParams
-
getFormParams
-
getReturnTypeIsPrimitive
public boolean getReturnTypeIsPrimitive() -
getReturnSimpleType
public boolean getReturnSimpleType() -
getSubresourceOperation
public boolean getSubresourceOperation() -
getRequiredParams
-
getAuthMethods
-
getTags
-
getResponses
-
getImports
-
getExamples
-
getRequestBodyExamples
-
getExternalDocs
public io.swagger.v3.oas.models.ExternalDocumentation getExternalDocs() -
getNickname
-
getOperationIdLowerCase
-
getOperationIdCamelCase
-
getOperationIdSnakeCase
-
getIsDeprecated
-
getHasAuthMethods
-
getHasConsumes
-
getHasProduces
-
getHasParams
-
getHasOptionalParams
-
getHasRequiredParams
-
getHasReference
-