API v2 considerations and requirements

[gotson]

Komga had a public api since the beginning, and despite very few change of contracts, it's been mostly stable so far. It has however some limitations that starts to show.

This is to summarize what will need to be done when bumping the API endpoints to v2.

• Should not return serialized PageImpl as the contract is not guaranteed
• collections should always return paged data, never a scalar
• collections should support unpaged
• collections should return shallow resources
• single resource endpoints should return detailed resource
• when it makes sense, we should break up single resource endpoint in multiple. For example how we get the book and it's pages separately.
• enum parameters should not leak from the domain model?
• Library deletion should return 202 Accepted and be done asynchronously, as deletion can take a long time with a huge library