Back to openSUSE Project
GSoC 2026

Uyuni: Migrate API Documentation to OpenAPI/Swagger

This project aims to modernize Uyuni API documentation system by replacing the existing Javadoc-based macro DSL with a standardized OpenAPI/Swagger approach. The current system lacks interactivity, standard tooling support, and automated validation, leading to outdated and hard-to-maintain documentation. To solve this, I will generate an OpenAPI specification from annotated Java interfaces using a custom Swagger reader, making it the single source of truth. This specification will power interactive Swagger UI within Uyuni, ensure contract validation through automated testing, and enable generation of existing documentation formats such as AsciiDoc, DocBook, and HTML.The key deliverables include migrating 60+ API handlers to the new structure, implementing validation and contract testing, integrating Swagger UI into the web interface, and developing parsers to maintain compatibility with existing documentation pipelines.

Project details

Contributor

master-hj

Mentors

Not available

Technologies

Not listed in the archive