Question: Possibility to export permissions with OpenAPI schema

[unode]

Hi @eadwinCode,

I'm trying to find an automated way to export all the permissions used by the project on a more human readable format.
Django Ninja provides manage.py export_openapi_schema and I see that authentication (JWTAuth) is currently exported but permissions aren't.

Is there any way this could be supported or otherwise exported?

The OpenAPI spec doesn't have an explicit field but recommends using x- fields for such needs.

[eadwinCode]

@unode I will look at the export function and see if there is a way to add permission or use the x-fields from OpenAPI spec

[unode]

Thanks @eadwinCode 🙏 for looking into it!

[eadwinCode]

@unode I’ve taken a look at the django-ninja export command ninja/openapi/schema.py and it seems this computation is currently implemented as a utility function.
Some of these functions were likely intended to be methods on the Operation class. For example:
result

    def operation_security(self, operation: Operation) -> Optional[List[DictStrAny]]:
        if not operation.auth_callbacks:
            return None
        result = []
        for auth in operation.auth_callbacks:
            if hasattr(auth, "openapi_security_schema"):
                scopes: List[DictStrAny] = []  # TODO: scopes
                name = auth.__class__.__name__
                result.append({name: scopes})  # TODO: check if unique
                self.securitySchemes[name] = auth.openapi_security_schema
        return result

If this logic were part of the Operation class, it would be much easier for third-party libraries to override it and add more context to the security parameters.

As things stand, it’s difficult for third-party code to customize this behavior. @vitalik, would you be open to refactoring OpenAPISchema (or related structures) so that third-party libraries can extend or modify the generated OpenAPI schema more easily?

[vitalik]

@eadwinCode - sure - drop some proposals an we will figure this out

[eadwinCode]

@vitalik alright, I will come up with a PR shortly

[unode]

Thanks guys! ❤️

[eadwinCode]

@vitalik Here is the PR vitalik/django-ninja#1633, please let me know if thats okay or if you want something changed