webapi-parser
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Node
Shape
and
closed
custom
Domain
Properties
custom
Shape
Properties
custom
Shape
Property
Definitions
default
Value
default
Value
Str
dependencies
deprecated
description
discriminator
discriminator
Value
display
Name
documentation
examples
extends
Node
id
inherits
is
Default
Empty
is
Link
link
Label
link
Target
location
max
Properties
min
Properties
name
not
or
position
properties
read
Only
to
Json
Schema
values
write
Only
xml
Serialization
xone
annotations
graph
link
link
Copy
validate
with
And
with
Closed
with
Custom
Domain
Properties
with
Custom
Shape
Properties
with
Custom
Shape
Property
with
Custom
Shape
Property
Definition
with
Custom
Shape
Property
Definitions
with
Default
Str
with
Default
Value
with
Dependencies
with
Dependency
with
Deprecated
with
Description
with
Discriminator
with
Discriminator
Value
with
Display
Name
with
Documentation
with
Example
with
Examples
with
Extends
Node
with
Id
with
Inherits
with
Inherits
Object
with
Inherits
Scalar
with
Link
Label
with
Link
Target
with
Max
Properties
with
Min
Properties
with
Name
with
Node
with
Or
with
Properties
with
Property
with
Read
Only
with
Values
with
Write
Only
withXMLSerialization
with
Xone
Hierarchy
AnyShape
NodeShape
Implements
Annotable
Linkable
Index
Properties
and
closed
custom
Domain
Properties
custom
Shape
Properties
custom
Shape
Property
Definitions
default
Value
default
Value
Str
dependencies
deprecated
description
discriminator
discriminator
Value
display
Name
documentation
examples
extends
Node
id
inherits
is
Default
Empty
is
Link
link
Label
link
Target
location
max
Properties
min
Properties
name
not
or
position
properties
read
Only
to
Json
Schema
values
write
Only
xml
Serialization
xone
Methods
annotations
graph
link
link
Copy
validate
with
And
with
Closed
with
Custom
Domain
Properties
with
Custom
Shape
Properties
with
Custom
Shape
Property
with
Custom
Shape
Property
Definition
with
Custom
Shape
Property
Definitions
with
Default
Str
with
Default
Value
with
Dependencies
with
Dependency
with
Deprecated
with
Description
with
Discriminator
with
Discriminator
Value
with
Display
Name
with
Documentation
with
Example
with
Examples
with
Extends
Node
with
Id
with
Inherits
with
Inherits
Object
with
Inherits
Scalar
with
Link
Label
with
Link
Target
with
Max
Properties
with
Min
Properties
with
Name
with
Node
with
Or
with
Properties
with
Property
with
Read
Only
with
Values
with
Write
Only
withXMLSerialization
with
Xone
Properties
and
and
:
Shape
[]
closed
closed
:
BoolField
custom
Domain
Properties
custom
Domain
Properties
:
DomainExtension
[]
custom
Shape
Properties
custom
Shape
Properties
:
PropertyShape
[]
custom
Shape
Property
Definitions
custom
Shape
Property
Definitions
:
PropertyShape
[]
default
Value
default
Value
:
DataNode
default
Value
Str
default
Value
Str
:
StrField
dependencies
dependencies
:
PropertyDependencies
[]
deprecated
deprecated
:
BoolField
description
description
:
StrField
discriminator
discriminator
:
StrField
discriminator
Value
discriminator
Value
:
StrField
display
Name
display
Name
:
StrField
documentation
documentation
:
CreativeWork
examples
examples
:
Example
[]
extends
Node
extends
Node
:
DomainElement
[]
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
Properties
max
Properties
:
IntField
min
Properties
min
Properties
:
IntField
name
name
:
StrField
not
not
:
Shape
or
or
:
Shape
[]
position
position
:
Range
properties
properties
:
PropertyShape
[]
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
(
)
:
AnyShape
Returns
AnyShape
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
Closed
with
Closed
(
closed
:
boolean
)
:
this
Parameters
closed:
boolean
Returns
this
with
Custom
Domain
Properties
with
Custom
Domain
Properties
(
extensions
:
DomainExtension
[]
)
:
this
Parameters
extensions:
DomainExtension
[]
Returns
this
with
Custom
Shape
Properties
with
Custom
Shape
Properties
(
properties
:
PropertyShape
[]
)
:
this
Parameters
properties:
PropertyShape
[]
Returns
this
with
Custom
Shape
Property
with
Custom
Shape
Property
(
name
:
string
)
:
PropertyShape
Parameters
name:
string
Returns
PropertyShape
with
Custom
Shape
Property
Definition
with
Custom
Shape
Property
Definition
(
name
:
string
)
:
PropertyShape
Parameters
name:
string
Returns
PropertyShape
with
Custom
Shape
Property
Definitions
with
Custom
Shape
Property
Definitions
(
properties
:
PropertyShape
[]
)
:
this
Parameters
properties:
PropertyShape
[]
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
Dependencies
with
Dependencies
(
dependencies
:
PropertyDependencies
[]
)
:
this
Parameters
dependencies:
PropertyDependencies
[]
Returns
this
with
Dependency
with
Dependency
(
)
:
PropertyDependencies
Returns
PropertyDependencies
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
Discriminator
with
Discriminator
(
discriminator
:
string
)
:
this
Parameters
discriminator:
string
Returns
this
with
Discriminator
Value
with
Discriminator
Value
(
value
:
string
)
:
this
Parameters
value:
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
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
Inherits
with
Inherits
(
inherits
:
Shape
[]
)
:
this
Parameters
inherits:
Shape
[]
Returns
this
with
Inherits
Object
with
Inherits
Object
(
name
:
string
)
:
NodeShape
Parameters
name:
string
Returns
NodeShape
with
Inherits
Scalar
with
Inherits
Scalar
(
name
:
string
)
:
ScalarShape
Parameters
name:
string
Returns
ScalarShape
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
Properties
with
Max
Properties
(
max
:
number
)
:
this
Parameters
max:
number
Returns
this
with
Min
Properties
with
Min
Properties
(
min
:
number
)
:
this
Parameters
min:
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
Properties
with
Properties
(
properties
:
PropertyShape
[]
)
:
this
Parameters
properties:
PropertyShape
[]
Returns
this
with
Property
with
Property
(
name
:
string
)
:
PropertyShape
Parameters
name:
string
Returns
PropertyShape
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