You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describes a map of parameters included in a channel name.
1017
+
Describes a map of parameters included in a channel address.
1018
1018
1019
-
This map MUST contain all the parameters used in the parent channel name.
1019
+
This map MUST contain all the parameters used in the parent channel address.
1020
1020
1021
1021
##### Patterned Fields
1022
1022
1023
1023
Field Pattern | Type | Description
1024
1024
---|:---:|---
1025
-
<a name="parametersObjectName"></a>`^[A-Za-z0-9_\-]+$` | [Parameter Object](#parameterObject) | [Reference Object](#referenceObject) | The key represents the name of the parameter. It MUST match the parameter name used in the parent channel name.
1025
+
<a name="parametersObjectName"></a>`^[A-Za-z0-9_\-]+$` | [Parameter Object](#parameterObject) | [Reference Object](#referenceObject) | The key represents the name of the parameter. It MUST match the parameter name used in the parent channel address.
Describes a parameter included in a channel address.
1068
1054
1069
1055
##### Fixed Fields
1070
1056
1071
1057
Field Name | Type | Description
1072
1058
---|:---:|---
1073
-
<a name="parameterObjectDescription"></a>description | `string` | A verbose explanation of the parameter. [CommonMark syntax](https://spec.commonmark.org/) can be used for rich text representation.
1074
-
<a name="parameterObjectSchema"></a>schema | [Schema Object](#schemaObject) \| [Reference Object](#referenceObject) | Definition of the parameter.
1075
-
location | `string` | A [runtime expression](#runtimeExpression) that specifies the location of the parameter value. Even when a definition for the target field exists, it MUST NOT be used to validate this parameter but, instead, the `schema` property MUST be used.
1059
+
<a name="parameterObjectEnum"></a>enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set.
1060
+
<a name="parameterObjectDefault"></a>default | `string` | The default value to use for substitution, and to send, if an alternate value is _not_ supplied.
1061
+
<a name="parameterObjectDescription"></a>description | `string` | An optional description for the parameter. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
1062
+
<a name="parameterObjectExamples"></a>examples | [`string`] | An array of examples of the parameter value.
1063
+
<a name="parameterObjectLocation"></a>location | `string` | A [runtime expression](#runtimeExpression) that specifies the location of the parameter value.
1076
1064
1077
1065
This object MAY be extended with [Specification Extensions](#specificationExtensions).
0 commit comments