webapi-parser
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Scalar
Shape
and
custom
Domain
Properties
data
Type
default
Value
default
Value
Str
deprecated
description
display
Name
documentation
examples
exclusive
Maximum
exclusive
Minimum
extends
Node
format
id
inherits
is
Default
Empty
is
Link
link
Label
link
Target
location
max
Length
maximum
min
Length
minimum
multiple
Of
name
not
or
pattern
position
read
Only
to
Json
Schema
values
write
Only
xml
Serialization
xone
annotations
graph
link
link
Copy
validate
with
And
with
Custom
Domain
Properties
with
Data
Type
with
Default
Str
with
Default
Value
with
Deprecated
with
Description
with
Display
Name
with
Documentation
with
Example
with
Examples
with
Exclusive
Maximum
with
Exclusive
Minimum
with
Extends
Node
with
Format
with
Id
with
Inherits
with
Link
Label
with
Link
Target
with
Max
Length
with
Maximum
with
Min
Length
with
Minimum
with
Multiple
Of
with
Name
with
Node
with
Or
with
Pattern
with
Read
Only
with
Values
with
Write
Only
withXMLSerialization
with
Xone
Hierarchy
AnyShape
ScalarShape
Implements
Annotable
Linkable
Index
Properties
and
custom
Domain
Properties
data
Type
default
Value
default
Value
Str
deprecated
description
display
Name
documentation
examples
exclusive
Maximum
exclusive
Minimum
extends
Node
format
id
inherits
is
Default
Empty
is
Link
link
Label
link
Target
location
max
Length
maximum
min
Length
minimum
multiple
Of
name
not
or
pattern
position
read
Only
to
Json
Schema
values
write
Only
xml
Serialization
xone
Methods
annotations
graph
link
link
Copy
validate
with
And
with
Custom
Domain
Properties
with
Data
Type
with
Default
Str
with
Default
Value
with
Deprecated
with
Description
with
Display
Name
with
Documentation
with
Example
with
Examples
with
Exclusive
Maximum
with
Exclusive
Minimum
with
Extends
Node
with
Format
with
Id
with
Inherits
with
Link
Label
with
Link
Target
with
Max
Length
with
Maximum
with
Min
Length
with
Minimum
with
Multiple
Of
with
Name
with
Node
with
Or
with
Pattern
with
Read
Only
with
Values
with
Write
Only
withXMLSerialization
with
Xone
Properties
and
and
:
Shape
[]
custom
Domain
Properties
custom
Domain
Properties
:
DomainExtension
[]
data
Type
data
Type
:
StrField
default
Value
default
Value
:
DataNode
default
Value
Str
default
Value
Str
:
StrField
deprecated
deprecated
:
BoolField
description
description
:
StrField
display
Name
display
Name
:
StrField
documentation
documentation
:
CreativeWork
examples
examples
:
Example
[]
exclusive
Maximum
exclusive
Maximum
:
BoolField
exclusive
Minimum
exclusive
Minimum
:
BoolField
extends
Node
extends
Node
:
DomainElement
[]
format
format
:
StrField
id
id
:
string
inherits
inherits
:
Shape
[]
is
Default
Empty
is
Default
Empty
:
string
is
Link
is
Link
:
boolean
link
Label
link
Label
:
StrField
link
Target
link
Target
:
DomainElement
|
undefined
location
location
:
string
max
Length
max
Length
:
IntField
maximum
maximum
:
DoubleField
min
Length
min
Length
:
IntField
minimum
minimum
:
DoubleField
multiple
Of
multiple
Of
:
DoubleField
name
name
:
StrField
not
not
:
Shape
or
or
:
Shape
[]
pattern
pattern
:
StrField
position
position
:
Range
read
Only
read
Only
:
BoolField
to
Json
Schema
to
Json
Schema
:
string
values
values
:
DataNode
[]
write
Only
write
Only
:
BoolField
xml
Serialization
xml
Serialization
:
XMLSerializer
xone
xone
:
Shape
[]
Methods
annotations
annotations
(
)
:
any
Returns
any
graph
graph
(
)
:
Graph
Returns
Graph
link
link
(
)
:
Shape
Returns
Shape
link
Copy
link
Copy
(
)
:
ScalarShape
Returns
ScalarShape
validate
validate
(
payload
:
string
)
:
Promise
<
ValidationReport
>
validate
(
fragment
:
PayloadFragment
)
:
Promise
<
ValidationReport
>
Parameters
payload:
string
Returns
Promise
<
ValidationReport
>
Parameters
fragment:
PayloadFragment
Returns
Promise
<
ValidationReport
>
with
And
with
And
(
subShapes
:
Shape
[]
)
:
this
Parameters
subShapes:
Shape
[]
Returns
this
with
Custom
Domain
Properties
with
Custom
Domain
Properties
(
extensions
:
DomainExtension
[]
)
:
this
Parameters
extensions:
DomainExtension
[]
Returns
this
with
Data
Type
with
Data
Type
(
dataType
:
string
)
:
this
Parameters
dataType:
string
Returns
this
with
Default
Str
with
Default
Str
(
value
:
string
)
:
this
Parameters
value:
string
Returns
this
with
Default
Value
with
Default
Value
(
default_
:
DataNode
)
:
this
Parameters
default_:
DataNode
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
Display
Name
with
Display
Name
(
name
:
string
)
:
this
Parameters
name:
string
Returns
this
with
Documentation
with
Documentation
(
documentation
:
CreativeWork
)
:
this
Parameters
documentation:
CreativeWork
Returns
this
with
Example
with
Example
(
mediaType
:
string
)
:
Example
Parameters
mediaType:
string
Returns
Example
with
Examples
with
Examples
(
examples
:
Example
[]
)
:
this
Parameters
examples:
Example
[]
Returns
this
with
Exclusive
Maximum
with
Exclusive
Maximum
(
max
:
boolean
)
:
this
Parameters
max:
boolean
Returns
this
with
Exclusive
Minimum
with
Exclusive
Minimum
(
min
:
boolean
)
:
this
Parameters
min:
boolean
Returns
this
with
Extends
Node
with
Extends
Node
(
extension
:
ParametrizedDeclaration
[]
)
:
this
Parameters
extension:
ParametrizedDeclaration
[]
Returns
this
with
Format
with
Format
(
format
:
string
)
:
this
Parameters
format:
string
Returns
this
with
Id
with
Id
(
id
:
string
)
:
this
Parameters
id:
string
Returns
this
with
Inherits
with
Inherits
(
inherits
:
Shape
[]
)
:
this
Parameters
inherits:
Shape
[]
Returns
this
with
Link
Label
with
Link
Label
(
label
:
string
)
:
this
Parameters
label:
string
Returns
this
with
Link
Target
with
Link
Target
(
target
:
Linkable
)
:
this
Parameters
target:
Linkable
Returns
this
with
Max
Length
with
Max
Length
(
max
:
number
)
:
this
Parameters
max:
number
Returns
this
with
Maximum
with
Maximum
(
max
:
number
)
:
this
Parameters
max:
number
Returns
this
with
Min
Length
with
Min
Length
(
min
:
number
)
:
this
Parameters
min:
number
Returns
this
with
Minimum
with
Minimum
(
min
:
number
)
:
this
Parameters
min:
number
Returns
this
with
Multiple
Of
with
Multiple
Of
(
multiple
:
number
)
:
this
Parameters
multiple:
number
Returns
this
with
Name
with
Name
(
name
:
string
)
:
this
Parameters
name:
string
Returns
this
with
Node
with
Node
(
shape
:
Shape
)
:
this
Parameters
shape:
Shape
Returns
this
with
Or
with
Or
(
subShapes
:
Shape
[]
)
:
this
Parameters
subShapes:
Shape
[]
Returns
this
with
Pattern
with
Pattern
(
pattern
:
string
)
:
this
Parameters
pattern:
string
Returns
this
with
Read
Only
with
Read
Only
(
readOnly
:
boolean
)
:
this
Parameters
readOnly:
boolean
Returns
this
with
Values
with
Values
(
values
:
DataNode
[]
)
:
this
Parameters
values:
DataNode
[]
Returns
this
with
Write
Only
with
Write
Only
(
writeOnly
:
boolean
)
:
this
Parameters
writeOnly:
boolean
Returns
this
withXMLSerialization
withXMLSerialization
(
xmlSerialization
:
XMLSerializer
)
:
this
Parameters
xmlSerialization:
XMLSerializer
Returns
this
with
Xone
with
Xone
(
subShapes
:
Shape
[]
)
:
this
Parameters
subShapes:
Shape
[]
Returns
this
Generated using
TypeDoc