Attachment 54288 Details for Bug 16212 – Bug 16212: Use swagger.min.json insted of swagger.json

[patch] Bug 16212: Use swagger.min.json insted of swagger.json

Bug-16212-Use-swaggerminjson-insted-of-swaggerjson.patch (text/plain), 2.00 KB, created by Benjamin Rokseth on 2016-08-11 08:59:02 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Benjamin Rokseth

Created: 2016-08-11 08:59:02 UTC

Size: 2.00 KB

patch

obsolete

>From ac9ad6f38304c2950ecf96ba849d27f5b58a1c52 Mon Sep 17 00:00:00 2001
>From: Lari Taskula <larit@student.uef.fi>
>Date: Tue, 14 Jun 2016 16:01:24 +0300
>Subject: [PATCH] Bug 16212: Use swagger.min.json insted of swagger.json
>MIME-Version: 1.0
>Content-Type: text/plain; charset=UTF-8
>Content-Transfer-Encoding: 8bit
>
>Our current approach with splitting the Swagger specification brings problems.
>For example, in swagger.json, if we split the whole "definitions" object with
>$ref, validations will fail with online.swagger.io validator.
>
>(See http://online.swagger.io/validator/debug?url=url_to_your_swagger_json)
>
>The problem also occurs with "paths" (Paths Object), because simply $ref to all
>paths for example in /paths/index.json does not meet the Swagger2 specification.
>
>The problem is solved by using the minification script and the minified version
>of swagger.json after which the swagger.min.json is valid Swagger2 specification,
>because the minifier resolves the problematic $refs of swagger.json file in the
>minified version.
>
>Signed-off-by: Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi>
>
>My name is Olli-Antti Kivilahti and I approve this commit.
>We have been using the Swagger2.0-driven REST API on Mojolicious for 1 year now
>in production and I am certain we have a pretty good idea on how to work with
>the limitations of Swagger2.0
>
>Signed-off-by: Johanna Raisa <johanna.raisa@gmail.com>
>
>My name is Johanna RÃ¤isÃ¤ and I approve this commit.
>We have been using Swagger2.0-driven REST API in production successfully.
>
>Signed-off-by: Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no>
>---
> Koha/REST/V1.pm | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
>diff --git a/Koha/REST/V1.pm b/Koha/REST/V1.pm
>index b692a38..1bfda46 100644
>--- a/Koha/REST/V1.pm
>+++ b/Koha/REST/V1.pm
>@@ -50,7 +50,7 @@ sub startup {
> 
>     $self->plugin(Swagger2 => {
>         route => $route,
>-        url => $self->home->rel_file("api/v1/swagger.json"),
>+        url => $self->home->rel_file("api/v1/swagger.min.json"),
>     });
> }
> 
>-- 
>2.1.4

Actions: View | Diff | Splinter Review

Attachments on bug 16212: 49949 | 49950 | 52368 | 52369 | 52576 | 52589 | 52590 | 52601 | 52651 | 52952 | 52953 | 52954 | 52955 | 52968 | 52969 | 52970 | 52971 | 52972 | 52973 | 52982 | 52983 | 52984 | 52985 | 54286 | 54287 | 54288 | 54870 | 54871 | 54872 | 54873