openapi-ts icon indicating copy to clipboard operation
openapi-ts copied to clipboard

securitySchemes won't support GET api key authentication

Open diogopms opened this issue 1 year ago • 4 comments

Description

I was trying to configure api_key authentication on the securitySchemes but unfortunately, it's not working as expected (I can't change the authentication to Bearer Authorization)

  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: query
.....
/clients
    get:
      tags:
        - Clients
      security:
        - api_key: []
      summary: List all clients
      description: Retrieves a list of clients.
      parameters:
        - name: page
          in: query
          required: true
          schema:
            type: integer
          description: Page number to retrieve.
        - name: per_page
          in: query
          required: true
          schema:
            type: integer
          description: Number of clients per page.
      responses:
        "200":
          description: Clients List all
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ClientsResponse"

Works well on Swagger UI: image

image

OpenAPI specification (optional)

openapi: 3.0.1 info: version: 1.0.0

System information (optional)

No response

diogopms avatar Aug 02 '24 14:08 diogopms