Fixes #20933: Fix writable data_file assignment for ConfigContext and ConfigContextProfile via the REST API #583

New Issue

MrUnknownDE · 2026-04-05T16:47:17+02:00

MrUnknownDE commented

2026-04-05 16:47:17 +02:00

Originally created by @pheus on 1/14/2026

Fixes: #20933

This PR fixes the REST API behavior for assigning a ConfigContext (and ConfigContextProfile) to a synced DataFile.

Previously, data_file was marked read_only on the ConfigContext/ConfigContextProfile serializers, so PATCH/POST requests would silently ignore data_file (and data_path would not persist), even though the UI supports this workflow.

Changes included:

Removed read_only=True from the data_file field on the relevant ConfigContext and ConfigContextProfile serializers to allow setting it via the API (by ID).
Marked the appropriate fields in DataFileSerializer as read_only (e.g. path, last_updated, size, hash) since these values are managed by the data source sync process and should not be modified through the API.
Added API regression tests covering PATCHing data_source + data_file for both ConfigContext and ConfigContextProfile.

This brings the API in line with the UI and prevents silent no-op updates when referencing synced files.

*Originally created by @pheus on 1/14/2026* ### Fixes: #20933 This PR fixes the REST API behavior for assigning a `ConfigContext` (and `ConfigContextProfile`) to a synced `DataFile`. Previously, `data_file` was marked `read_only` on the `ConfigContext`/`ConfigContextProfile` serializers, so PATCH/POST requests would silently ignore `data_file` (and `data_path` would not persist), even though the UI supports this workflow. Changes included: - Removed `read_only=True` from the `data_file` field on the relevant `ConfigContext` and `ConfigContextProfile` serializers to allow setting it via the API (by ID). - Marked the appropriate fields in `DataFileSerializer` as `read_only` (e.g. `path`, `last_updated`, `size`, `hash`) since these values are managed by the data source sync process and should not be modified through the API. - Added API regression tests covering PATCHing `data_source` + `data_file` for both `ConfigContext` and `ConfigContextProfile`. This brings the API in line with the UI and prevents silent no-op updates when referencing synced files.

MrUnknownDE closed this issue

2026-04-05 16:47:17 +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#583