$helperMethod
Protocols used by the API. Returns the protocols
property value if it is specified.
Otherwise, returns protocol, specified in the base URI.
$meta{"deprecated":true}
$helperMethod Retrieve all resource types including those defined in libraries $meta{"deprecated":true}
$helperMethod
Returns security schemes, resource or method is secured with. If no security schemes are set at resource or method level,
returns schemes defined with securedBy
at API level.
$meta{"deprecated":true}
$helperMethod
Retrieve an ordered list of all base uri parameters regardless of whether they are described in baseUriParameters
or not
Consider a fragment of RAML specification:
version: v1
baseUri: https://{organization}.example.com/{version}/{service}
baseUriParameters:
service:
Here version
and organization
are base uri parameters which are not described in the baseUriParameters
node,
Thus, they are not among Api.baseUriParameters()
, but they are among Api.allBaseUriParameters()
.
$meta={"name":"allBaseUriParameters","deprecated":true}
$helperMethod
Retrieve an ordered list of all base uri parameters regardless of whether they are described in baseUriParameters
or not
Consider a fragment of RAML specification:
version: v1
baseUri: https://{organization}.example.com/{version}/{service}
baseUriParameters:
service:
Here version
and organization
are base uri parameters which are not described in the baseUriParameters
node,
but they are among Api.baseUriParameters()
.
$meta={"name":"baseUriParameters","override":true}
$helperMethod $meta={"name":"parametrizedProperties","primary":true}
$helperMethod
For methods of Resources: {parent Resource relative path} {methodName}
.
For methods of ResourceTypes: {parent ResourceType name} {methodName}
.
For other methods throws Exception.
//$helperMethod
Protocols used by the API. Returns the protocols
property value if it is specified.
Otherwise, returns protocol, specified in the base URI.
$meta__={"name":"protocols","override":true}
$helperMethod $meta={"name":"name","primary":true}
$helperMethod $meta={"name":"resourceType","primary":true}
$helperMethod $meta{"name":"resourceTypes","override":true}
$helperMethod $meta={"primary":true}
//$helperMethod
Returns security schemes, resource or method is secured with. If no security schemes are set at resource or method level,
returns schemes defined with securedBy
at API level.
$meta__={"name":"securedBy","override":true}
$helperMethod $meta={"primary":true}
$helperMethod $meta={"primary":true}
$helperMethod $meta={"primary":true}
$helperMethod
Retrieve an ordered list of all uri parameters including those which are not described in the uriParameters
node.
Consider a fragment of RAML specification:
/resource/{objectId}/{propertyId}:
uriParameters:
objectId:
Here propertyId
uri parameter is not described in the uriParameters
node,
Thus, it is not among Resource.uriParameters(), but it is among Resource.allUriParameters().
$meta={"name":"allUriParameters","deprecated":true}
$helperMethod
Retrieve an ordered list of all uri parameters including those which are not described in the uriParameters
node.
Consider a fragment of RAML specification:
/resource/{objectId}/{propertyId}:
uriParameters:
objectId:
Here propertyId
uri parameter is not described in the uriParameters
node,
but it is among Resource.uriParameters().
$meta={"name":"uriParameters","override": true}
Generated using TypeDoc
$helperMethod $meta={"primary":true}