Closes #21356: Implement ETag support for REST API #279

New Issue

MrUnknownDE · 2026-04-05T16:24:30+02:00

MrUnknownDE commented

2026-04-05 16:24:30 +02:00

Originally created by @jeremystretch on 2/25/2026

Closes: #21356

`netbox/netbox/api/viewsets/init.py`

ETagMixin class (new, lines 37–56): Static helper _get_etag() returns a quoted ISO 8601 ETag derived from last_updated (falling back to created). The retrieve() override appends the ETag header to detail responses.
NetBoxReadOnlyModelViewSet and NetBoxModelViewSet: ETagMixin added as the first base class, giving its retrieve() priority in the MRO over DRF's RetrieveModelMixin.retrieve().
update(): Added an If-Match precondition check per RFC 9110 §13.1.1 — if the header is present and not *, it compares against the current ETag and returns 412 Precondition Failed on mismatch. The response now includes a
fresh ETag reflecting the updated last_updated value.
create(): Single-object creation responses now include an ETag header. Bulk creation responses do not (no single canonical object).

`netbox/utilities/testing/api.py`

test_get_object(): After the 200 OK assertion, verifies that ChangeLoggingMixin models return an ETag header.
test_update_object_with_etag() (new method): End-to-end test that verifies correct-ETag PATCH returns 200 with a changed ETag, and stale-ETag PATCH returns 412.

*Originally created by @jeremystretch on 2/25/2026* ### Closes: #21356 #### `netbox/netbox/api/viewsets/__init__.py` 1. ETagMixin class (new, lines 37–56): Static helper `_get_etag()` returns a quoted ISO 8601 ETag derived from last_updated (falling back to created). The retrieve() override appends the ETag header to detail responses. 2. NetBoxReadOnlyModelViewSet and NetBoxModelViewSet: ETagMixin added as the first base class, giving its `retrieve()` priority in the MRO over DRF's `RetrieveModelMixin.retrieve()`. 3. `update()`: Added an If-Match precondition check per RFC 9110 §13.1.1 — if the header is present and not *, it compares against the current ETag and returns 412 Precondition Failed on mismatch. The response now includes a fresh ETag reflecting the updated last_updated value. 4. `create()`: Single-object creation responses now include an ETag header. Bulk creation responses do not (no single canonical object). #### `netbox/utilities/testing/api.py` 1. `test_get_object()`: After the 200 OK assertion, verifies that ChangeLoggingMixin models return an ETag header. 2. `test_update_object_with_etag()` (new method): End-to-end test that verifies correct-ETag PATCH returns 200 with a changed ETag, and stale-ETag PATCH returns 412.

MrUnknownDE closed this issue

2026-04-05 16:24:30 +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#279