Skip to content

Commit ed37c7f

Browse files
ioggstreamPhil Sturgeon
authored and
Phil Sturgeon
committed
832 add info.summary (#1779)
* Fix: #832. Add info.summary. * Fix: summary is shord, description is verbose. Be consistent with other definitions of summary and description.
1 parent 3881c46 commit ed37c7f

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

versions/3.1.0.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,8 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi
211211
Field Name | Type | Description
212212
---|:---:|---
213213
<a name="infoTitle"></a>title | `string` | **REQUIRED**. The title of the application.
214-
<a name="infoDescription"></a>description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation.
214+
<a name="infoSummary"></a>summary | `string` | A short summary of the application.
215+
<a name="infoDescription"></a>description | `string` | A verbose explanation of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation.
215216
<a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL.
216217
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
217218
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
@@ -225,6 +226,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
225226
```json
226227
{
227228
"title": "Sample Pet Store App",
229+
"summary": "A pet store manager.",
228230
"description": "This is a sample server for a pet store.",
229231
"termsOfService": "http://example.com/terms/",
230232
"contact": {
@@ -242,6 +244,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
242244

243245
```yaml
244246
title: Sample Pet Store App
247+
summary: A pet store manager.
245248
description: This is a sample server for a pet store.
246249
termsOfService: http://example.com/terms/
247250
contact:

0 commit comments

Comments
 (0)