Bug 41994 - REST API route to list system preferences
Summary: REST API route to list system preferences
Status: Signed Off
Alias: None
Product: Koha
Classification: Unclassified
Component: REST API (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low enhancement
Assignee: Jonathan Druart
QA Contact: Testopia
URL:
Keywords:
Depends on: 41834
Blocks: 41995
  Show dependency treegraph
 
Reported: 2026-03-05 10:33 UTC by Jonathan Druart
Modified: 2026-03-05 11:42 UTC (History)
1 user (show)

See Also:
GIT URL:
Initiative type: ---
Sponsorship status: ---
Comma delimited list of Sponsors:
Crowdfunding goal: 0
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments
Bug 41994: Implement /sysprefs route to list system preferences (8.79 KB, patch)
2026-03-05 10:41 UTC, Jonathan Druart
Details | Diff | Splinter Review
Bug 41994: Implement /sysprefs route to list system preferences (8.84 KB, patch)
2026-03-05 11:42 UTC, Owen Leonard
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Jonathan Druart 2026-03-05 10:33:39 UTC

    
Comment 1 Jonathan Druart 2026-03-05 10:41:44 UTC
Created attachment 194491 [details] [review]
Bug 41994: Implement /sysprefs route to list system preferences

This new route will be used in a follow-up bug to auto-complete sysprefs
when using the header to search for sysprefs.

Note that this is based on top of bug 41834 that NULL options,
explanation and type in DB, but a future enhancement will populate the
response to return the values present in the yaml files.

Test plan:
1. Bundle the swagger specs and reload plack:
 yarn api:bundle && koha-plack --reload kohadev
2. Fetch the sysprefs using the new route:
 curl -u koha:koha --request GET 'http://${INSTANCE}-intra.localhost/api/v1/sysprefs' --header "Content-Type: application/json" | jq
3. Confirm that the tests pass
 prove t/db_dependent/api/v1/sysprefs.t
Comment 2 Owen Leonard 2026-03-05 11:42:23 UTC
Created attachment 194496 [details] [review]
Bug 41994: Implement /sysprefs route to list system preferences

This new route will be used in a follow-up bug to auto-complete
sysprefs when using the header to search for sysprefs.

Note that this is based on top of bug 41834 that NULL options,
explanation and type in DB, but a future enhancement will populate the
response to return the values present in the yaml files.

Test plan:
1. Bundle the swagger specs and reload plack:
   yarn api:bundle && koha-plack --reload kohadev
2. Fetch the sysprefs using the new route:
 curl -u koha:koha --request GET 'http://${INSTANCE}-intra.localhost/api/v1/sysprefs' --header "Content-Type: application/json" | jq
3. Confirm that the tests pass
   prove t/db_dependent/api/v1/sysprefs.t

Signed-off-by: Owen Leonard <oleonard@myacpl.org>