Introduce a serializer field for GenericForeignKeys #10442

New Issue

adam · 2025-12-29T21:31:30+01:00

adam commented

2025-12-29 21:31:30 +01:00

Originally created by @jeremystretch on GitHub (Nov 5, 2024).

Originally assigned to: @bctiemann on GitHub.

Proposed Changes

Devise and implement a custom serializer field to represent GenericForeignKeys on models. This is currently handled using a read-only SerializerMethodField, which requires a boilerplate method be included on the serializer class. For instance, the code below is from the serializer for circuit terminations:

    @extend_schema_field(serializers.JSONField(allow_null=True))
    def get_termination(self, obj):
        if obj.termination_id is None:
            return None
        serializer = get_serializer_for_model(obj.termination)
        context = {'request': self.context['request']}
        return serializer(obj.termination, nested=True, context=context).data

Justification

Introducing a custom field to represent GFK relationships allows us to enforce a standard implementation and reduce boilerplate.

Originally created by @jeremystretch on GitHub (Nov 5, 2024). Originally assigned to: @bctiemann on GitHub. ### Proposed Changes Devise and implement a custom serializer field to represent GenericForeignKeys on models. This is currently handled using a read-only [`SerializerMethodField`](https://www.django-rest-framework.org/api-guide/fields/#serializermethodfield), which requires a boilerplate method be included on the serializer class. For instance, the code below is from the serializer for circuit terminations: ```python @extend_schema_field(serializers.JSONField(allow_null=True)) def get_termination(self, obj): if obj.termination_id is None: return None serializer = get_serializer_for_model(obj.termination) context = {'request': self.context['request']} return serializer(obj.termination, nested=True, context=context).data ``` ### Justification Introducing a custom field to represent GFK relationships allows us to enforce a standard implementation and reduce boilerplate.

adam added the type: housekeeping netbox status: backlog labels 2025-12-29 21:31:30 +01:00

adam closed this issue

2025-12-29 21:31:30 +01:00

adam commented

2025-12-29 21:31:31 +01:00

@jeremystretch commented on GitHub (Nov 4, 2025):

As part of this change, we now expose the object_repr field on the /api/core/object-changes/ endpoint.

@jeremystretch commented on GitHub (Nov 4, 2025): As part of this change, we now expose the `object_repr` field on the `/api/core/object-changes/` endpoint.

adam referenced this issue

2025-12-29 23:19:58 +01:00

[PR #10442] [MERGED] 10435 check if vm.cluster in qs #13633

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#10442