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

OAS3 support for active docs

    XMLWordPrintable

Details

    • 3scale 2019-11-25, 3scale 2019-12-09, 3scale 2019-12-23, 3scale 2020-01-13, 3scale 2020-02-03, 3scale 2020-02-17, 3scale 2020-03-09

    Description

      Allow paste of OpenAPI 3.0 spec and display in developer portal

      Support the OpenAPI Specification v3 in:

      1. Active Docs component
      2. The 3Scale Management REST API which allows import of a service definition specified in OpenAPI specification
      3. The service discovery feature.

      Dev Notes

      First implement THREESCALE-2725

      background:
      https://docs.google.com/document/d/1TDSpoAe3m79eYEIALw8Rp190DXmMvuOMLblJWhSP954/edit#heading=h.puuoz5rt1qfr
      https://docs.google.com/document/d/14H6XDVX1wyuMTRdrnF-7mEfmMcjiPqykkK8OxmfvwIM/edit

      Dev notes

      • Add OAS 3.0 JSON schema to the swagger validator and validate OAS 3.0 specs
      • Modify what is needed to allow upload OAS 3.0 spec (UI, API)

      In this run, we do not handle autocompletion of user keys and service name etc ...

      Attachments

        Issue Links

          is blocked by

          Task - Represents a small unit of work that is not end-user facing. THREESCALE-2725 Start using SwaggerUI 3.18.3 or higher for OAS3 specs

          • 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

          Task - Represents a small unit of work that is not end-user facing. THREESCALE-2725 Start using SwaggerUI 3.18.3 or higher for OAS3 specs

          • 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-1460 Improve API Provider ActiveDocs (used by API consumer in dev portal)

          • 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

          Feature Request - Feature requests from customers and/or users THREESCALE-2995 Toolbox OpenAPI 3 support PHASE 1

          • 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

          Enhancement - An enhancement to or refactoring of existing functionality that is not configurable by an end user (typically a change made by an internal team that affects users) TEIID-5555 Create OpenAPI (swagger) metadata document based on OData

          • Critical - To be worked on immediately following BLOCKER issues.
          • Resolved

          Activity

            People

              Unassigned Unassigned
              sgutierr@redhat.com Sergio Gutierrez Romero
              Martin Kudlej Martin Kudlej
              Guilherme Cassolato Guilherme Cassolato
              Votes:
              11 Vote for this issue
              Watchers:
              20 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: