adds standardized list API for scripts and reports #13037

netbox/extras/api/serializers.py

@@ -481,6 +481,11 @@ class ReportSerializer(serializers.Serializer):
  description = serializers.CharField(max_length=255, required=False)
  test_methods = serializers.ListField(child=serializers.CharField(max_length=255))
  result = NestedJobSerializer()
+ display = serializers.SerializerMethodField(read_only=True)
+
+ @extend_schema_field(serializers.CharField())
+ def get_display(self, obj):
+ return str(obj)
 
 
 class ReportDetailSerializer(ReportSerializer):
@@ -518,13 +523,18 @@ class ScriptSerializer(serializers.Serializer):
  description = serializers.CharField(read_only=True)
  vars = serializers.SerializerMethodField(read_only=True)
  result = NestedJobSerializer()
+ display = serializers.SerializerMethodField(read_only=True)
 
  @extend_schema_field(serializers.JSONField(allow_null=True))
  def get_vars(self, instance):
  return {
  k: v.__class__.__name__ for k, v in instance._get_vars().items()
  }
 
+ @extend_schema_field(serializers.CharField())
+ def get_display(self, obj):
+ return str(obj)
+
 
 class ScriptDetailSerializer(ScriptSerializer):
  result = JobSerializer()

netbox/extras/api/views.py

@@ -243,7 +243,7 @@ def list(self, request):
  'request': request,
  })
 
- return Response(serializer.data)
+ return Response({'count': len(report_list), 'results': serializer.data})
 
  def retrieve(self, request, pk):
  """
@@ -343,7 +343,7 @@ def list(self, request):
 
  serializer = serializers.ScriptSerializer(script_list, many=True, context={'request': request})
 
- return Response(serializer.data)
+ return Response({'count': len(serializer.data), 'results': serializer.data})
 
  def retrieve(self, request, pk):
  module, script = self._get_script(pk)