User API

[amirrustam]

Data Model

---

• id | string
• uuid | string
• first_name | string
• last_name | string
• username | string (unique, url-friendly and santized)
• password | string (bcrypt encrypted text)
• email | string (unique, email-format)
• phone_number | string (unique, phone-format)
• balance | positive-number
• avatar | string (url-fromat)
• default_privacy_level | string enumerated: "public" | "private" | "contacts" (default)
• created_at | timestamp (ISO 8601)
• modified_at | timestamp (ISO 8601)

HTTP API

---

• GET /users

  • Validate params
  • Tested
  • Query Params:
    • Validate params
    • order
      • default: scoped user contacts first, then all other users
      • "top_first": contacts with most transactions first

• GET /users/:user_id (permission: account owner)

  • Validate params
  • Tested

• GET /users/profile/:username (public info, authentication not required)

  • Tested

• GET /users/search

  • Validate params
  • Tested
  • Query Params:
    • Validate params
    • query: string representing like name or like username, or exactly phone, or exactly email

• POST /users

  • Validate payload
  • Tested

• PATCH /users/:user_id

  • Validate params
  • Tested