gitea
/
Koha-clms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Koha-clms/api/v1/swagger/paths
History
Jake Deery f33638f14b
Bug 35761: Introduce central FTP/SFTP management 
This patch adds a central FTP/SFTP management UI, with an associated
database object and class, plus the beginnings of an API. We can use
this code as a building block for adding FTP/SFTP connections to
other parts of the system, as well as to improve the usability of the
EDI transports. It is also now possible to test these connections
from within the Koha UI.

To test:-
You will need access to an FTP or SFTP server
Contact me if you need a disposable FTP/SFTP server

a)  Go to Koha Administration
b)  Notice no FTP/SFTP referenced on this page
c)  APPLY PATCH, reset_all
d)  Create new user, let's say sftpuser
e)  Set permissions for new user to include:
    1)  catalogue
    2)  parameters -> manage_sftp_servers
f)  Log in with this new user, go back to Koha Administration
    1)  Notice the FTP/SFTP servers option
g)  Undo step e2) for the sftpuser via the koha admin user
    1)  Refresh the Koha Administration page as the sftpuser
    2)  Notice how FTP/SFTP servers has disappeared
h)  Back to koha admin, go to Koha Administration -> FTP/SFTP Servers -> New
i)  Complete form depending on the FTP or SFTP server you have access to, Submit
    1)  Notice you are prompted to confirm before saving
j)  Select Edit, observe your details are the same, and Submit again
k)  Repeat step J one additional time
l)  Select Test, observe all tests passing
m)  Select Delete, confirm deletion, and observe server disappear
n)  Optionally, run prove on new tests
    1)  t/Koha/Auth/Permissions.t
    2)  t/db_dependent/Koha/SFTP/Server.t
    3)  t/db_dependent/api/v1/sftp_servers.t
o)  SIGN-OFF

Signed-off-by: Andrew Fuerste Henry <andrew@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>
 		2025-09-19 13:23:11 -06:00
..
acquisitions_baskets.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
acquisitions_edifiles.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
acquisitions_funds.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
acquisitions_orders.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
acquisitions_vendor_issues.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
acquisitions_vendors.yaml Bug 38010: Embed invoices_count - fix patron deletion from show view 2025-05-05 10:33:51 +02:00
acquisitions_vendors_config.yaml Bug 38010: (QA follow-up) Add a config endpoint for permissions 2025-05-02 17:19:16 +02:00
additional_contents.yaml Bug 39900: (follow-up) Add a newline to end of additional_contents.yaml 2025-08-15 09:52:29 -06:00
advancededitormacros.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
article_requests.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
auth.yaml Bug 36561: Make /auth/password/validation use new permission 2025-07-24 17:04:05 -06:00
authorised_value_categories.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
authorised_values.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
authorities.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
biblios.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
biblios_item_groups.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
biblios_merge.yaml Bug 37791: Fix 'Biblio not found' messages on the API 2024-10-11 12:21:29 +02:00
bookings.yaml Bug 33736: (follow-up) Remove top-level embed in bookings.yaml 2024-10-25 11:09:57 +02:00
cash_registers.yaml Bug 39091: Add cash registers list REST API endpoint 2025-07-23 16:36:40 -06:00
checkouts.yaml Bug 40665: API spec changes 2025-09-05 15:10:36 -06:00
circulation_rules.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
cities.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
clubs.yaml Bug 25787: Update club holds to only require place_holds permission 2025-05-06 18:48:23 +02:00
config_sftp_servers.yaml Bug 35761: Introduce central FTP/SFTP management 2025-09-19 13:23:11 -06:00
config_smtp_servers.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
deleted_biblios.yaml Bug 37791: Fix 'Biblio not found' messages on the API 2024-10-11 12:21:29 +02:00
erm_agreements.yaml Bug 37576: Add additional fields for ERM agreements 2024-11-08 16:09:17 +01:00
erm_config.yaml Bug 34387: Improve API docs naming consistency 2023-08-15 11:25:35 +03:00
erm_counter_files.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_counter_logs.yaml Bug 36627: Rename embed method to patron 2024-12-23 13:36:14 +01:00
erm_counter_registries.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_custom_reports.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_default_usage_reports.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_documents.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_eholdings_packages.yaml Bug 37577: Add additional fields for ERM packages 2024-11-08 16:09:19 +01:00
erm_eholdings_packages_resources.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_eholdings_resources.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_eholdings_titles.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_eholdings_titles_resources.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_licenses.yaml Bug 35287: REST API - Add additional fields support to ERM Licenses 2024-10-24 13:38:19 +02:00
erm_sushi_services.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_usage_data_providers.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_usage_databases.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_usage_items.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_usage_platforms.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_usage_titles.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
erm_users.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
extended_attribute_types.yaml Bug 37577: Add additional fields for ERM packages 2024-11-08 16:09:19 +01:00
holds.yaml Bug 36135: Add ability to batch modify holds 2025-09-03 14:00:48 -06:00
ill_backends.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
ill_batches.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
ill_batchstatuses.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
ill_requests.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
import_batch_profiles.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
import_batches.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
item_types.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
items.yaml Bug 35906: Remove preference and add override handling 2024-10-25 15:34:41 +02:00
jobs.yaml Revert "Bug 36217: Fix background jobs page's include_last_hour filter" 2024-10-18 14:26:01 +02:00
libraries.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
lists.yaml Bug 28965: Add /public/lists 2024-11-08 16:09:21 +01:00
oauth.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
patron_categories.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
patrons.yaml Bug 39600: Fix spec to include invalid query handling 2025-04-29 17:19:34 +02:00
patrons_account.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
patrons_checkouts.yaml Bug 40665: API spec changes 2025-09-05 15:10:36 -06:00
patrons_extended_attributes.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
patrons_holds.yaml Bug 40543: Remove pickup_library.branchname embed 2025-08-14 16:06:00 -06:00
patrons_password.yaml Bug 29926: (QA follow-up) Date format missing in spec 2022-05-06 10:33:10 -10:00
patrons_recalls.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
preservation_config.yaml Bug 36565: Preservation module API docs fixes (bug 30708 follow-up) 2024-04-29 09:35:36 +02:00
preservation_processings.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
preservation_trains.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
preservation_waiting_list.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
public_oauth.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
public_patrons.yaml Bug 39600: Fix spec to include invalid query handling 2025-04-29 17:19:34 +02:00
quotes.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
record_sources.yaml Bug 37513: Allow embedding usage_count in record sources 2024-08-27 12:14:25 +02:00
return_claims.yaml Bug 33292: Add logic to handle refunding a lost fee 2024-10-24 13:38:15 +02:00
rotas.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
search_filters.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
suggestions.yaml Bug 33430: Update API specs to include required embeds 2025-05-19 18:54:20 +02:00
test_sftp_servers.yaml Bug 35761: Introduce central FTP/SFTP management 2025-09-19 13:23:11 -06:00
tickets.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00
transfer_limits.yaml Bug 37018: Add 400 response definition to all routes 2024-08-01 17:26:44 +02:00