webapi-parser
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Parameter
allow
Empty
Value
allow
Reserved
binding
custom
Domain
Properties
deprecated
description
examples
explode
extends
Node
id
name
payloads
position
required
schema
style
annotations
graph
with
Allow
Empty
Value
with
Allow
Reserved
with
Binding
with
Custom
Domain
Properties
with
Deprecated
with
Description
with
Example
with
Examples
with
Explode
with
Extends
Node
with
Id
with
Name
with
Object
Schema
with
Payload
with
Payloads
with
Required
with
Scalar
Schema
with
Schema
with
Style
Hierarchy
DomainElement
Parameter
Implements
Annotable
Index
Properties
allow
Empty
Value
allow
Reserved
binding
custom
Domain
Properties
deprecated
description
examples
explode
extends
Node
id
name
payloads
position
required
schema
style
Methods
annotations
graph
with
Allow
Empty
Value
with
Allow
Reserved
with
Binding
with
Custom
Domain
Properties
with
Deprecated
with
Description
with
Example
with
Examples
with
Explode
with
Extends
Node
with
Id
with
Name
with
Object
Schema
with
Payload
with
Payloads
with
Required
with
Scalar
Schema
with
Schema
with
Style
Properties
allow
Empty
Value
allow
Empty
Value
:
BoolField
allow
Reserved
allow
Reserved
:
BoolField
binding
binding
:
StrField
custom
Domain
Properties
custom
Domain
Properties
:
DomainExtension
[]
deprecated
deprecated
:
BoolField
description
description
:
StrField
examples
examples
:
Example
[]
explode
explode
:
BoolField
extends
Node
extends
Node
:
DomainElement
[]
id
id
:
string
name
name
:
StrField
payloads
payloads
:
Payload
[]
position
position
:
Range
required
required
:
BoolField
schema
schema
:
Shape
style
style
:
StrField
Methods
annotations
annotations
(
)
:
any
Returns
any
graph
graph
(
)
:
Graph
Returns
Graph
with
Allow
Empty
Value
with
Allow
Empty
Value
(
allowEmptyValue
:
boolean
)
:
this
Parameters
allowEmptyValue:
boolean
Returns
this
with
Allow
Reserved
with
Allow
Reserved
(
allowReserved
:
boolean
)
:
this
Parameters
allowReserved:
boolean
Returns
this
with
Binding
with
Binding
(
binding
:
string
)
:
this
Parameters
binding:
string
Returns
this
with
Custom
Domain
Properties
with
Custom
Domain
Properties
(
extensions
:
DomainExtension
[]
)
:
this
Parameters
extensions:
DomainExtension
[]
Returns
this
with
Deprecated
with
Deprecated
(
deprecated
:
boolean
)
:
this
Parameters
deprecated:
boolean
Returns
this
with
Description
with
Description
(
description
:
string
)
:
this
Parameters
description:
string
Returns
this
with
Example
with
Example
(
name
:
string
)
:
Example
Parameters
name:
string
Returns
Example
with
Examples
with
Examples
(
examples
:
Example
[]
)
:
this
Parameters
examples:
Example
[]
Returns
this
with
Explode
with
Explode
(
explode
:
boolean
)
:
this
Parameters
explode:
boolean
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
Object
Schema
with
Object
Schema
(
name
:
string
)
:
NodeShape
Parameters
name:
string
Returns
NodeShape
with
Payload
with
Payload
(
mediaType
:
string
)
:
Payload
Parameters
mediaType:
string
Returns
Payload
with
Payloads
with
Payloads
(
payloads
:
Payload
[]
)
:
this
Parameters
payloads:
Payload
[]
Returns
this
with
Required
with
Required
(
required
:
boolean
)
:
this
Parameters
required:
boolean
Returns
this
with
Scalar
Schema
with
Scalar
Schema
(
name
:
string
)
:
ScalarShape
Parameters
name:
string
Returns
ScalarShape
with
Schema
with
Schema
(
schema
:
Shape
)
:
this
Parameters
schema:
Shape
Returns
this
with
Style
with
Style
(
style
:
string
)
:
this
Parameters
style:
string
Returns
this
Generated using
TypeDoc