Creates an instance of Helper.
The JSON-formatted API Documentation.
Access or Subscribe default DocKindMaps
, CLHeaders
, and GNParams
Access or Subscribe default DocKindMaps
, CLHeaders
, and GNParams
Formats an JSON object for Error Messages
The erroring Property
The erroring Object
The error message object
Accesses a Help Document for responses
The namespace the Route belongs to
The name of the Route
Initializes the creation of a Route Documentation
The namespace the Route belongs to
Formats and subscribes a Route Documentation
The namespace the Route belongs to
The parent-Routes of this Route
The name of this Route
The Method of the Route being documented
The Route to be documented
Finalizes the Documentation by adding the API-Doc route.
The name of the documentation route.
Splits a path pattern to an Array
of separate paths
The RegexP
path to parse
Generates an Array
of path-parameter Arrays
, based on the provider schemes
An Array
of path schemes
Formats a Param-Reference Key based on the Specfied name
& ref
The Name of the Param
The Param
Reference
A formatted Reference Key; or false
, if invalid
Checks if a Reference-Key
matches any defined Param-References
The Param-Reference
Key
An option Param-Reference
collection (for speed)
Get an aliased Reference-Key
The Param-Reference
Key
The real Param-Reference
Key
Get a Reference-Key
The Param-Reference
Key
An option Param-Reference
collection (for speed)
The real Param-Reference
Key
Returns an appropriate Object
of in
-values, given the specified method
.
A value specifiying a Request Method
Generates an appropriate Function
to designate parameters, given the specified method
.
A value specifiying a Request Method
A param retrieval function
Converts API configurations into a JSON Documentation