OpenAPI 3 root level security not supported #322

Activity

1. stale commented on Sep 18, 2022

   

   staleBot

   on Sep 18, 2022

   More actions

   This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
2. stale

   added

   wontfix

   on Sep 18, 2022
3. daniloab

   added

   pinnedIssues that will not be automatically closedIssues that will not be automatically closed

   on Sep 19, 2022
4. stale

   closed this as completedon Sep 26, 2022
5. daniloab

   reopened this on Sep 26, 2022
6. stale

   removed

   wontfix

   on Sep 26, 2022
7. ZebboKlaufix commented on May 1, 2023

   

   ZebboKlaufix

   on May 1, 2023

   More actions

   It seems that this error still occures. Is there any chance to bypass the issue?
8. duluca commented on Sep 2, 2023

   

   duluca

   on Sep 2, 2023

   Last edited by duluca

   More actions

   Bump.

   edit:
   I discovered a workaround. It works if you use it in the Options object. Given this is an app level config, this is an acceptable place to place this configuration.

   Example below:

   const options: Options = {
     swaggerDefinition: {
       openapi: '3.0.2',
       components: {
         securitySchemes: {
           bearerAuth: {
             type: 'http',
             scheme: 'bearer',
             bearerFormat: 'JWT',
           },
         },
         security: {
           bearerAuth: [],
         },
      },
   }
   

   In contrast, this doesn't work:

   /**
    * @openapi
    * components:
    *   securitySchemes:
    *     bearerAuth:
    *       type: http
    *       scheme: bearer
    *       bearerFormat: JWT
    *   responses:
    *     UnauthorizedError:
    *       description: Unauthorized
    *       content:
    *         application/json:
    *           schema:
    *             $ref: "#/components/schemas/ServerMessage"
    *   schemas:
    *     ServerMessage:
    *       type: object
    *       properties:
    *         message:
    *           type: string
    *   security:
    *     - bearerAuth: []
    */
   

   👍React with 👍1Reacted by Jonas Reitmann