Skip to content

Commit

Permalink
832 add info.summary (#1779)
Browse files Browse the repository at this point in the history
* Fix: #832. Add info.summary.

* Fix: summary is shord, description is verbose.

Be consistent with other definitions of summary and description.
  • Loading branch information
ioggstream authored and Phil Sturgeon committed Jul 18, 2019
1 parent c97e2ec commit eba36b2
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion versions/3.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,8 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi
Field Name | Type | Description
---|:---:|---
<a name="infoTitle"></a>title | `string` | **REQUIRED**. The title of the application.
<a name="infoDescription"></a>description | `string` | A short description of the application. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
<a name="infoSummary"></a>summary | `string` | A short summary of the application.
<a name="infoDescription"></a>description | `string` | A verbose explanation of the application. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
<a name="infoTermsOfService"></a>termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL.
<a name="infoContact"></a>contact | [Contact Object](#contactObject) | The contact information for the exposed API.
<a name="infoLicense"></a>license | [License Object](#licenseObject) | The license information for the exposed API.
Expand All @@ -225,6 +226,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
```json
{
"title": "Sample Pet Store App",
"summary": "A pet store manager.",
"description": "This is a sample server for a pet store.",
"termsOfService": "https://example.com/terms/",
"contact": {
Expand All @@ -242,6 +244,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens

```yaml
title: Sample Pet Store App
summary: A pet store manager.
description: This is a sample server for a pet store.
termsOfService: https://example.com/terms/
contact:
Expand Down

0 comments on commit eba36b2

Please sign in to comment.