aboutsummaryrefslogtreecommitdiff
path: root/doc/release-notes-24098.md
diff options
context:
space:
mode:
authorstickies-v <stickies-v@protonmail.com>2022-01-18 21:08:48 +0000
committerstickies-v <stickies-v@protonmail.com>2022-04-05 13:19:37 -0400
commit54b39cfb342d10a448d49299c715e3a25c2aca4a (patch)
tree0eec8e466f61f06ec832eb6c467749c13d87cea0 /doc/release-notes-24098.md
parentf959fc0397c3f3615e99bc28d2df549d9d52f277 (diff)
downloadbitcoin-54b39cfb342d10a448d49299c715e3a25c2aca4a.tar.xz
Add release notes
Diffstat (limited to 'doc/release-notes-24098.md')
-rw-r--r--doc/release-notes-24098.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/release-notes-24098.md b/doc/release-notes-24098.md
new file mode 100644
index 0000000000..79e047e9a5
--- /dev/null
+++ b/doc/release-notes-24098.md
@@ -0,0 +1,22 @@
+Notable changes
+===============
+
+Updated REST APIs
+-----------------
+
+- The `/headers/` and `/blockfilterheaders/` endpoints have been updated to use
+ a query parameter instead of path parameter to specify the result count. The
+ count parameter is now optional, and defaults to 5 for both endpoints. The old
+ endpoints are still functional, and have no documented behaviour change.
+
+ For `/headers`, use
+ `GET /rest/headers/<BLOCK-HASH>.<bin|hex|json>?count=<COUNT=5>`
+ instead of
+ `GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex|json>` (deprecated)
+
+ For `/blockfilterheaders/`, use
+ `GET /rest/blockfilterheaders/<FILTERTYPE>/<BLOCK-HASH>.<bin|hex|json>?count=<COUNT=5>`
+ instead of
+ `GET /rest/blockfilterheaders/<FILTERTYPE>/<COUNT>/<BLOCK-HASH>.<bin|hex|json>` (deprecated)
+
+ (#24098)