-
Notifications
You must be signed in to change notification settings - Fork 264
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Change custom field "name" to a proper "slug" field #824
Comments
I know there was some interest in standardizing Slug fields across all of Nautobot. I am curious why we would choose to depreciate the I don't think all of this needs to wait till the next major release to introduce all of these changes. I believe we can safely accomplish most of the slug implementations ahead of time. In addition to this, I was working on a Data migration the other day, and found the Django System Check Framework, which I would like to add to the chosen depreciated field so we can start alerting users ahead of time of the new field. |
We could arguably rename |
Inventory of changes needing to be made to satisfy this based on
|
Based on feedback in #3426 we're going to use |
Implemented for 2.0 by #3426. |
Proposed Changes
Follow-on to discussion originally in #464. Custom fields currently have both a
label
(which is meant to be human-readable) and aname
(which is used internally as a dictionary key, as well as in the GraphQL schema).Even though the
name
is used in various programmatic and API features, it is currently treated more like the human-readablename
present on various other models than like a properslug
- in particular, it doesn't currently have any of the format enforcement applied to similarly-usedslug
fields in most other models.The proposal here is to migrate
name
toslug
in the next major (breaking) release of Nautobot, both for self-consistency and also for the prevention of bugs such as #464.Note that some of the (non-breaking) groundwork for this change has already been laid in #735; implementing this change should include a thorough review of the various TODO comments added in that PR.
Justification
TODO
name
property to now use theslug
property (see Change custom field "name" to a proper "slug" field #824 (comment))slug
tokey
with some help text to make it more apparent what this field is to be used forname
propertyFuture follow-on: Should
label
on both custom and computed fields now become the "name" of the field, with a call-out that it is the human-readable versionThe text was updated successfully, but these errors were encountered: