Uploaded image for project: 'Aries'
  1. Aries
  2. ARIES-2032

Aries JAX-RS OpenAPI integration picks up wrong classes for spec generation

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • jax-rs-whiteboard-1.1.0
    • None
    • jax-rs-whiteboard
    • None

    Description

      If two endpoints, e.g., /item and /test, have a return type that is named the same, e.g., Metadata, but are from different packages, e.g., io.jatoms.Metadata and io.jatoms.test.Metadata, then only one is picked up for the spec generation and therefore one endpoint will have false information in its description.

       

      I've created a sample repository showcasing this bug: Sandared/osgi-openapi-example at openapi-bug (github.com)

       

      There two endpoint have return types that are named the same (Metadata), but are actually two classes from different packages (io.jatoms.osgi.openapi.model.test.Metadata and io.jatoms.osgi.openapi.model.Metadata).

      One Metadata class defines a field "id" and the other one "testid", however in the generated documentation only one of these is generated. 

       

      Expected behavior would be that each endpoint documentation references its respective Metadata type.

       

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            tdriessen Thomas Driessen
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated: