Skip to content

Release 3 — HTTP contract extensions

Status shipped
Start Date 2026-10-03
Finish Date 2026-10-12

Wire features that the API conventions describe but no package implements, or only one stack does: JSON Merge Patch (RFC 7396) in rn-forge-web with Django and FastAPI bindings (F12.14), FastAPI route factories for :import, :importTemplate, :batchCreate, :batchDelete and capped export (F12.15), Content-Disposition in EXPOSED_HEADERS so a cross-origin browser can read export file names (F12.16), the fix for the Django RequestUtils name collision (F12.12), :batchGet and :batchUpdate (F12.1), soft delete in AIP-164's shape (F12.2), multi-column sorting with nulls last (F12.3), and AIP-157 readMask partial responses (F12.9).

Back to releases · Release runbook

Entry criteria

  • Release 2 is shipped.

Scope

Feature Epic State
F12.1 — :batchGet and :batchUpdate E12 Closed
F12.2 — Soft delete E12 Closed
F12.3 — Multi-column sorting E12 Closed
F12.9 — readMask partial responses E12 Closed
F12.12 — Django RequestUtils name collision E12 Closed
F12.14 — JSON Merge Patch E12 Closed
F12.15 — FastAPI resource operations E12 Closed
F12.16 — Expose Content-Disposition to browsers E12 Closed

Decisions

  • ADR-0010: soft delete is a nullable delete_time column, in AIP-164's shape (accepted 2026-10-04).

Breaking changes

pykit has no live consumers, so no deprecation window is kept.

  • F12.14: BaseModelViewSet answers a PATCH sent as application/json with 415; a client sends application/merge-patch+json.
  • F12.12: rn_forge.django.utils.RequestUtils is removed (its debug_request is now rn_forge.django.views.debug_request), as are rn_forge.django.drf.DRFUtils and RequestUtils.get_request_param, get_request_data and get_request_value.
  • F12.15: the transfer mixins change response details. A missing import file reads This field is required.; the import and batch row caps answer a 422 with no errors member; a missing or empty requests or ids member reads This field is required. or A non-empty list is required.
  • F12.3, in rn-forge-web: Cursor.sort_key becomes sort_keys, encode_cursor takes a sequence of sort values, and page tokens issued before the change are rejected with 400. The conformance case pagination.order-by-two-fields-is-400 is removed.
  • F12.3, in rn-forge-sqlalchemy: next_page_token takes one value per orderBy term, and keyset sorts nulls last.

Progress

Shipped 2026-10-12. Every feature in scope is closed (2026-10-04): F12.12, F12.14, F12.15 and F12.16, then F12.3, F12.1, F12.9 and F12.2, which were added to scope the same day. ADR-0010 is accepted. The push to main at merge commit 258f1d3 passed every verify, postgres, smoke and suite job plus import-boundaries, external-install, docs and the Sonar gate, and published the four new versions below.

Commits

Commits whose subject names a scope ID, newest first:

git log --format='%h %ad %s' --date=short -E --grep='F12\.(1|2|3|9|12|14|15|16)\b|S12\.(1|2|3|9|12|14|15|16)\.'

Exit criteria

  • F12.1, F12.2, F12.3, F12.9, F12.12, F12.14, F12.15 and F12.16 are Closed.
  • ADR-0010 (soft delete) is accepted.
  • docs/_update_board.sh --check passes.
  • The main CI, including the Sonar gate, passes on the release's version bumps.

Shipped

The four packages below were tagged and published by run 38344811163; the other three were already published and skipped. Each package's docs site serves the new version as latest.

Deliverable Version Tag Commit Verification
rn-forge-web 0.2.0 rn-forge-web-v0.2.0 258f1d3 published; external-install and docs passed
rn-forge-django 0.4.0 rn-forge-django-v0.4.0 258f1d3 published; external-install and docs passed
rn-forge-fastapi 0.2.0 rn-forge-fastapi-v0.2.0 258f1d3 published; external-install and docs passed
rn-forge-sqlalchemy 0.2.0 rn-forge-sqlalchemy-v0.2.0 258f1d3 published; external-install and docs passed