Preparing search index...
The search index is not available
@novice1/api-doc-generator - v0.2.8
@novice1/api-doc-generator
generators/openapi/definitions
ParameterObject
Interface ParameterObject
interface
ParameterObject
{
allowEmptyValue
?:
boolean
;
allowReserved
?:
boolean
;
content
?:
Record
<
string
,
MediaTypeObject
>
;
deprecated
?:
boolean
;
description
?:
string
;
example
?:
unknown
;
examples
?:
Record
<
string
,
ReferenceObject
|
ExampleObject
>
;
explode
?:
boolean
;
in
:
string
;
name
:
string
;
required
?:
boolean
;
schema
?:
SchemaObject
|
ReferenceObject
;
style
?:
string
;
}
Hierarchy (
View Summary
)
HeaderObject
ParameterObject
Index
Properties
allow
Empty
Value?
allow
Reserved?
content?
deprecated?
description?
example?
examples?
explode?
in
name
required?
schema?
style?
Properties
Optional
allow
Empty
Value
allowEmptyValue
?:
boolean
Optional
allow
Reserved
allowReserved
?:
boolean
Optional
content
content
?:
Record
<
string
,
MediaTypeObject
>
Optional
deprecated
deprecated
?:
boolean
Optional
description
description
?:
string
Optional
example
example
?:
unknown
Optional
examples
examples
?:
Record
<
string
,
ReferenceObject
|
ExampleObject
>
Optional
explode
explode
?:
boolean
in
in
:
string
name
name
:
string
Optional
required
required
?:
boolean
Optional
schema
schema
?:
SchemaObject
|
ReferenceObject
Optional
style
style
?:
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
allow
Empty
Value
allow
Reserved
content
deprecated
description
example
examples
explode
in
name
required
schema
style
@novice1/api-doc-generator - v0.2.8
Loading...