syncope-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Francesco Chicchiriccò (JIRA) <j...@apache.org>
Subject [jira] [Created] (SYNCOPE-1262) Upgrade to Swagger UI 3.0
Date Fri, 05 Jan 2018 10:44:00 GMT
Francesco Chicchiriccò created SYNCOPE-1262:
-----------------------------------------------

             Summary: Upgrade to Swagger UI 3.0
                 Key: SYNCOPE-1262
                 URL: https://issues.apache.org/jira/browse/SYNCOPE-1262
             Project: Syncope
          Issue Type: Task
          Components: extensions
            Reporter: Francesco Chicchiriccò
            Assignee: Francesco Chicchiriccò
             Fix For: 2.0.8, 2.1.0


Since we introduced the support for Swagger (as an extension), I believe many have found it
very useful.

We are currently shipping a patched version of Swagger UI 2.0 (backed by Swagger Core 1.5),
with JS support manually enabled for Matrix parameters - as such parameters are not officially
supported by Swagger UI 2.0.

Luckily, after [long discussions|https://github.com/OAI/OpenAPI-Specification/issues/69],
it seems that Matrix parameters eventually found their way through the OpenAPI specification,
and Swagger UI 3.0.

In order to profit from this, we need to generate an OpenAPI 3.0- compliant descriptor, as
the current /rest/swagger.json is at 2.0 but, due to the presence of matrix parameters, doesn't
load with Swagger UI 3.0.

There is an [ongoing effort in CXF|https://issues.apache.org/jira/browse/CXF-7525] to provide
full support for OpenAPI 3.0, but the work has just started; moreover, this will only land
in CXF 3.2 - hence our branch {{2_0_X}} will not use it anyway.

Another approach, again provided by CXF, is the [SwaggerToOpenApiConversionFilter|https://cwiki.apache.org/confluence/display/CXF20DOC/Swagger2Feature#Swagger2Feature-ConvertingtoOpenAPIJSON],
which is essentially an in-line transformer from the {{swagger.json}} we already generate,
to the new {{openapi.json}} in OpenAPI 3.0 format.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message