Preparing search index...
The search index is not available
@novice1/api-doc-generator - v0.2.5
@novice1/api-doc-generator
generators/openapi/definitions
ComponentsObject
Interface ComponentsObject
interface
ComponentsObject
{
callbacks
?:
Record
<
string
,
unknown
>
;
examples
?:
Record
<
string
,
ReferenceObject
|
ExampleObject
>
;
headers
?:
Record
<
string
,
ReferenceObject
|
HeaderObject
>
;
links
?:
Record
<
string
,
ReferenceObject
|
LinkObject
>
;
parameters
?:
Record
<
string
,
ReferenceObject
|
ParameterObject
>
;
requestBodies
?:
Record
<
string
,
ReferenceObject
|
RequestBodyObject
>
;
responses
?:
Record
<
string
,
ReferenceObject
|
ResponseObject
>
;
schemas
?:
Record
<
string
,
SchemaObject
|
ReferenceObject
>
;
securitySchemes
?:
Record
<
string
,
ReferenceObject
|
SecuritySchemeObject
>
;
[
key
:
string
]
:
unknown
;
}
Indexable
[
key:
string
]:
unknown
Index
Properties
callbacks?
examples?
headers?
links?
parameters?
request
Bodies?
responses?
schemas?
security
Schemes?
Properties
Optional
callbacks
callbacks
?:
Record
<
string
,
unknown
>
Optional
examples
examples
?:
Record
<
string
,
ReferenceObject
|
ExampleObject
>
Optional
headers
headers
?:
Record
<
string
,
ReferenceObject
|
HeaderObject
>
Optional
links
links
?:
Record
<
string
,
ReferenceObject
|
LinkObject
>
Optional
parameters
parameters
?:
Record
<
string
,
ReferenceObject
|
ParameterObject
>
Optional
request
Bodies
request
Bodies
?:
Record
<
string
,
ReferenceObject
|
RequestBodyObject
>
Optional
responses
responses
?:
Record
<
string
,
ReferenceObject
|
ResponseObject
>
Optional
schemas
schemas
?:
Record
<
string
,
SchemaObject
|
ReferenceObject
>
Optional
security
Schemes
security
Schemes
?:
Record
<
string
,
ReferenceObject
|
SecuritySchemeObject
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
callbacks
examples
headers
links
parameters
request
Bodies
responses
schemas
security
Schemes
@novice1/api-doc-generator - v0.2.5
Loading...