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
commons
DocGenerator
ProcessedRoute
generators
openapi
GenerateComponentsRule
OpenAPI
OpenAPIResult
definitions
ParameterLocation
ComponentsObject
ContactObject
DiscriminatorObject
EncodingObject
ExampleObject
ExternalDocObject
HeaderObject
InfoObject
LicenseObject
LinkObject
MediaTypeObject
OAuthFlowObject
OAuthFlowsObject
ParameterObject
ReferenceObject
RequestBodyObject
ResponseObject
SchemaObject
SecurityRequirementObject
SecuritySchemeObject
ServerObject
ServerVariableObject
TagObject
XMLObject
AdditionalProperties
helpers
interfaces
OpenAPIHelperInterface
joiHelper
OpenAPIJoiHelper
postman
GenerateFoldersRule
Postman
PostmanCollection
definitions
AuthType
Auth
AuthAttribute
CertificateObject
CollectionVersion
CookieObject
DescriptionObject
EventObject
Folder
HeaderObject
InfoObject
Item
ProxyConfig
QueryParam
RequestBodyObject
RequestObject
ResponseObject
ScriptObject
SrcFormParameter
UrlEncodedParameter
UrlObject
ValueFormParameter
Variable
Description
FormParameter
helpers
interfaces
PostmanHelperInterface
joiHelper
PostmanJoiHelper
helpers
baseHelper
BaseHelperInterface
joiHelper
JoiHelper
JoiSchema
index
ApiKeyLocation
ApiKeyUtil
BasicAuthUtil
BearerUtil
ChallengeAlgorithm
ClientAuthentication
ContextAuthUtil
ContextResponseUtil
DocGenerator
GenerateComponentsRule
GenerateFoldersRule
GrantType
GroupAuthUtil
GroupContextAuthUtil
GroupResponseUtil
IOpenAPIResponseContext
MediaTypeUtil
NoAuthUtil
OAuth2Util
OpenAPI
OpenAPIHelperInterface
OpenAPIResult
Postman
PostmanCollection
PostmanHelperInterface
ProcessedRoute
ResponseUtil
TokenLocation
utils
auth
all
ApiKeyLocation
ApiKeyUtil
BaseAuthUtil
BaseContextAuthUtil
BaseOpenAPIAuthUtil
BasePostmanAuthUtil
BasicAuthUtil
BearerUtil
ChallengeAlgorithm
ClientAuthentication
ContextAuthUtil
FullAuthUtil
GrantType
GroupAuthUtil
GroupContextAuthUtil
NoAuthUtil
OAuth2Util
TokenLocation
apiKeyUtil
ApiKeyLocation
ApiKeyUtil
baseAuthUtils
BaseAuthUtil
BaseContextAuthUtil
BaseOpenAPIAuthUtil
BasePostmanAuthUtil
FullAuthUtil
IContextAuthUtil
basicAuthUtil
BasicAuthUtil
bearerUtil
BearerUtil
contextAuthUtils
ContextAuthUtil
GroupContextAuthUtil
groupAuthUtil
GroupAuthUtil
noAuthUtil
NoAuthUtil
oAuth2Util
ChallengeAlgorithm
ClientAuthentication
GrantType
TokenLocation
OAuth2Util
genericUtils
VALID_TYPES
responses
all
BaseOpenAPIResponseUtil
BasePostmanResponseUtil
BaseResponseUtil
ContextResponseUtil
FullResponseUtil
GroupResponseUtil
IOpenAPIResponseContext
MediaTypeUtil
ResponseUtil
baseResponseUtils
BaseOpenAPIResponseUtil
BasePostmanResponseUtil
BaseResponseUtil
FullResponseUtil
IOpenAPIResponseContext
IPostmanResponseContext
contextResponseUtils
ContextResponseUtil
mediaTypeUtil
MediaTypeUtil
responseUtil
GroupResponseUtil
ResponseUtil
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R