Stuck on NoReverseMatch when trying to implement API.

[unleveled-variable]

Hello, I'm brand new at developing plugins in Django for Netbox. I'm running into an issue that I can't seem to figure out. I thought I'd see if anyone could point me in the right direction.

I've gotten a very basic setup going using the plugin tutorial provided by Netbox. I'm able to view the plugin in the GUI, and as far as I can tell I'm able to add items. The issue comes when I try to view the list of objects after I've added an object. After the initial item is added via the 'Add' button, I am unable to view the list ever again as long as there is an item populating it. If I reset the database (ie nuke the docker colume containing the postgres db) I'm able to view the plugin list_view again. Which is why I have a feeling this is due to the way I've implemented the API.

I feel as though the consumable_edit line is a red herring, as I don't have any URLs named consumable_edit to reference.

I will provide the traceback and some of the important files below.

Netbox Version: 3.3.1
Python Version 3.10.6

Happy to provide additional information/code. I'd love to fill this gap in my understanding of django apps.

Environment:

Request Method: GET
Request URL: http://localhost:8000/plugins/netbox_consumables_plugin/consumables/

Django Version: 4.0.7
Python Version: 3.10.6
Installed Applications:
['django.contrib.admin',
 'django.contrib.auth',
 'django.contrib.contenttypes',
 'django.contrib.sessions',
 'django.contrib.messages',
 'django.contrib.staticfiles',
 'django.contrib.humanize',
 'corsheaders',
 'debug_toolbar',
 'graphiql_debug_toolbar',
 'django_filters',
 'django_tables2',
 'django_prometheus',
 'graphene_django',
 'mptt',
 'rest_framework',
 'social_django',
 'taggit',
 'timezone_field',
 'circuits',
 'dcim',
 'ipam',
 'extras',
 'tenancy',
 'users',
 'utilities',
 'virtualization',
 'wireless',
 'django_rq',
 'drf_yasg',
 'netbox_consumables_plugin.NetboxConsumablesPluginConfig']
Installed Middleware:
['graphiql_debug_toolbar.middleware.DebugToolbarMiddleware',
 'django_prometheus.middleware.PrometheusBeforeMiddleware',
 'corsheaders.middleware.CorsMiddleware',
 'django.contrib.sessions.middleware.SessionMiddleware',
 'django.middleware.common.CommonMiddleware',
 'django.middleware.csrf.CsrfViewMiddleware',
 'django.contrib.auth.middleware.AuthenticationMiddleware',
 'django.contrib.messages.middleware.MessageMiddleware',
 'django.middleware.clickjacking.XFrameOptionsMiddleware',
 'django.middleware.security.SecurityMiddleware',
 'netbox.middleware.ExceptionHandlingMiddleware',
 'netbox.middleware.RemoteUserMiddleware',
 'netbox.middleware.LoginRequiredMiddleware',
 'netbox.middleware.DynamicConfigMiddleware',
 'netbox.middleware.APIVersionMiddleware',
 'netbox.middleware.ObjectChangeMiddleware',
 'django_prometheus.middleware.PrometheusAfterMiddleware']


Template error:
In template /opt/netbox/netbox/templates/inc/table_htmx.html, error at line 27
   Reverse for 'consumable_edit' not found. 'consumable_edit' is not a valid view function or pattern name.
   17 :             {% else %}
   18 :               <th {{ column.attrs.th.as_html }}>{{ column.header }}</th>
   19 :             {% endif %}
   20 :           {% endfor %}
   21 :         </tr>
   22 :       </thead>
   23 :     {% endif %}
   24 :     <tbody>
   25 :       {% for row in table.page.object_list|default:table.rows %}
   26 :         <tr {{ row.attrs.as_html }}>
   27 :            {% for column, cell in row.items %} 
   28 :             <td {{ column.attrs.td.as_html }}>{{ cell }}</td>
   29 :           {% endfor %}
   30 :         </tr>
   31 :       {% empty %}
   32 :         {% if table.empty_text %}
   33 :           <tr>
   34 :             <td colspan="{{ table.columns|length }}" class="text-center text-muted">&mdash; {{ table.empty_text }} &mdash;</td>
   35 :           </tr>
   36 :         {% endif %}
   37 :       {% endfor %}


Traceback (most recent call last):
  File "/usr/local/lib/python3.10/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
  File "/usr/local/lib/python3.10/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/views/generic/base.py", line 84, in view
    return self.dispatch(request, *args, **kwargs)
  File "/opt/netbox/netbox/utilities/views.py", line 90, in dispatch
    return super().dispatch(request, *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/views/generic/base.py", line 119, in dispatch
    return handler(request, *args, **kwargs)
  File "/opt/netbox/netbox/netbox/views/generic/bulk_views.py", line 178, in get
    return render(request, self.template_name, context)
  File "/usr/local/lib/python3.10/site-packages/django/shortcuts.py", line 24, in render
    content = loader.render_to_string(template_name, context, request, using=using)
  File "/usr/local/lib/python3.10/site-packages/django/template/loader.py", line 62, in render_to_string
    return template.render(context, request)
  File "/usr/local/lib/python3.10/site-packages/django/template/backends/django.py", line 62, in render
    return self.template.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 175, in render
    return self._render(context)
  File "/usr/local/lib/python3.10/site-packages/django/test/utils.py", line 111, in instrumented_test_render
    return self.nodelist.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in render
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in <listcomp>
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/loader_tags.py", line 157, in render
    return compiled_parent._render(context)
  File "/usr/local/lib/python3.10/site-packages/django/test/utils.py", line 111, in instrumented_test_render
    return self.nodelist.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in render
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in <listcomp>
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/loader_tags.py", line 157, in render
    return compiled_parent._render(context)
  File "/usr/local/lib/python3.10/site-packages/django/test/utils.py", line 111, in instrumented_test_render
    return self.nodelist.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in render
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in <listcomp>
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/loader_tags.py", line 63, in render
    result = block.nodelist.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in render
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in <listcomp>
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/loader_tags.py", line 63, in render
    result = block.nodelist.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in render
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in <listcomp>
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/loader_tags.py", line 208, in render
    return template.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 177, in render
    return self._render(context)
  File "/usr/local/lib/python3.10/site-packages/django/test/utils.py", line 111, in instrumented_test_render
    return self.nodelist.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in render
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in <listcomp>
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/defaulttags.py", line 542, in render
    return self.nodelist.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in render
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in <listcomp>
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django_tables2/templatetags/django_tables2.py", line 167, in render
    return template.render(context={"table": table}, request=request)
  File "/usr/local/lib/python3.10/site-packages/django/template/backends/django.py", line 62, in render
    return self.template.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 175, in render
    return self._render(context)
  File "/usr/local/lib/python3.10/site-packages/django/test/utils.py", line 111, in instrumented_test_render
    return self.nodelist.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in render
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 1000, in <listcomp>
    return SafeString("".join([node.render_annotated(context) for node in self]))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/defaulttags.py", line 238, in render
    nodelist.append(node.render_annotated(context))
  File "/usr/local/lib/python3.10/site-packages/django/template/base.py", line 958, in render_annotated
    return self.render(context)
  File "/usr/local/lib/python3.10/site-packages/django/template/defaulttags.py", line 193, in render
    values = list(values)
  File "/usr/local/lib/python3.10/site-packages/django_tables2/rows.py", line 244, in items
    column.current_value = self.get_cell(column.name)
  File "/usr/local/lib/python3.10/site-packages/django_tables2/rows.py", line 197, in get_cell
    return self._get_and_render_with(
  File "/usr/local/lib/python3.10/site-packages/django_tables2/rows.py", line 173, in _get_and_render_with
    return render_func(bound_column, value)
  File "/usr/local/lib/python3.10/site-packages/django_tables2/rows.py", line 206, in _call_render
    content = call_with_appropriate(bound_column.render, render_kwargs)
  File "/usr/local/lib/python3.10/site-packages/django_tables2/utils.py", line 572, in call_with_appropriate
    return fn(**kwargs)
  File "/opt/netbox/netbox/netbox/tables/columns.py", line 224, in render
    url = reverse(get_viewname(model, action), kwargs={'pk': record.pk})
  File "/usr/local/lib/python3.10/site-packages/django/urls/base.py", line 88, in reverse
    return resolver._reverse_with_prefix(view, prefix, *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/urls/resolvers.py", line 802, in _reverse_with_prefix
    raise NoReverseMatch(msg)

Exception Type: NoReverseMatch at /plugins/netbox_consumables_plugin/consumables/
Exception Value: Reverse for 'consumable_edit' not found. 'consumable_edit' is not a valid view function or pattern name.

api/serializers.py

from rest_framework import serializers
from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer
from ..models import Consumable


class NestedConsumableSerializer(WritableNestedSerializer):
    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:netbox_consumables_plugin-api:consumable-detail"
    )

    class Meta:
        model = Consumable
        fields = ("id", "url", "display", "name")


class ConsumableSerializer(NetBoxModelSerializer):
    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:netbox_consumables_plugin-api:consumable-detail"
    )

    class Meta:
        model = Consumable

        fields = (
            "id",
            "url",
            "display",
            "name",
            "type",
            "manufacturer",
            "capacity",
            "quantity",
            "minimum_quantity",
            "description",
            "tags",
            "created",
            "last_updated",
        )

api/urls.py

from netbox.api.routers import NetBoxRouter
from . import views

app_name = "netbox_consumables_plugin"

router = NetBoxRouter()
router.register("consumable-lists", views.ConsumableViewSet)

urlpatterns = router.urls

api/views.py

from netbox.api.viewsets import NetBoxModelViewSet
from .. import models
from .serializers import ConsumableSerializer


class ConsumableViewSet(NetBoxModelViewSet):
    queryset = models.Consumable.objects.prefetch_related("name")
    serializer_class = ConsumableSerializer

models.py

from django.db import models
from netbox.models import NetBoxModel
from utilities.choices import ChoiceSet


class ConsumableTypeChoices(ChoiceSet):
    key = "Consumable.type"

    CHOICES = [
        ("ssd", "SSD"),
        ("hdd", "HDD"),
        ("nvme", "NVME"),
        ("raid", "Raid"),
        ("nic", "NIC"),
        ("psu", "PSU"),
    ]


class Consumable(NetBoxModel):
    """A Consumable represents a consumable physical object such as hard-drives,
    raid cards, or cables"""

    name = models.CharField(max_length=100)
    type = models.CharField(max_length=50, choices=ConsumableTypeChoices)
    manufacturer = models.CharField(
        max_length=50,
        blank=True,
    )
    capacity = models.PositiveIntegerField
    quantity = models.PositiveIntegerField()
    minimum_quantity = models.PositiveIntegerField()
    description = models.TextField(max_length=100, blank=True)

    class Meta:
        ordering = ("name",)

    def __str__(self):
        return self.name

views.py

from netbox.views import generic
from . import filters, forms, models, tables


class ConsumableListView(generic.ObjectListView):
    queryset = models.Consumable.objects.all()
    table = tables.ConsumableTable
    # This is commented out to see if it was a problem with the template I was using.
    # template_name = "netbox_consumables_plugin/list_view.html"


class ConsumableView(generic.ObjectListView):
    queryset = models.Consumable.objects.all()


class ConsumableEditView(generic.ObjectEditView):
    queryset = models.Consumable.objects.all()
    form = forms.ConsumableEditForm


class ConsumableDeleteView(generic.ObjectDeleteView):
    queryset = models.Consumable.objects.all()
    # default_return_url = "plugins:netbox_consumables_plugin:list_view"

urls.py

from django.urls import path
from . import views


urlpatterns = (
    path("consumables/", views.ConsumableListView.as_view(), name="list_view"),
    path("consumables/add/", views.ConsumableEditView.as_view(), name="add_consumable"),
    path(
        "consumables/<int:pk>/", views.ConsumableView.as_view(), name="view_consumable"
    ),
    path(
        "consumables/<int:pk>/edit/",
        views.ConsumableEditView.as_view(),
        name="edit_consumable",
    ),
    path(
        "consumables/<int:pk>/delete/",
        views.ConsumableDeleteView.as_view(),
        name="delete_consumable",
    ),
)

tables.py

from netbox.tables import NetBoxTable
from .models import Consumable


class ConsumableTable(NetBoxTable):
    class Meta(NetBoxTable.Meta):

        model = Consumable
        fields = (
            "id",
            "name",
            "type",
            "manufacturer",
            "capactiy",
            "quantity",
            "minimum_quantity",
            "description",
            "tags",
        )
        default_columns = (
            "name",
            "type",
            "manufacturer",
            "capactiy",
            "quantity",
            "minimum_quantity",
            "description",
            "tags",
        )

navigation.py

from utilities.choices import ButtonColorChoices
from extras.plugins import PluginMenuItem
from extras.plugins import PluginMenuButton, PluginMenuItem


consumable_buttons = [
    PluginMenuButton(
        link="plugins:netbox_consumables_plugin:add_consumable",
        title="Add",
        icon_class="mdi mdi-plus-thick",
        color=ButtonColorChoices.GREEN,
    )
]


menu_items = (
    PluginMenuItem(
        link="plugins:netbox_consumables_plugin:list_view",
        link_text="Consumables",
        buttons=consumable_buttons,
    ),
)