Parameter Attributes
Parameter attributes define a URI parameter matching patterns.
- Use On
Action
- Cardinality
*
Alpha
Alphabetic characters.
Parameter | Type | Description | Default |
|---|---|---|---|
name | string | Parameter name | <Required> |
length | array|int|null | null (any length) | |
case | Whether characters must be lowercase, uppercase, or can be either | AlphaCase::insensitive (can be lowercase or uppercase) |
Alphanumeric
Alphabetic characters and digits.
Parameter | Type | Description | Default |
|---|---|---|---|
name | string | Parameter name | <Required> |
length | array|int|null | null (any length) | |
firstChar | The type of the first character | FirstChar::alphanumeric (can be alphabetic or a digit) | |
case | Whether characters must be lowercase, uppercase, or can be either | AlphaCase::insensitive (can be lowercase or uppercase) |
Hex
Parameter contains hexadecimal characters.
Parameter | Type | Description | Default |
|---|---|---|---|
name | string | Parameter name | <Required> |
length | array|int|null | null (any length) | |
nonZero | bool | Whether the number must be non-zero | false (zero is allowed) |
case | Whether characters must be lowercase, uppercase, or can be either | AlphaCase::insensitive (can be lowercase or uppercase) |
Id
A number with a minimum value of 1; e.g. database autoincrement value.
Parameter | Type | Description | Default |
|---|---|---|---|
name | string | Parameter name | <Required> |
In
Parameter must be one of the provided options.
Parameter | Type | Description | Default |
|---|---|---|---|
name | string | Parameter name | <Required> |
options | string[] | Options to match | <Required> |
Numeric
Numeric digits.
Parameter | Type | Description | Default |
|---|---|---|---|
name | string | Parameter name | <Required> |
length | array|int|null | null (any length) | |
nonZero | bool | Whether the number must be non-zero | false (zero is allowed) |
Pattern
Specifies the pattern the parameter must match.
Parameter | Type | Description | Default |
|---|---|---|---|
name | string | Parameter name | <Required> |
pattern | string | Regex to match | <Required> |
Uuid
A Universally Unique Identifier (aka Globally Unique Identifier (GUID)).
Parameter | Type | Description | Default |
|---|---|---|---|
name | string | Parameter name | <Required> |
case | Whether characters must be lowercase, uppercase, or can be either | AlphaCase::insensitive (can be lowercase or uppercase) |
Parameter Resources
These are used in some attribute parameter definitions.
AlphaCase
AlphaCase is an Enumeration that specifies the case of a parameter's alphabetic characters.
The enumerations are:
- AlphaCase::insensitive
Characters can be lowercase or uppercase
- AlphaCase::lower
Characters must be lowercase
- AlphaCase::upper
Characters must be uppercase
FirstChar
FirstChar is an Enumeration that specifies the type the first character an alphanumeric parameter.
The enumerations are:
- FirstChar::alpha
First character must be alphabetic
- FirstChar::alphanumeric
First character can be alphabetic or a digit
- FirstChar::numeric
First character must be numeric
Length Definition
- array{max?: int, min?: int}
The maximum and/or minimum number of characters.
- int
The number of characters
- null
Any length