Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

832 add info.summary #1779

Merged
merged 2 commits into from
Feb 28, 2019
Merged

832 add info.summary #1779

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9d8dcf
Fix: #832. Add info.summary.
ioggstream Dec 17, 2018
02be4c6
Fix: summary is shord, description is verbose.
ioggstream Feb 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion versions/3.1.0.md
View file
Open in desktop
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](http://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](http://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": "http://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: http://example.com/terms/
contact:
Expand Down