Redesign admin APIs to make them friendly to call about turms HOT 1 OPEN

Draft notes:

• Use singular nouns always because:
  • Using plural nouns is confusing for some resources like cluster leader because there is only one cluster and leader for any turms servers. If there is more than one leader or cluster, it's a bug, so it is more reasonable to use singular nouns here, i.e.: /cluster/member.
  • Using consistent names, so using singular nouns always.
  • It has no benefit to use plural nouns.
• Move query filters from the URL query params into the request body in JSON because:
  • Using URL query params is painful to construct and parse complex filters, e.g. ?mylist%5B0%5D.name=abc&mylist%5B0%5D.age=123&mylist%5B1%5D&name="zxc".
  • It's consistent and easy to use JSON in any programming language.
• Always use a map/object as the value of the response data, and never use a list because of its schema flexibility.
• Use POST consistently and move the action to the URL because:
  • Some proxies and companies disable HTTP request methods like DELETE by default, which will cause troubles for Turms users.
  • Many HTTP clients don't allow sending request body when using GET and DELETE.
• The endpoints should follow the pattern <domain>/<resource>/<action> (e.g. business/group/member/create)
• One endpoint should have only one request/response schema (it is the same as before, I mention it again because it's a very important principle)
• Represent datetime values in int64 number (millis since unix epoch) instead of string because millis since unix epoch is: 1. easy and convenient to parse by any programming language; 2. no ambiguity compared to string.

I mark this issue as a high priority because there are many new endpoints that can only be published after these changes.

from turms.