Skip to content

docs: Backfill API-CHANGELOG.md for 3.1.1 through 3.3.0 - #8159

Open
mvadari wants to merge 2 commits into
XRPLF:developfrom
mvadari:mvadari/update-api-changelog
Open

docs: Backfill API-CHANGELOG.md for 3.1.1 through 3.3.0#8159
mvadari wants to merge 2 commits into
XRPLF:developfrom
mvadari:mvadari/update-api-changelog

Conversation

@mvadari

@mvadari mvadari commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

High Level Overview of Change

API-CHANGELOG.md hasn't been updated since the 3.1.0 release: everything shipped in 3.1.1, 3.1.2, 3.1.3, 3.2.0, 3.2.1, and 3.3.0 was still sitting under Unreleased. This PR adds version sections for each of those releases and moves the entries that already shipped out of Unreleased. Entries that have only landed on develop/3.4.0 betas (not yet in a final release) stay in Unreleased.

Context of Change

Doc-only change, no code changes. Release mapping was determined by checking which tag first contains each entry's PR merge commit on develop:

API Impact

  • Public API: New feature (new methods and/or new fields)
  • Public API: Breaking change (in general, breaking changes should only impact the next api_version)
  • libxrpl change (any change that may affect libxrpl or dependents of libxrpl)
  • Peer protocol change (must be backward compatible or bump the peer protocol version)

Adds version sections for 3.1.1, 3.1.2, 3.1.3, 3.2.0, 3.2.1, and 3.3.0
(all released since the changelog was last updated for 3.1.0), and
moves the corresponding entries out of Unreleased. Entries that have
only shipped in 3.4.0 betas remain in Unreleased.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The change is documentation-only and the updated changelog structure and entry placement appear consistent and coherent with the stated release mapping.

Pull request overview

Backfills API-CHANGELOG.md with explicit release sections for 3.1.1 through 3.3.0, moving already-shipped API notes out of Unreleased while keeping develop-only items in Unreleased for the next release cycle.

Changes:

  • Added new changelog sections for releases 3.3.0, 3.2.1, 3.1.3, 3.1.2, and 3.1.1 (including “bugfixes only” notes where applicable).
  • Moved the account_tx delegation-filter entry into the 3.3.0 section and adjusted 3.2.0 headings to be release-scoped.
  • Kept develop-only API notes (e.g., vault_info error improvements, input validation changes, ledger metadata additions) under Unreleased.
File summaries
File Description
API-CHANGELOG.md Reorganized and backfilled API changelog entries into the correct released versions while preserving unreleased items.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@mvadari mvadari added this to the 3.4.0 milestone Sep 1, 2026
@mvadari
mvadari requested a review from bthomee September 1, 2026 22:30
@mvadari mvadari added the Trivial Simple change with minimal effect, or already tested. Only needs one approval. label Sep 1, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The markdown heading levels make the new 3.4.0 content no longer part of ## Unreleased, leaving Unreleased effectively empty and breaking the intended document structure.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (1)

API-CHANGELOG.md:35

  • After nesting 3.4.0 under Unreleased, the Additions in 3.4.0 / Bugfixes in 3.4.0 headings should also be demoted one level to keep a consistent heading hierarchy.
### Additions in 3.4.0

- `ledger`: `nftoken_id`, `nftoken_ids`, and `offer_id` are now included in transaction metadata when transactions are expanded (`expand`, or admin-only `full`), matching the `tx`, `account_tx`, and `subscribe` (`transactions` stream) responses. ([#5706](https://github.com/XRPLF/rippled/pull/5706))

### Bugfixes in 3.4.0
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

Comment thread API-CHANGELOG.md
Comment on lines 25 to +30
## Unreleased

This section contains changes targeting a future version.

### Additions
## XRP Ledger server version 3.4.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Trivial Simple change with minimal effect, or already tested. Only needs one approval.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants