Uploaded image for project: 'Red Hat 3scale API Management'
  1. Red Hat 3scale API Management
  2. THREESCALE-2725

Start using SwaggerUI 3.18.3 or higher for OAS3 specs

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • None
    • None
    • System
    • 8
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • 3scale 2019-12-09, 3scale 2019-12-23, 3scale 2020-01-13, 3scale 2020-01-27, 3scale 2020-02-03

    Description

      Add SwaggerUI to 3.18.3 to handle OAS 3.0 specs and keep using current swagger for older specs.

      See compatibility matrix of SwaggerUI

      Dev notes

      Steps:

      1. Add swagger UI JS version 3.18.3+ to handle OAS 3.0 specs. Put the new version in cdn/swagger-ui directory.
      2. Make some tests: create a Swagger spec 1.0 and 2.0
      3. Add another liquid drop to handle displaying OAS 3.0 spec in developer portal (pair with ruby side if needed)
      4. Test in the developer portal and admin portal to see where it breaks, fix them

      use `active_docs` liquid tag to include the correct swaggerui lib or just base it on info we have in db on swagger version that needs to be rendered

      QE note: This should be tested with this issue https://issues.redhat.com/browse/THREESCALE-4356

      Attachments

        Issue Links

          blocks

          Feature Request - Feature requests from customers and/or users THREESCALE-770 OAS3 support for active docs

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          causes

          Task - Represents a small unit of work that is not end-user facing. THREESCALE-4309 Fix CircleCi errors after upgrading to swagger-ui 3

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          is related to

          Feature Request - Feature requests from customers and/or users THREESCALE-4212 OAS3 with Active Docs features

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          relates to

          Feature Request - Feature requests from customers and/or users THREESCALE-770 OAS3 support for active docs

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Activity

            People

              Unassigned Unassigned
              cbartlet Catherine Bartlett
              Martin Kudlej Martin Kudlej
              Jose Miguel Gallas Olmedo Jose Miguel Gallas Olmedo
              Votes:
              1 Vote for this issue
              Watchers:
              7 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: