NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-12-20 12:22:23 -06:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Closes #15238: Include description field in brief mode

Browse Source
This commit is contained in:
Jeremy Stretch
2024-02-23 15:26:06 -05:00
parent c9a62ed6bd
commit 5c2f7fa59c
22 changed files with 200 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
netbox/virtualization/api/serializers.py
View File

@@ -33,7 +33,7 @@ class ClusterTypeSerializer(NetBoxModelSerializer):
'id', 'url', 'display', 'name', 'slug', 'description', 'tags', 'custom_fields', 'created', 'last_updated',
'cluster_count',
]
brief_fields = ('id', 'url', 'display', 'name', 'slug', 'cluster_count')
brief_fields = ('id', 'url', 'display', 'name', 'slug', 'description', 'cluster_count')
class ClusterGroupSerializer(NetBoxModelSerializer):
@@ -48,7 +48,7 @@ class ClusterGroupSerializer(NetBoxModelSerializer):
'id', 'url', 'display', 'name', 'slug', 'description', 'tags', 'custom_fields', 'created', 'last_updated',
'cluster_count',
]
brief_fields = ('id', 'url', 'display', 'name', 'slug', 'cluster_count')
brief_fields = ('id', 'url', 'display', 'name', 'slug', 'description', 'cluster_count')
class ClusterSerializer(NetBoxModelSerializer):
@@ -69,7 +69,7 @@ class ClusterSerializer(NetBoxModelSerializer):
'id', 'url', 'display', 'name', 'type', 'group', 'status', 'tenant', 'site', 'description', 'comments',
'tags', 'custom_fields', 'created', 'last_updated', 'device_count', 'virtualmachine_count',
]
brief_fields = ('id', 'url', 'display', 'name', 'virtualmachine_count')
brief_fields = ('id', 'url', 'display', 'name', 'description', 'virtualmachine_count')
#
@@ -102,7 +102,7 @@ class VirtualMachineSerializer(NetBoxModelSerializer):
'config_template', 'local_context_data', 'tags', 'custom_fields', 'created', 'last_updated',
'interface_count', 'virtual_disk_count',
]
brief_fields = ('id', 'url', 'display', 'name')
brief_fields = ('id', 'url', 'display', 'name', 'description')
validators = []
@@ -156,7 +156,7 @@ class VMInterfaceSerializer(NetBoxModelSerializer):
'description', 'mode', 'untagged_vlan', 'tagged_vlans', 'vrf', 'l2vpn_termination', 'tags', 'custom_fields',
'created', 'last_updated', 'count_ipaddresses', 'count_fhrp_groups',
]
brief_fields = ('id', 'url', 'display', 'virtual_machine', 'name')
brief_fields = ('id', 'url', 'display', 'virtual_machine', 'name', 'description')
def validate(self, data):
@@ -186,4 +186,4 @@ class VirtualDiskSerializer(NetBoxModelSerializer):
'id', 'url', 'display', 'virtual_machine', 'name', 'description', 'size', 'tags', 'custom_fields',
'created', 'last_updated',
]
brief_fields = ('id', 'url', 'display', 'virtual_machine', 'name', 'size')
brief_fields = ('id', 'url', 'display', 'virtual_machine', 'name', 'description', 'size')

6
netbox/virtualization/api/views.py
View File

@@ -56,12 +56,8 @@ class VirtualMachineViewSet(ConfigContextQuerySetMixin, RenderConfigMixin, NetBo
Else, return the VirtualMachineWithConfigContextSerializer
"""
request = self.get_serializer_context()['request']
if request.query_params.get('brief', False):
return serializers.NestedVirtualMachineSerializer
elif 'config_context' in request.query_params.get('exclude', []):
if self.brief or 'config_context' in request.query_params.get('exclude', []):
return serializers.VirtualMachineSerializer
return serializers.VirtualMachineWithConfigContextSerializer

12
netbox/virtualization/tests/test_api.py
View File

@@ -22,7 +22,7 @@ class AppTest(APITestCase):
class ClusterTypeTest(APIViewTestCases.APIViewTestCase):
model = ClusterType
brief_fields = ['cluster_count', 'display', 'id', 'name', 'slug', 'url']
brief_fields = ['cluster_count', 'description', 'display', 'id', 'name', 'slug', 'url']
create_data = [
{
'name': 'Cluster Type 4',
@@ -54,7 +54,7 @@ class ClusterTypeTest(APIViewTestCases.APIViewTestCase):
class ClusterGroupTest(APIViewTestCases.APIViewTestCase):
model = ClusterGroup
brief_fields = ['cluster_count', 'display', 'id', 'name', 'slug', 'url']
brief_fields = ['cluster_count', 'description', 'display', 'id', 'name', 'slug', 'url']
create_data = [
{
'name': 'Cluster Group 4',
@@ -86,7 +86,7 @@ class ClusterGroupTest(APIViewTestCases.APIViewTestCase):
class ClusterTest(APIViewTestCases.APIViewTestCase):
model = Cluster
brief_fields = ['display', 'id', 'name', 'url', 'virtualmachine_count']
brief_fields = ['description', 'display', 'id', 'name', 'url', 'virtualmachine_count']
bulk_update_data = {
'status': 'offline',
'comments': 'New comment',
@@ -138,7 +138,7 @@ class ClusterTest(APIViewTestCases.APIViewTestCase):
class VirtualMachineTest(APIViewTestCases.APIViewTestCase):
model = VirtualMachine
brief_fields = ['display', 'id', 'name', 'url']
brief_fields = ['description', 'display', 'id', 'name', 'url']
bulk_update_data = {
'status': 'staged',
}
@@ -248,7 +248,7 @@ class VirtualMachineTest(APIViewTestCases.APIViewTestCase):
class VMInterfaceTest(APIViewTestCases.APIViewTestCase):
model = VMInterface
brief_fields = ['display', 'id', 'name', 'url', 'virtual_machine']
brief_fields = ['description', 'display', 'id', 'name', 'url', 'virtual_machine']
bulk_update_data = {
'description': 'New description',
}
@@ -337,7 +337,7 @@ class VMInterfaceTest(APIViewTestCases.APIViewTestCase):
class VirtualDiskTest(APIViewTestCases.APIViewTestCase):
model = VirtualDisk
brief_fields = ['display', 'id', 'name', 'size', 'url', 'virtual_machine']
brief_fields = ['description', 'display', 'id', 'name', 'size', 'url', 'virtual_machine']
bulk_update_data = {
'size': 888,
}