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
Copy file name to clipboardExpand all lines: generator/README.md
+12-11
Original file line number
Diff line number
Diff line change
@@ -19,17 +19,18 @@ The `generator/config/*.yaml` files contains the list of operators and stages th
19
19
20
20
### Arguments
21
21
22
-
| Field | Type | Description |
23
-
|`name`|`string`| The name of the argument. It can start with `$` when the aggregation operator needs it, but it will be trimmed from the class property name. |
24
-
|`type`| list of `string`| The list of accepted types |
25
-
|`description`|`string`| The description of the argument from MongoDB's documentation. |
26
-
|`optional`|`boolean`| Whether the argument is optional or not. |
27
-
|`valueMin`|`number`| The minimum value for a numeric argument. |
28
-
|`valueMax`|`number`| The maximum value for a numeric argument. |
29
-
|`variadic`|`string`| If sent, the argument is variadic. Defines the format `array` for a list or `object` for a map |
30
-
|`variadicMin`|`integer`| The minimum number of arguments for a variadic parameter. |
31
-
|`default`|`scalar` or `array`| The default value for the argument. |
32
-
|`mergeObject`|`bool`| Default `false`. If `true`, the value must be an object and the properties of the value object are merged into the parent operator. `$group` stage uses it for the fields. |
|`name`|`string`| The name of the argument. If it starts with `$`, the dollar is trimmed from the class property name |
25
+
|`type`| list of `string`| The list of accepted types |
26
+
|`description`|`string`| The description of the argument from MongoDB's documentation |
27
+
|`optional`|`boolean`| Whether the argument is optional or not |
28
+
|`valueMin`|`number`| The minimum value for a numeric argument |
29
+
|`valueMax`|`number`| The maximum value for a numeric argument |
30
+
|`variadic`|`string`| If sent, the argument is variadic. Defines the format `array` for a list or `object` for a map |
31
+
|`variadicMin`|`integer`| The minimum number of arguments for a variadic parameter |
32
+
|`default`|`scalar` or `array`| The default value for the argument |
33
+
|`mergeObject`|`bool`| Default `false`. If `true`, the value must be an object and the properties of the value object are merged into the parent operator. `$group` stage uses it for the fields |
0 commit comments