Code source de Planète Casio https://planet-casio.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

users.txt 3.3KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. # User management
  2. User information:
  3. Name Unique, no space, at least one letter
  4. Avatar Stored in a server folder. Size limit?
  5. Password Hashed, of course
  6. Email Mail address, used to send newsletters
  7. Points Participation measure (mainly number of posts)
  8. Innovation points A different kind of participation measure
  9. Biography Description of the user
  10. Signature Short signature added at the end of every post
  11. Birthday Birthday date
  12. Newsletter Subscription to newsletter
  13. Settings...
  14. Relations:
  15. Notifications 1 to many
  16. Groups 1 to many
  17. Sent PMs 1 to many
  18. Received PMs 1 to many
  19. Trophies/Titles 1 to many
  20. All posts many to many (tutorials can have several authors)
  21. Privileges many to many
  22. Rest API for users:
  23. Requests where "Search" is set to "Yes" accept search patterns. The syntax
  24. needs to be chosen, it could be something like "/users[name~=/*storm*/i]".
  25. Method URL Search Description
  26. -----------------------------------------------------------------------------
  27. GET /users Yes Query users
  28. POST /users - Create new user
  29. -----------------------------------------------------------------------------
  30. GET /users/<id> - Get user information/settings
  31. PATCH /users/<id> - Update user information/settings
  32. DELETE /users/<id> - Delete user account
  33. -----------------------------------------------------------------------------
  34. GET /users/<id>/trophies - Get unlocked trophies
  35. -----------------------------------------------------------------------------
  36. GET /users/<id>/messages Yes Query private messages
  37. POST /users/<id>/messages - Send PM (<id> is sender)
  38. DELETE /users/<id>/messages Required Delete PMs matching pattern
  39. -----------------------------------------------------------------------------
  40. GET /users/<id>/groups - Get user groups
  41. PATCH /users/<id>/groups - Add or remove group memberships (*)
  42. -----------------------------------------------------------------------------
  43. GET /users/<id>/privs - Get user privileges
  44. PATCH /users/<id>/privs - Grant/revoke special privileges (*)
  45. -----------------------------------------------------------------------------
  46. Updating the participation scores is not a request, it's tied to posting
  47. contents, so it has nothing to do in the API.
  48. (*) Not sure if this is relevant, since these are administrator duties.
  49. Rest API for groups:
  50. Method URL Search Description
  51. -----------------------------------------------------------------------------
  52. GET /groups - Get list of groups
  53. POST /groups - Create group
  54. -----------------------------------------------------------------------------
  55. GET /groups/<id> - Get list of users in groups
  56. -----------------------------------------------------------------------------
  57. There are no methods to change the privileges associated to each groups
  58. because this task is clearly for administrators, not API users.