Skip to content

development/api: Firewall - drop removed savepoint/rollback actions#892

Merged
AdSchellevis merged 1 commit into
opnsense:masterfrom
chrstnth:firewall-remove-savepoint-docs
Jul 22, 2026
Merged

development/api: Firewall - drop removed savepoint/rollback actions#892
AdSchellevis merged 1 commit into
opnsense:masterfrom
chrstnth:firewall-remove-savepoint-docs

Conversation

@chrstnth

Copy link
Copy Markdown
Contributor

The Firewall API reference documented a savepoint / rollback mechanism
(savepoint(), apply(savepoint), cancelRollback(sp), revert()) that
was removed from core in opnsense/core#10411 (released in 26.7, tracked by
opnsense/core#10235).

This updates the reference to the current apply-only flow:

  • rewrite the Concept section and blockdiag to a plain apply() step
  • drop the rollback-related Tip and Note
  • replace the savepoint example with a plain apply example
    (firewall.apply.py, replacing firewall.savepoint.py)
  • clean the filter_base endpoint table (apply without
    $rollback_revision, remove cancel_rollback / revert / savepoint)

The filter_base table was edited in place rather than regenerated in
full, to keep this change scoped to the savepoint removal; the rest of the
firewall endpoint tables carry unrelated drift that a full
collect_api_endpoints.py refresh would pick up.

closes #891

The Firewall API reference documented a savepoint / rollback mechanism
(savepoint(), apply(savepoint), cancelRollback(sp), revert()) that was
removed from core in opnsense/core#10411 (released in 26.7, tracked by
opnsense/core#10235).

Update the reference to the current apply-only flow: rewrite the Concept
section and blockdiag to a plain apply() step, drop the rollback-related
Tip and Note, replace the savepoint example with a plain apply example
(firewall.apply.py), and clean the filter_base endpoint table (apply
without $rollback_revision, remove cancel_rollback / revert / savepoint).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@AdSchellevis AdSchellevis self-assigned this Jul 22, 2026
@AdSchellevis AdSchellevis added the cleanup Low impact changes label Jul 22, 2026
@AdSchellevis
AdSchellevis merged commit f9807ac into opnsense:master Jul 22, 2026
@AdSchellevis

Copy link
Copy Markdown
Member

@chrstnth thanks, we forgot about the docs here.

@chrstnth
chrstnth deleted the firewall-remove-savepoint-docs branch July 22, 2026 06:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Low impact changes

Development

Successfully merging this pull request may close these issues.

Firewall API reference documents removed savepoint/rollback actions (removed in core #10411)

2 participants