Closes #21244: Introduce ability to omit specific fields from REST API responses #455

New Issue

MrUnknownDE · 2026-04-05T16:33:41+02:00

MrUnknownDE commented

2026-04-05 16:33:41 +02:00

Originally created by @jeremystretch on 1/28/2026

Closes: #21244

Extend BaseModelSerializer to accept the omit keyword argument on initialization.
Replace requested_fields() on BaseViewSet with field_kwargs(), which returns a dictionary to pass as kwargs when instantiating the serializer (e.g. {'fields': [...]}).
Update the get_prefetches_for_serializer() and get_annotations_for_serializer() functions to accept fields or omit.
Add documentation for the fields and omit parameters.

*Originally created by @jeremystretch on 1/28/2026* ### Closes: #21244 - Extend BaseModelSerializer to accept the `omit` keyword argument on initialization. - Replace `requested_fields()` on BaseViewSet with `field_kwargs()`, which returns a dictionary to pass as kwargs when instantiating the serializer (e.g. `{'fields': [...]}`). - Update the `get_prefetches_for_serializer()` and `get_annotations_for_serializer()` functions to accept `fields` or `omit`. - Add documentation for the `fields` and `omit` parameters.

MrUnknownDE closed this issue

2026-04-05 16:33:41 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

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

No Label

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#455