mirror of
https://github.com/netbox-community/netbox.git
synced 2025-07-16 04:02:52 -06:00
Closes #19722: Extend the object types REST API endpoint
This commit is contained in:
parent
a1cd81ff35
commit
3c8cafe6e0
@ -1,7 +1,9 @@
|
|||||||
from django.contrib.contenttypes.models import ContentType, ContentTypeManager
|
from django.contrib.contenttypes.models import ContentType, ContentTypeManager
|
||||||
from django.db.models import Q
|
from django.db.models import Q
|
||||||
|
|
||||||
|
from netbox.plugins import PluginConfig
|
||||||
from netbox.registry import registry
|
from netbox.registry import registry
|
||||||
|
from utilities.string import title
|
||||||
|
|
||||||
__all__ = (
|
__all__ = (
|
||||||
'ObjectType',
|
'ObjectType',
|
||||||
@ -48,3 +50,30 @@ class ObjectType(ContentType):
|
|||||||
|
|
||||||
class Meta:
|
class Meta:
|
||||||
proxy = True
|
proxy = True
|
||||||
|
|
||||||
|
@property
|
||||||
|
def app_labeled_name(self):
|
||||||
|
# Override ContentType's "app | model" representation style.
|
||||||
|
return f"{self.app_verbose_name} > {title(self.model_verbose_name)}"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def app_verbose_name(self):
|
||||||
|
if model := self.model_class():
|
||||||
|
return model._meta.app_config.verbose_name
|
||||||
|
|
||||||
|
@property
|
||||||
|
def model_verbose_name(self):
|
||||||
|
if model := self.model_class():
|
||||||
|
return model._meta.verbose_name
|
||||||
|
|
||||||
|
@property
|
||||||
|
def model_verbose_name_plural(self):
|
||||||
|
if model := self.model_class():
|
||||||
|
return model._meta.verbose_name_plural
|
||||||
|
return model._meta.label
|
||||||
|
|
||||||
|
@property
|
||||||
|
def is_plugin_model(self):
|
||||||
|
if not (model := self.model_class()):
|
||||||
|
return # Return null if model class is invalid
|
||||||
|
return isinstance(model._meta.app_config, PluginConfig)
|
||||||
|
@ -1,7 +1,11 @@
|
|||||||
|
import inspect
|
||||||
|
|
||||||
|
from django.urls import NoReverseMatch, reverse
|
||||||
from rest_framework import serializers
|
from rest_framework import serializers
|
||||||
|
|
||||||
from core.models import ObjectType
|
from core.models import ObjectType
|
||||||
from netbox.api.serializers import BaseModelSerializer
|
from netbox.api.serializers import BaseModelSerializer
|
||||||
|
from utilities.views import get_viewname
|
||||||
|
|
||||||
__all__ = (
|
__all__ = (
|
||||||
'ObjectTypeSerializer',
|
'ObjectTypeSerializer',
|
||||||
@ -10,7 +14,30 @@ __all__ = (
|
|||||||
|
|
||||||
class ObjectTypeSerializer(BaseModelSerializer):
|
class ObjectTypeSerializer(BaseModelSerializer):
|
||||||
url = serializers.HyperlinkedIdentityField(view_name='extras-api:objecttype-detail')
|
url = serializers.HyperlinkedIdentityField(view_name='extras-api:objecttype-detail')
|
||||||
|
app_name = serializers.CharField(source='app_verbose_name', read_only=True)
|
||||||
|
model_name = serializers.CharField(source='model_verbose_name', read_only=True)
|
||||||
|
model_name_plural = serializers.CharField(source='model_verbose_name_plural', read_only=True)
|
||||||
|
is_plugin_model = serializers.BooleanField(read_only=True)
|
||||||
|
rest_api_endpoint = serializers.SerializerMethodField()
|
||||||
|
description = serializers.SerializerMethodField()
|
||||||
|
|
||||||
class Meta:
|
class Meta:
|
||||||
model = ObjectType
|
model = ObjectType
|
||||||
fields = ['id', 'url', 'display', 'app_label', 'model']
|
fields = [
|
||||||
|
'id', 'url', 'display', 'app_label', 'app_name', 'model', 'model_name', 'model_name_plural',
|
||||||
|
'is_plugin_model', 'rest_api_endpoint', 'description',
|
||||||
|
]
|
||||||
|
|
||||||
|
def get_rest_api_endpoint(self, obj):
|
||||||
|
if not (model := obj.model_class()):
|
||||||
|
return
|
||||||
|
if viewname := get_viewname(model, action='list', rest_api=True):
|
||||||
|
try:
|
||||||
|
return reverse(viewname)
|
||||||
|
except NoReverseMatch:
|
||||||
|
return
|
||||||
|
|
||||||
|
def get_description(self, obj):
|
||||||
|
if not (model := obj.model_class()):
|
||||||
|
return
|
||||||
|
return inspect.getdoc(model)
|
||||||
|
Loading…
Reference in New Issue
Block a user