webapi-parser
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Security
Scheme
custom
Domain
Properties
description
display
Name
extends
Node
headers
id
is
Link
link
Label
link
Target
name
position
query
Parameters
query
String
responses
settings
type
annotations
graph
link
link
Copy
with
Api
Key
Settings
with
Custom
Domain
Properties
with
Default
Settings
with
Description
with
Display
Name
with
Extends
Node
with
Header
with
Headers
with
Http
Settings
with
Id
with
Link
Label
with
Link
Target
with
Name
withOAuth1
Settings
withOAuth2
Settings
with
Open
IdConnect
Settings
with
Query
Parameter
with
Query
Parameters
with
Query
String
with
Response
with
Responses
with
Settings
with
Type
Hierarchy
DomainElement
SecurityScheme
Implements
Annotable
Linkable
Index
Properties
custom
Domain
Properties
description
display
Name
extends
Node
headers
id
is
Link
link
Label
link
Target
name
position
query
Parameters
query
String
responses
settings
type
Methods
annotations
graph
link
link
Copy
with
Api
Key
Settings
with
Custom
Domain
Properties
with
Default
Settings
with
Description
with
Display
Name
with
Extends
Node
with
Header
with
Headers
with
Http
Settings
with
Id
with
Link
Label
with
Link
Target
with
Name
withOAuth1
Settings
withOAuth2
Settings
with
Open
IdConnect
Settings
with
Query
Parameter
with
Query
Parameters
with
Query
String
with
Response
with
Responses
with
Settings
with
Type
Properties
custom
Domain
Properties
custom
Domain
Properties
:
DomainExtension
[]
description
description
:
StrField
display
Name
display
Name
:
StrField
extends
Node
extends
Node
:
DomainElement
[]
headers
headers
:
Parameter
[]
id
id
:
string
is
Link
is
Link
:
boolean
link
Label
link
Label
:
StrField
link
Target
link
Target
:
DomainElement
|
undefined
name
name
:
StrField
position
position
:
Range
query
Parameters
query
Parameters
:
Parameter
[]
query
String
query
String
:
Shape
responses
responses
:
Response
[]
settings
settings
:
Settings
type
type
:
StrField
Methods
annotations
annotations
(
)
:
any
Returns
any
graph
graph
(
)
:
Graph
Returns
Graph
link
link
(
)
:
SecurityScheme
Returns
SecurityScheme
link
Copy
link
Copy
(
)
:
Linkable
Returns
Linkable
with
Api
Key
Settings
with
Api
Key
Settings
(
)
:
ApiKeySettings
Returns
ApiKeySettings
with
Custom
Domain
Properties
with
Custom
Domain
Properties
(
extensions
:
DomainExtension
[]
)
:
this
Parameters
extensions:
DomainExtension
[]
Returns
this
with
Default
Settings
with
Default
Settings
(
)
:
Settings
Returns
Settings
with
Description
with
Description
(
description
:
string
)
:
this
Parameters
description:
string
Returns
this
with
Display
Name
with
Display
Name
(
displayName
:
string
)
:
this
Parameters
displayName:
string
Returns
this
with
Extends
Node
with
Extends
Node
(
extension
:
ParametrizedDeclaration
[]
)
:
this
Parameters
extension:
ParametrizedDeclaration
[]
Returns
this
with
Header
with
Header
(
name
:
string
)
:
Parameter
Parameters
name:
string
Returns
Parameter
with
Headers
with
Headers
(
headers
:
Parameter
[]
)
:
this
Parameters
headers:
Parameter
[]
Returns
this
with
Http
Settings
with
Http
Settings
(
)
:
HttpSettings
Returns
HttpSettings
with
Id
with
Id
(
id
:
string
)
:
this
Parameters
id:
string
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
Name
with
Name
(
name
:
string
)
:
this
Parameters
name:
string
Returns
this
withOAuth1
Settings
withOAuth1
Settings
(
)
:
OAuth1Settings
Returns
OAuth1Settings
withOAuth2
Settings
withOAuth2
Settings
(
)
:
OAuth2Settings
Returns
OAuth2Settings
with
Open
IdConnect
Settings
with
Open
IdConnect
Settings
(
)
:
OpenIdConnectSettings
Returns
OpenIdConnectSettings
with
Query
Parameter
with
Query
Parameter
(
name
:
string
)
:
Parameter
Parameters
name:
string
Returns
Parameter
with
Query
Parameters
with
Query
Parameters
(
queryParameters
:
Parameter
[]
)
:
this
Parameters
queryParameters:
Parameter
[]
Returns
this
with
Query
String
with
Query
String
(
queryString
:
Shape
)
:
this
Parameters
queryString:
Shape
Returns
this
with
Response
with
Response
(
name
:
string
)
:
Response
Parameters
name:
string
Returns
Response
with
Responses
with
Responses
(
responses
:
Response
[]
)
:
this
Parameters
responses:
Response
[]
Returns
this
with
Settings
with
Settings
(
settings
:
Settings
)
:
this
Parameters
settings:
Settings
Returns
this
with
Type
with
Type
(
type
:
string
)
:
this
Parameters
type:
string
Returns
this
Generated using
TypeDoc