From 54b39cfb342d10a448d49299c715e3a25c2aca4a Mon Sep 17 00:00:00 2001 From: stickies-v Date: Tue, 18 Jan 2022 21:08:48 +0000 Subject: [PATCH] Add release notes --- doc/release-notes-24098.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 doc/release-notes-24098.md diff --git a/doc/release-notes-24098.md b/doc/release-notes-24098.md new file mode 100644 index 00000000000..79e047e9a56 --- /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/.?count=` + instead of + `GET /rest/headers//.` (deprecated) + + For `/blockfilterheaders/`, use + `GET /rest/blockfilterheaders//.?count=` + instead of + `GET /rest/blockfilterheaders///.` (deprecated) + + (#24098)