Change the the entity_type kwarg to table_name

[joegasewicz]

Our API has 2 public methods, one of which is register_entity. This currently requires a kwarg of entity_type to donate the table name, which is confusing to the user.

Change register_entity method's kwarg of entity_type to table_name. This may result in updating other parts of the codebase, docs, README, blog and tests.

[kousikmitra]

Or should we change it to entity_name since it's more relevant to the context. We are also using register_entity as function name.

[joegasewicz]

Yea that’s a very valid observation. But for the work involved I’m not sure it’s worth the effort at the moment, to change just a prefix of an existing kwarg.

I have had some complaints from devs looking at this library and not understanding what “entity” represents... Maybe we should change the method name and therefore also change the Kwarg to table_name. I'm wondering if this would make more sense?

edit: Current situation: we derive the entity_type from the database table name.

_{Sent with GitHawk}

[kousikmitra]

yes at first I also couldn't understood what entity represents here. But since we are using Flask models then isn't it better if we change the names to model_name and register_model?

@joegasewicz after your edit to the last comment.
Edit: Okay since we derive the entity_type from the database table name then naming it to model_name will create confusion.

[joegasewicz]

Ok, thats much better. Let's go with model_name as the kwarg and register_model as the method name.

I also need to update the other public method name to update_token - ( i don't think we should call it update_model because it's not updating the model).

[joegasewicz]

@kousikmitra Let's go with table_name as the kwarg and register_model as the method name.

[kousikmitra]

@joegasewicz can we derive the table name from the model name? Then the user can just pass the model_name to the function and we can get the table_name from there. Since when people use Models they don't give much attention to table_name(own perspective)

[joegasewicz]

The problem is, is that we have to handle multiple models , so we have to know which model the user wants to append to Flask's global context.

app.config["ENTITY_MODELS"] = [ UserModel, TeacherModel, ...etc ]

[kousikmitra]

The problem is, is that we have to handle multiple models , so we have to know which model the user wants to append to Flask's global context.

app.config["ENTITY_MODELS"] = [ UserModel, TeacherModel, ...etc ]

Okay I will look into the code and will revert back to you. or we will go with the table_name approach for now.

[joegasewicz]

@kousikmitra Im going to close this issue and open a few new ones tomorrow to carry out this work, I have to go out now to play some music but will be back in the morning UK time.
Feel free to open an issue and start working on it, if we can split this work up as much as possible as it's non trivial.
thanks
Joe

[joegasewicz]

@kousikmitra I've reopened & updated this issue if you still want to work on it.
Im going to create another issue to change the method name.