From d9d8dcf92732fb933748d335707f6d97db762e08 Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Mon, 17 Dec 2018 17:39:47 +0100 Subject: [PATCH 1/2] Fix: #832. Add info.summary. --- versions/3.1.0.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/versions/3.1.0.md b/versions/3.1.0.md index f0c7f54abe..68b67d2924 100644 --- a/versions/3.1.0.md +++ b/versions/3.1.0.md @@ -211,6 +211,7 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi Field Name | Type | Description ---|:---:|--- title | `string` | **REQUIRED**. The title of the application. +summary | `string` | A short, plain-text summary of the application. description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. contact | [Contact Object](#contactObject) | The contact information for the exposed API. @@ -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": "http://example.com/terms/", "contact": { @@ -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: http://example.com/terms/ contact: From 02be4c662416fcae3a2ca72408e574ea0a41f311 Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Thu, 14 Feb 2019 18:17:50 +0100 Subject: [PATCH 2/2] Fix: summary is shord, description is verbose. Be consistent with other definitions of summary and description. --- versions/3.1.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versions/3.1.0.md b/versions/3.1.0.md index 68b67d2924..5f78a76e92 100644 --- a/versions/3.1.0.md +++ b/versions/3.1.0.md @@ -211,8 +211,8 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi Field Name | Type | Description ---|:---:|--- title | `string` | **REQUIRED**. The title of the application. -summary | `string` | A short, plain-text summary of the application. -description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. +summary | `string` | A short summary of the application. +description | `string` | A verbose explanation of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. contact | [Contact Object](#contactObject) | The contact information for the exposed API. license | [License Object](#licenseObject) | The license information for the exposed API.