Denotes whether a GNParam is a path
, header
, or query
/body
parameter.
A PType that the Param adheres to.
A description of what the Param entails.
Whether or not it is mandator to set this Param.
If true
, this param is publicly. Good for Params that are set by the backend.
A plain-object that describes all the ways in which a GNParam is matched. This
for params
that takes a multitude of specific string-formats
and dismiss any that
do not conform.
{
matches: {
"URL": "A valid URL-String (^https?://(?:\\b[\\w_-]\\b\\.)+[a-z]+(?:\\/[\\w%&=_-])\\/?$)",
"IP": "A valid URL-String (^\\b((\\d|1\\d{1,2}|2([0-4]\\d|5[0-5]))(\\.|$)){4}\\b$)",
}
}
A Parameter Description Documenter for
GNParams
or GNHeaders.