Skip to content

Add bearerFormat hint to auth decorators #9264

@Kludgy4

Description

@Kludgy4

Clear and concise description of the problem

https://spec.openapis.org/oas/v3.1.0.html#fixed-fields-22

It should be easier to add the bearerAuth hint to the generated openapi spec for auth. For example, it is not currently possible to generate:

  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

which you can see in the examples in the linked openapi spec.
This feels common enough that it should be possible esp. given it is possible in the raw openapi spec

Checklist

  • Follow our Code of Conduct
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    design:neededA design request has been raised that needs a proposallib:http

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions