Document API routes design through ADR

[demeringo]

Problem

With the addition of new objects in V0.3 (terminals, peripherals a.s.o) we need more routes in the API.

We have been discussing though various chnnels what would be the best way regarding how to organize or names API routes.

Theses informal discussions or design choices would be interresting to serve as guidelines document for future implementers.

Solution

I propose to create a Architecture Decision Record on the subject, and formalize our different perspectives on the subject through the related PR.

Alternatives

Additional context or elements

Some of the requierements were to ensure that routes remain easy to integrate (like when building GUI), discoverable, consistent and understandable from end-user perspective.

Need to extrac the schematic from Miro also.

[demeringo]

@da-ekchajzer @AirLoren @bpetit @samuelrince I will initiate this when time permit ;-)

[da-ekchajzer]

This page should help : https://dev.doc.api.boavizta.org/Reference/routes/

[da-ekchajzer]

@demeringo do you think this documentation is sufficient https://dev.doc.api.boavizta.org/Reference/routes/? If not, what do you have in mind?