Kitura / Kitura/Kitura-OpenAPI
Flag API changes
@adam-rocska is already working on this.
Since May 19, 2026.
- Dominant language
- Swift
- Stars
- 37
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Use the Swagger generation of Kitura as the basis for implementing a mechanism to highlight API changes.
This would be implemented by comparing the in-memory representation of the swagger with one previously written to disk.
This may be a problematic task as a comparison would be order dependent so a simple diff would probably not work. We would need some way of sorting the swagger prior to comparison.
Possibly we could add a hash generated from the in-memory model into the description in the file.
Assuming the above is achieved, then we also need to:
- Have a means to enable this feature, possibly only for debug, but not release.
- Highlight when a change has occurred and then implement an appropriate action; for example, output a message and halt the server.
Clear & Actionable Tasks
- Implement a mechanism for comparing swagger documents on disk and in-memory.
- Implement start-up arguments to enable the feature in debug mode.
- At start-up, normalise the in-memory swagger and the on-disk swagger and compare them.
- Highlight an API difference when is occurs .
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.