Skip to content

Commit 19389e9

Browse files
Add summary property to CliInfo Object
Closes #43
1 parent 8eb3de4 commit 19389e9

3 files changed

Lines changed: 8 additions & 0 deletions

File tree

draft.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ This is the root object of the OpenCLI Description.
110110
| Field Name | Type | Description |
111111
|------------|:----:|-------------|
112112
| title | `string` | **REQUIRED** The application title |
113+
| summary | `string` | A short summary of the application |
113114
| description | `string` | A description of the application |
114115
| contact | [Contact Object](#contact-object) | The contact information |
115116
| license | [License Object](#license-object) | The application license |

schema.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@
7575
"type": "string",
7676
"description": "The application title"
7777
},
78+
"summary": {
79+
"type": "string",
80+
"description": "A short summary of the application"
81+
},
7882
"description": {
7983
"type": "string",
8084
"description": "A description of the application"

typespec/main.tsp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ model CliInfo {
4141
@doc("The application title")
4242
title: string;
4343

44+
@doc("A short summary of the application")
45+
summary?: string;
46+
4447
@doc("A description of the application")
4548
description?: string;
4649

0 commit comments

Comments
 (0)