Document OpenApiAuthenticationExtension priority property

[savitmk]

I have subclassed OpenApiAuthenticationExtension to document an authentication class which subclasses rest_framework.authentication.TokenAuthentication.

Because there is an existing authentication extension for TokenAuthentication in this codebase -

drf-spectacular/drf_spectacular/authentication.py

Line 27 in fcee218

class TokenScheme(OpenApiAuthenticationExtension):

- there are multiple matches here -

drf-spectacular/drf_spectacular/plumbing.py

Line 506 in fcee218

def get_match(cls, target) -> Optional[T]:

It is not documented - https://drf-spectacular.readthedocs.io/en/latest/customization.html#specify-authentication-with-openapiauthenticationextension - that user authentication extensions which conflict with this library's authentication extensions require setting a higher priority.

Alternatively/additionally, the default priority could be 0 while this library's authentication extensions have a negative priority, so that as a user writing an authentication extension, my extension would be preferred by default.

Thank you again!

[tfranzel]

that should do it. though if subclassing the built-in extensions, you still need to raise the -1. added a info box to the doc for that.