webapi-parser
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
End
Point
custom
Domain
Properties
description
extends
Node
id
name
operations
parameters
path
payloads
position
relative
Path
security
servers
summary
annotations
graph
with
Custom
Domain
Properties
with
Description
with
Extends
Node
with
Id
with
Name
with
Operation
with
Operations
with
Parameter
with
Parameters
with
Path
with
Payload
with
Payloads
with
Security
with
Server
with
Servers
with
Summary
Hierarchy
DomainElement
EndPoint
Implements
Annotable
Index
Properties
custom
Domain
Properties
description
extends
Node
id
name
operations
parameters
path
payloads
position
relative
Path
security
servers
summary
Methods
annotations
graph
with
Custom
Domain
Properties
with
Description
with
Extends
Node
with
Id
with
Name
with
Operation
with
Operations
with
Parameter
with
Parameters
with
Path
with
Payload
with
Payloads
with
Security
with
Server
with
Servers
with
Summary
Properties
custom
Domain
Properties
custom
Domain
Properties
:
DomainExtension
[]
description
description
:
StrField
extends
Node
extends
Node
:
DomainElement
[]
id
id
:
string
name
name
:
StrField
operations
operations
:
Operation
[]
parameters
parameters
:
Parameter
[]
path
path
:
StrField
payloads
payloads
:
Payload
[]
position
position
:
Range
relative
Path
relative
Path
:
string
security
security
:
SecurityRequirement
[]
servers
servers
:
Server
[]
summary
summary
:
StrField
Methods
annotations
annotations
(
)
:
any
Returns
any
graph
graph
(
)
:
Graph
Returns
Graph
with
Custom
Domain
Properties
with
Custom
Domain
Properties
(
extensions
:
DomainExtension
[]
)
:
this
Parameters
extensions:
DomainExtension
[]
Returns
this
with
Description
with
Description
(
description
:
string
)
:
this
Parameters
description:
string
Returns
this
with
Extends
Node
with
Extends
Node
(
extension
:
ParametrizedDeclaration
[]
)
:
this
Parameters
extension:
ParametrizedDeclaration
[]
Returns
this
with
Id
with
Id
(
id
:
string
)
:
this
Parameters
id:
string
Returns
this
with
Name
with
Name
(
name
:
string
)
:
this
Parameters
name:
string
Returns
this
with
Operation
with
Operation
(
method
:
string
)
:
Operation
Parameters
method:
string
Returns
Operation
with
Operations
with
Operations
(
operations
:
Operation
[]
)
:
this
Parameters
operations:
Operation
[]
Returns
this
with
Parameter
with
Parameter
(
name
:
string
)
:
Parameter
Parameters
name:
string
Returns
Parameter
with
Parameters
with
Parameters
(
parameters
:
Parameter
[]
)
:
this
Parameters
parameters:
Parameter
[]
Returns
this
with
Path
with
Path
(
path
:
string
)
:
this
Parameters
path:
string
Returns
this
with
Payload
with
Payload
(
name
:
string
)
:
Payload
Parameters
name:
string
Returns
Payload
with
Payloads
with
Payloads
(
payloads
:
Payload
[]
)
:
this
Parameters
payloads:
Payload
[]
Returns
this
with
Security
with
Security
(
security
:
SecurityRequirement
[]
)
:
this
Parameters
security:
SecurityRequirement
[]
Returns
this
with
Server
with
Server
(
url
:
string
)
:
Server
Parameters
url:
string
Returns
Server
with
Servers
with
Servers
(
servers
:
Server
[]
)
:
this
Parameters
servers:
Server
[]
Returns
this
with
Summary
with
Summary
(
summary
:
string
)
:
this
Parameters
summary:
string
Returns
this
Generated using
TypeDoc