Skip to content

Commit 1ad9390

Browse files
GH-30: Add name property to items
Closes #30
1 parent ab7c240 commit 1ad9390

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

draft.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ This is the root object of the OpenCLI Description.
140140

141141
| Field Name | Type | Description |
142142
|------------|:----:|-------------|
143+
| name | `string` | **REQUIRED** The command name |
143144
| aliases | `string` | The command aliases |
144145
| options | [[Option Object](#option-object)] | The command's options |
145146
| arguments | [[Argument Object](#argument-object)] | The command's arguments |
@@ -155,6 +156,7 @@ This is the root object of the OpenCLI Description.
155156

156157
| Field Name | Type | Description |
157158
|------------|:----:|-------------|
159+
| name | `string` | **REQUIRED** The argument name |
158160
| required | `bool` | Whether or not the argument is required |
159161
| ordinal | `int` | The relative position to other arguments |
160162
| arity | [Arity Object](#arity-object) | The argument arity. Arity defines the minimum and maximum number of argument values |
@@ -168,6 +170,7 @@ This is the root object of the OpenCLI Description.
168170

169171
| Field Name | Type | Description |
170172
|------------|:----:|-------------|
173+
| name | `string` | **REQUIRED** The option name |
171174
| required | `bool` | Whether or not the option is required |
172175
| aliases | [`string`] | The option's aliases |
173176
| arguments | [[Argument](#argument-object)] | The option's arguments |

0 commit comments

Comments
 (0)