Adding missing help_text and check #647
Conversation
john-westcott-iv
force-pushed
the
help_text_check
branch
4 times, most recently
from
cd8f8aa
to
b6d9126
Compare
| name = models.CharField("name", max_length=255) | ||
| content_type = models.ForeignKey(ContentType, models.CASCADE, verbose_name="content type") | ||
| codename = models.CharField("codename", max_length=100) | ||
| name = models.CharField("name", max_length=255, help_text=_("The name of this permission.")) |
There was a problem hiding this comment.
You'll find that in a lot of these, they are not exposed in the API.
This model is also a mirror of auth.Permission so why doesn't it have help_text? Because the model it mirrors doesn't have help text.
The permission name is more of a python / admin pages display oriented thing. Hopefully we don't ever use it. If you wanted to get more specific about that, you could. Again, it shouldn't be outward API-facing.
There was a problem hiding this comment.
Should I take the help_text off these and add them to the .help_text.ignore file or just leave it on for now?
There was a problem hiding this comment.
The permission model, itself, maybe one day (soon-ish) be surfaced in the API in a read-only way. So it might be good to have these, although I realize I probably just have to make a PR.
There was a problem hiding this comment.
I don't see much purpose in dropping the help_text and making an ignore here, so I think we should keep this one, save us an extra migration if or when this gets exposed to the API.
| content_type = models.ForeignKey(ContentType, models.CASCADE, verbose_name="content type") | ||
| codename = models.CharField("codename", max_length=100) | ||
| name = models.CharField("name", max_length=255, help_text=_("The name of this permission.")) | ||
| content_type = models.ForeignKey(ContentType, models.CASCADE, verbose_name="content type", help_text=_("The content type this permission will apply to.")) |
There was a problem hiding this comment.
Let's say we have a permission statement "John can pet the dog named Fido". That would be an instantiation of Permission (note that a permission entry it not an instantiation), the content type of the permission being dog.
There was a problem hiding this comment.
Writing more comments further down, I realize "subject" is a hazardous word. "object" might be better. English SVO grammar structure would imply "subject" is what is referred to as "actor" elsewhere.
| codename = models.CharField( | ||
| "codename", | ||
| max_length=100, | ||
| help_text=_("The name of the permission, giving the action and the model, from the Django Permission model."), |
There was a problem hiding this comment.
This is the only one that matters, and unfortunately, you can't say the format rule always applies, but this does conform to the existing Django auth app pattern.
So the format of the permission is usually in the form of {action}_{model_name}, but can be customized for a specific entry in a model's Meta class. The model name is well-defined formally, and the action is usually / probably the DRF viewset action. This is actually under-specified and in some internal Django uses the actually unique combination of (app_label, model_name, action) is used. But in DAB RBAC, it is expected to be unique without app_label, due to additional enforcement.
There was a problem hiding this comment.
How does this sound?
The name of the permission. This is in the format {action}_{model_name}. Where action is typically the view set action (view/list/etc) from Django rest framework.
There was a problem hiding this comment.
I don't think we would want to call this The name of the permission.... because that is the text used for name on line 33.
As to the comment about the format, we should only include the format if the model class itself sets format.
There was a problem hiding this comment.
@tznamena Good callout
john-westcott-iv
force-pushed
the
help_text_check
branch
from
b6d9126
to
3c97fb3
Compare
| name = models.CharField("name", max_length=255) | ||
| content_type = models.ForeignKey(ContentType, models.CASCADE, verbose_name="content type") | ||
| codename = models.CharField("codename", max_length=100) | ||
| name = models.CharField("name", max_length=255, help_text=_("The name of this permission.")) |
There was a problem hiding this comment.
I don't see much purpose in dropping the help_text and making an ignore here, so I think we should keep this one, save us an extra migration if or when this gets exposed to the API.
john-westcott-iv
force-pushed
the
help_text_check
branch
from
3c97fb3
to
54c1c68
Compare
dmzoneill
force-pushed
the
help_text_check
branch
from
54c1c68
to
1a30cf4
Compare
john-westcott-iv
force-pushed
the
help_text_check
branch
3 times, most recently
from
5ae48b8
to
839ab3b
Compare
john-westcott-iv
force-pushed
the
help_text_check
branch
from
839ab3b
to
1c1018d
Compare
|
This adds a help_text check, validating that every model has all of its help_text defined.
It also addresses missing help_text from existing models.