Bug 35613 - Migrate spec to OpenAPI v3
Summary: Migrate spec to OpenAPI v3
Status: NEW
Alias: None
Product: Koha
Classification: Unclassified
Component: REST API (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Tomás Cohen Arazi (tcohen)
QA Contact:
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-12-20 12:55 UTC by Tomás Cohen Arazi (tcohen)
Modified: 2025-01-21 22:14 UTC (History)
5 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Tomás Cohen Arazi (tcohen) 2023-12-20 12:55:49 UTC
Things to do:
- Convert our spec into OpenAPIv3 (probably using redocly)
- Migrate array types ("type" and "null") into using the "nullable": true provided attribute
- Verify no regressions found
- Report potential issues to https://github.com/jhthorsen/mojolicious-plugin-openapi
- Split the bundled spec into pieces as we have now.
- The generated api.koha-community.org documentation needs to be at least the same in terms of information and usability.
Comment 1 Martin Renvoize (ashimema) 2023-12-20 13:20:29 UTC
Awesome!
Comment 2 David Cook 2025-01-21 22:14:57 UTC
How would this affect Koha plugins that add plugin routes? 

Will we just need to make an announcement that all plugins will need to be updated from Koha version xx.yy?