Closes #10545: Standardize description & comment fields on primary models (#10834)

* Standardize description & comments fields on primary models

* Update REST API serializers

* Update forms

* Update tables

* Update templates

netbox/circuits/api/serializers.py

@@ -31,8 +31,8 @@ class ProviderSerializer(NetBoxModelSerializer):
     class Meta:
         model = Provider
         fields = [
-            'id', 'url', 'display', 'name', 'slug', 'account',
-            'comments', 'asns', 'tags', 'custom_fields', 'created', 'last_updated', 'circuit_count',
+            'id', 'url', 'display', 'name', 'slug', 'account', 'description', 'comments', 'asns', 'tags',
+            'custom_fields', 'created', 'last_updated', 'circuit_count',
         ]
 
 

netbox/circuits/forms/bulk_edit.py

@@ -30,6 +30,10 @@ class ProviderBulkEditForm(NetBoxModelBulkEditForm):
         required=False,
         label='Account number'
     )
+    description = forms.CharField(
+        max_length=200,
+        required=False
+    )
     comments = CommentField(
         widget=SmallTextarea,
         label='Comments'
@@ -40,7 +44,7 @@ class ProviderBulkEditForm(NetBoxModelBulkEditForm):
         (None, ('asns', 'account', )),
     )
     nullable_fields = (
-        'asns', 'account', 'comments',
+        'asns', 'account', 'description', 'comments',
     )
 
 

netbox/circuits/forms/bulk_import.py

@@ -18,7 +18,7 @@ class ProviderCSVForm(NetBoxModelCSVForm):
     class Meta:
         model = Provider
         fields = (
-            'name', 'slug', 'account', 'comments',
+            'name', 'slug', 'account', 'description', 'comments',
         )
 
 

netbox/circuits/forms/model_forms.py

@@ -1,4 +1,3 @@
-from django import forms
 from django.utils.translation import gettext as _
 
 from circuits.models import *
@@ -7,8 +6,8 @@ from ipam.models import ASN
 from netbox.forms import NetBoxModelForm
 from tenancy.forms import TenancyForm
 from utilities.forms import (
-    BootstrapMixin, CommentField, DatePicker, DynamicModelChoiceField, DynamicModelMultipleChoiceField,
-    SelectSpeedWidget, SmallTextarea, SlugField, StaticSelect,
+    CommentField, DatePicker, DynamicModelChoiceField, DynamicModelMultipleChoiceField, SelectSpeedWidget, SlugField,
+    StaticSelect,
 )
 
 __all__ = (
@@ -30,14 +29,14 @@ class ProviderForm(NetBoxModelForm):
     comments = CommentField()
 
     fieldsets = (
-        ('Provider', ('name', 'slug', 'asns', 'tags')),
+        ('Provider', ('name', 'slug', 'asns', 'description', 'tags')),
         ('Support Info', ('account',)),
     )
 
     class Meta:
         model = Provider
         fields = [
-            'name', 'slug', 'account', 'asns', 'comments', 'tags',
+            'name', 'slug', 'account', 'asns', 'description', 'comments', 'tags',
         ]
         help_texts = {
             'name': "Full name of the provider",

netbox/circuits/migrations/0041_standardize_description_comments.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.1.2 on 2022-11-03 18:24
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('circuits', '0040_provider_remove_deprecated_fields'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='provider',
+            name='description',
+            field=models.CharField(blank=True, max_length=200),
+        ),
+    ]

netbox/circuits/models/circuits.py

@@ -7,7 +7,7 @@ from django.urls import reverse
 from circuits.choices import *
 from dcim.models import CabledObjectModel
 from netbox.models import (
-    ChangeLoggedModel, CustomFieldsMixin, CustomLinksMixin, OrganizationalModel, NetBoxModel, TagsMixin,
+    ChangeLoggedModel, CustomFieldsMixin, CustomLinksMixin, OrganizationalModel, PrimaryModel, TagsMixin,
 )
 from netbox.models.features import WebhooksMixin
 
@@ -27,7 +27,7 @@ class CircuitType(OrganizationalModel):
         return reverse('circuits:circuittype', args=[self.pk])
 
 
-class Circuit(NetBoxModel):
+class Circuit(PrimaryModel):
     """
     A communications circuit connects two points. Each Circuit belongs to a Provider; Providers may have multiple
     circuits. Each circuit is also assigned a CircuitType and a Site.  Circuit port speed and commit rate are measured
@@ -73,13 +73,6 @@ class Circuit(NetBoxModel):
         blank=True,
         null=True,
         verbose_name='Commit rate (Kbps)')
-    description = models.CharField(
-        max_length=200,
-        blank=True
-    )
-    comments = models.TextField(
-        blank=True
-    )
 
     # Generic relations
     contacts = GenericRelation(

netbox/circuits/models/providers.py

@@ -2,8 +2,7 @@ from django.contrib.contenttypes.fields import GenericRelation
 from django.db import models
 from django.urls import reverse
 
-from dcim.fields import ASNField
-from netbox.models import NetBoxModel
+from netbox.models import PrimaryModel
 
 __all__ = (
     'ProviderNetwork',
@@ -11,7 +10,7 @@ __all__ = (
 )
 
 
-class Provider(NetBoxModel):
+class Provider(PrimaryModel):
     """
     Each Circuit belongs to a Provider. This is usually a telecommunications company or similar organization. This model
     stores information pertinent to the user's relationship with the Provider.
@@ -34,9 +33,6 @@ class Provider(NetBoxModel):
         blank=True,
         verbose_name='Account number'
     )
-    comments = models.TextField(
-        blank=True
-    )
 
     # Generic relations
     contacts = GenericRelation(
@@ -57,7 +53,7 @@ class Provider(NetBoxModel):
         return reverse('circuits:provider', args=[self.pk])
 
 
-class ProviderNetwork(NetBoxModel):
+class ProviderNetwork(PrimaryModel):
     """
     This represents a provider network which exists outside of NetBox, the details of which are unknown or
     unimportant to the user.
@@ -75,13 +71,6 @@ class ProviderNetwork(NetBoxModel):
         blank=True,
         verbose_name='Service ID'
     )
-    description = models.CharField(
-        max_length=200,
-        blank=True
-    )
-    comments = models.TextField(
-        blank=True
-    )
 
     class Meta:
         ordering = ('provider', 'name')

netbox/circuits/tables/providers.py

@@ -39,8 +39,8 @@ class ProviderTable(ContactsColumnMixin, NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = Provider
         fields = (
-            'pk', 'id', 'name', 'asns', 'account', 'asn_count',
-            'circuit_count', 'comments', 'contacts', 'tags', 'created', 'last_updated',
+            'pk', 'id', 'name', 'asns', 'account', 'asn_count', 'circuit_count', 'description', 'comments', 'contacts',
+            'tags', 'created', 'last_updated',
         )
         default_columns = ('pk', 'name', 'account', 'circuit_count')