Randomly generated UUIDs in operation_id

[mnboos]

Hi!

First of all: thanks for this awesome project, it's amazing and such a nice change coming from DRF with drf-spectacular. 👍

I started using django-ninja with django-ninja-extra for the first time now and am still finding my way through porting our existing api. Now I'm struggling with the following situation:

From the django rest api, I'm using OpenAPI Generator to generate a typescript-fetch client. The standard templates, which could be modified manually, make use of the apis operationId to generate the function names.
For example this api leads to this client:

@api_controller(tags=["User"], permissions=[])
class UserController(ModelControllerBase):
    model_config = ModelConfig(model=User)

    create_user = ModelEndpointFactory.create(schema_in=UserSchema, schema_out=UserSchema, operation_id="create_user")  # operation_id will be used as-is as function name in the generated client

    @route.get(response=list[UserSchema], operation_id="")  # the empty operation_id leads to the auto-generated name `coreApiGetUsers` below
    def get_users(self):
        return User.objects.all().order_by("last_name", "username")

export class UserApi extends runtime.BaseAPI {
	// these two are fine
	async createUser(requestParameters: UserApiCreateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserSchema>
	async coreApiGetUsers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UserSchema>>

	// these (and others) contain the random uuid-parts
	async userGetItem94779491(requestParameters: UserApiUserGetItem94779491Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserSchema>
	async userPatchItem421d551c(requestParameters: UserApiUserPatchItem421d551cRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserSchema>
	// ... and others
}

Currently, the situation is a bit tricky due to the random-suffix in the function names userPatchItem421d551c that are generated, if the operation_id is not set explicitly.
They are generated in ModelEndpointFactory._change_name

Can you tell me how to avoid this, without having to specify each endpoint manually like this:

create_user = ModelEndpointFactory.create(schema_in=UserSchema, schema_out=UserSchema, operation_id="create_user")

Or would you suggest to do it like this anyway, for example because it's more explicit? It's just very verbose, if we have many standard endpoints without business logic.

Thanks for your time and support!

[eadwinCode]

@mnboos Thanks
About the problem, there is no configuration yet to turn on or turn off dynamic method naming. Like you rightly said, a quick fix would be to set the operation_id for now while I find a solution.

The purpose of using a dynamic method name was to prevent the method from being accidentally overridden by the user in the class. I guess there are better ways to do that

[eadwinCode]

There are options also you could use to set the operation_id in the model controller

class ModelConfig(PydanticModel):
    """
    Model Controller Configuration
    """

    allowed_routes: t.List[str] = Field(
        [
            "create",
            "find_one",
            "update",
            "patch",
            "delete",
            "list",
        ]
    )
    async_routes: bool = False
    create_schema: t.Optional[t.Type[PydanticModel]] = None
    retrieve_schema: t.Optional[t.Type[PydanticModel]] = None
    update_schema: t.Optional[t.Type[PydanticModel]] = None
    patch_schema: t.Optional[t.Type[PydanticModel]] = None

    pagination: t.Optional[ModelPagination] = Field(default=ModelPagination())
    model: t.Type[Model]

    schema_config: ModelSchemaConfig = Field(default=ModelSchemaConfig(exclude=set()))

    create_route_info: t.Dict = {}  # extra @post() information
    find_one_route_info: t.Dict = {}  # extra @get('/{id}') information
    update_route_info: t.Dict = {}  # extra @put() information
    patch_route_info: t.Dict = {}  # extra @patch() information
    list_route_info: t.Dict = {}  # extra @get('/') information
    delete_route_info: t.Dict = {}  # extra @delete() information

You can set create_route_info={'operation_id: "create_xxx"}

[jonasN5]

Agreed, the openapi generator is a standard and that random UUID piece is causing a lot of headache.
What I did for now is monkey patch to use a custom decorator which uses a custom APIController where I just remove the random string.

import sys

import ninja_extra.controllers.base

from core.custom_api_controller import custom_api_controller


# Monkey patch the api_controller decorator at all levels of the import chain
ninja_extra.controllers.base.api_controller = custom_api_controller
ninja_extra.controllers.api_controller = custom_api_controller
ninja_extra.api_controller = custom_api_controller

# Also patch sys.modules to ensure any future imports get our custom_api_controller
sys.modules["ninja_extra.controllers.base"].api_controller = custom_api_controller
sys.modules["ninja_extra.controllers"].api_controller = custom_api_controller
sys.modules["ninja_extra"].api_controller = custom_api_controller