Merge pull request #269 from acelaya/feature/missing-resp-examples

Feature/missing resp examples
shlinkio · Nov 16, 2018 · 0af7b75 · 0af7b75
2 parents 8f4800a + 36a42cb
commit 0af7b75
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 35 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org).
 
-## [Unreleased]
+## 1.14.0 - 2018-11-16
 
 #### Added
 
@@ -29,6 +29,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 * [#249](https://github.com/shlinkio/shlink/issues/249) Added [functional-php](https://github.com/lstrojny/functional-php) to ease collections handling.
 * [#253](https://github.com/shlinkio/shlink/issues/253) Increased `user_agent` column length in `visits` table to 512.
 * [#256](https://github.com/shlinkio/shlink/issues/256) Updated to Infection v0.11.
+* [#202](https://github.com/shlinkio/shlink/issues/202) Added missing response examples to OpenAPI docs.
 
 #### Deprecated
 
@@ -40,7 +41,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 #### Fixed
 
-* *Nothing*
+* [#223](https://github.com/shlinkio/shlink/issues/223) Fixed PHPStan errors produced with symfony/console 4.1.5
 
 
 ## 1.13.2 - 2018-10-18

diff --git a/docs/swagger/paths/v1_short-urls.json b/docs/swagger/paths/v1_short-urls.json
@@ -209,23 +209,22 @@
                 "content": {
                     "application/json": {
                         "schema": {
-                            "type": "object",
-                            "properties": {
-                                "longUrl": {
-                                    "type": "string",
-                                    "description": "The original long URL that has been parsed"
-                                },
-                                "shortUrl": {
-                                    "type": "string",
-                                    "description": "The generated short URL"
-                                },
-                                "shortCode": {
-                                    "type": "string",
-                                    "description": "the short code that is being used in the short URL"
-                                }
-                            }
+                            "$ref": "../definitions/ShortUrl.json"
                         }
                     }
+                },
+                "examples": {
+                    "application/json": {
+                        "shortCode": "12C18",
+                        "shortUrl": "https://doma.in/12C18",
+                        "longUrl": "https://store.steampowered.com",
+                        "dateCreated": "2016-08-21T20:34:16+02:00",
+                        "visitsCount": 0,
+                        "tags": [
+                            "games",
+                            "tech"
+                        ]
+                    }
                 }
             },
             "400": {

diff --git a/docs/swagger/paths/v1_short-urls_shorten.json b/docs/swagger/paths/v1_short-urls_shorten.json
@@ -45,21 +45,7 @@
                 "content": {
                     "application/json": {
                         "schema": {
-                            "type": "object",
-                            "properties": {
-                                "longUrl": {
-                                    "type": "string",
-                                    "description": "The original long URL that has been shortened"
-                                },
-                                "shortUrl": {
-                                    "type": "string",
-                                    "description": "The generated short URL"
-                                },
-                                "shortCode": {
-                                    "type": "string",
-                                    "description": "the short code that is being used in the short URL"
-                                }
-                            }
+                            "$ref": "../definitions/ShortUrl.json"
                         }
                     },
                     "text/plain": {
@@ -71,10 +57,16 @@
                 "examples": {
                     "application/json": {
                         "longUrl": "https://github.com/shlinkio/shlink",
-                        "shortUrl": "https://dom.ain/abc123",
-                        "shortCode": "abc123"
+                        "shortUrl": "https://doma.in/abc123",
+                        "shortCode": "abc123",
+                        "dateCreated": "2016-08-21T20:34:16+02:00",
+                        "visitsCount": 0,
+                        "tags": [
+                            "games",
+                            "tech"
+                        ]
                     },
-                    "text/plain": "https://dom.ain/abc123"
+                    "text/plain": "https://doma.in/abc123"
                 }
             },
             "400": {