@novice1/api-doc-generator - v1.2.0
Preparing search index...
generators/openapi/helpers/interfaces
OpenAPIHelperInterface
Interface OpenAPIHelperInterface
interface
OpenAPIHelperInterface
{
allowsEmptyValue
()
:
boolean
;
getAdditionalProperties
?
()
:
AdditionalProperties
|
undefined
;
getAlternatives
()
:
OpenAPIHelperInterface
[]
;
getChildren
()
:
Record
<
string
,
OpenAPIHelperInterface
>
;
getDefaultValue
()
:
unknown
;
getDescription
()
:
string
;
getDiscriminator
?
()
:
DiscriminatorObject
|
undefined
;
getEncoding
?
()
:
Record
<
string
,
EncodingObject
>
|
undefined
;
getEnum
()
:
unknown
[]
;
getExamples
?
()
:
Record
<
string
,
ReferenceObject
|
ExampleObject
>
|
undefined
;
getExampleValue
()
:
unknown
;
getFirstItem
()
:
OpenAPIHelperInterface
|
undefined
;
getMax
()
:
number
|
undefined
;
getMin
()
:
number
|
undefined
;
getRef
?
()
:
string
|
undefined
;
getStyle
?
()
:
string
|
undefined
;
getType
()
:
string
;
getUnit
()
:
string
;
getXml
?
()
:
XMLObject
|
undefined
;
hasAdditionalProperties
?
()
:
boolean
;
hasDefaultValue
()
:
boolean
;
hasDiscriminator
?
()
:
boolean
;
hasEncoding
?
()
:
boolean
;
hasExamples
?
()
:
boolean
;
hasExampleValue
()
:
boolean
;
hasMax
()
:
boolean
;
hasMin
()
:
boolean
;
hasRef
?
()
:
boolean
;
hasStyle
?
()
:
boolean
;
hasXml
?
()
:
boolean
;
isDeprecated
()
:
boolean
;
isRequired
()
:
boolean
;
isUnique
()
:
boolean
;
isValid
()
:
boolean
;
}
Hierarchy (
View Summary
)
BaseHelperInterface
OpenAPIHelperInterface
Implemented by
OpenAPIJoiHelper
Index
Methods
allows
Empty
Value
get
Additional
Properties?
get
Alternatives
get
Children
get
Default
Value
get
Description
get
Discriminator?
get
Encoding?
get
Enum
get
Examples?
get
Example
Value
get
First
Item
get
Max
get
Min
get
Ref?
get
Style?
get
Type
get
Unit
get
Xml?
has
Additional
Properties?
has
Default
Value
has
Discriminator?
has
Encoding?
has
Examples?
has
Example
Value
has
Max
has
Min
has
Ref?
has
Style?
has
Xml?
is
Deprecated
is
Required
is
Unique
is
Valid
Methods
allows
Empty
Value
allowsEmptyValue
()
:
boolean
Returns
boolean
Optional
get
Additional
Properties
getAdditionalProperties
?
()
:
AdditionalProperties
|
undefined
Returns
AdditionalProperties
|
undefined
get
Alternatives
getAlternatives
()
:
OpenAPIHelperInterface
[]
Returns
OpenAPIHelperInterface
[]
get
Children
getChildren
()
:
Record
<
string
,
OpenAPIHelperInterface
>
Returns
Record
<
string
,
OpenAPIHelperInterface
>
get
Default
Value
getDefaultValue
()
:
unknown
Returns
unknown
get
Description
getDescription
()
:
string
Returns
string
Optional
get
Discriminator
getDiscriminator
?
()
:
DiscriminatorObject
|
undefined
Returns
DiscriminatorObject
|
undefined
Optional
get
Encoding
getEncoding
?
()
:
Record
<
string
,
EncodingObject
>
|
undefined
Returns
Record
<
string
,
EncodingObject
>
|
undefined
get
Enum
getEnum
()
:
unknown
[]
Returns
unknown
[]
Optional
get
Examples
getExamples
?
()
:
Record
<
string
,
ReferenceObject
|
ExampleObject
>
|
undefined
Returns
Record
<
string
,
ReferenceObject
|
ExampleObject
>
|
undefined
get
Example
Value
getExampleValue
()
:
unknown
Returns
unknown
get
First
Item
getFirstItem
()
:
OpenAPIHelperInterface
|
undefined
Returns
OpenAPIHelperInterface
|
undefined
get
Max
getMax
()
:
number
|
undefined
Returns
number
|
undefined
get
Min
getMin
()
:
number
|
undefined
Returns
number
|
undefined
Optional
get
Ref
getRef
?
()
:
string
|
undefined
Returns
string
|
undefined
Optional
get
Style
getStyle
?
()
:
string
|
undefined
Returns
string
|
undefined
get
Type
getType
()
:
string
Returns
string
get
Unit
getUnit
()
:
string
Returns
string
Optional
get
Xml
getXml
?
()
:
XMLObject
|
undefined
Returns
XMLObject
|
undefined
Optional
has
Additional
Properties
hasAdditionalProperties
?
()
:
boolean
Returns
boolean
has
Default
Value
hasDefaultValue
()
:
boolean
Returns
boolean
Optional
has
Discriminator
hasDiscriminator
?
()
:
boolean
Returns
boolean
Optional
has
Encoding
hasEncoding
?
()
:
boolean
Returns
boolean
Optional
has
Examples
hasExamples
?
()
:
boolean
Returns
boolean
has
Example
Value
hasExampleValue
()
:
boolean
Returns
boolean
has
Max
hasMax
()
:
boolean
Returns
boolean
has
Min
hasMin
()
:
boolean
Returns
boolean
Optional
has
Ref
hasRef
?
()
:
boolean
Returns
boolean
Optional
has
Style
hasStyle
?
()
:
boolean
Returns
boolean
Optional
has
Xml
hasXml
?
()
:
boolean
Returns
boolean
is
Deprecated
isDeprecated
()
:
boolean
Returns
boolean
is
Required
isRequired
()
:
boolean
Returns
boolean
is
Unique
isUnique
()
:
boolean
Returns
boolean
is
Valid
isValid
()
:
boolean
Returns
boolean
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
allows
Empty
Value
get
Additional
Properties
get
Alternatives
get
Children
get
Default
Value
get
Description
get
Discriminator
get
Encoding
get
Enum
get
Examples
get
Example
Value
get
First
Item
get
Max
get
Min
get
Ref
get
Style
get
Type
get
Unit
get
Xml
has
Additional
Properties
has
Default
Value
has
Discriminator
has
Encoding
has
Examples
has
Example
Value
has
Max
has
Min
has
Ref
has
Style
has
Xml
is
Deprecated
is
Required
is
Unique
is
Valid
@novice1/api-doc-generator - v1.2.0
Loading...