Uploaded image for project: 'WildFly'
  1. WildFly
  2. WFLY-16313

MP OpenAPI subsystem should not register OpenAPI endpoint for non-JAX-RS WAR unless spec requires it

    XMLWordPrintable

Details

    Description

      In response to https://github.com/eclipse/microprofile-open-api/issues/413, the MicroProfile OpenAPI spec team has clarified the criteria for when an OpenAPI endpoint should be registered, i.e. when one of the following criteria is met:

      • The application uses Jakarta RESTful Web Services
      • An OASModelReader has been configured with mp.openapi.model.reader
      • An OASFilter has been configured with mp.openapi.filter
      • One of the allowed static files is present, i.e. /META-INF/openapi.(json|yaml)

      In order to pass the MicroProfile OpenAPI TCK, WF currently registers an OpenAPI endpoint for JAX-RS applications, or for any standalone WAR, since TCK includes test web applications that have no JAX-RS endpoints. This is no sufficiently discerning. In order to avoid registering this endpoint unnecessarily, we should refine our criteria to conform to this spec clarification.

      Attachments

        Activity

          People

            pferraro@redhat.com Paul Ferraro
            pferraro@redhat.com Paul Ferraro
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: