From 19389e9db9fabf39713f84cd628e6063525e245d Mon Sep 17 00:00:00 2001 From: Patrik Svensson Date: Wed, 6 Aug 2025 02:06:54 +0200 Subject: [PATCH] Add `summary` property to `CliInfo Object` Closes #43 --- draft.md | 1 + schema.json | 4 ++++ typespec/main.tsp | 3 +++ 3 files changed, 8 insertions(+) diff --git a/draft.md b/draft.md index 2bd770b..f8c60a2 100644 --- a/draft.md +++ b/draft.md @@ -110,6 +110,7 @@ This is the root object of the OpenCLI Description. | Field Name | Type | Description | |------------|:----:|-------------| | title | `string` | **REQUIRED** The application title | +| summary | `string` | A short summary of the application | | description | `string` | A description of the application | | contact | [Contact Object](#contact-object) | The contact information | | license | [License Object](#license-object) | The application license | diff --git a/schema.json b/schema.json index b948c98..abe3ae6 100644 --- a/schema.json +++ b/schema.json @@ -75,6 +75,10 @@ "type": "string", "description": "The application title" }, + "summary": { + "type": "string", + "description": "A short summary of the application" + }, "description": { "type": "string", "description": "A description of the application" diff --git a/typespec/main.tsp b/typespec/main.tsp index c89c346..c713727 100644 --- a/typespec/main.tsp +++ b/typespec/main.tsp @@ -41,6 +41,9 @@ model CliInfo { @doc("The application title") title: string; + @doc("A short summary of the application") + summary?: string; + @doc("A description of the application") description?: string;