user-object.json 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. {
  2. "type": "object",
  3. "description": "User object",
  4. "required": ["id", "created_on", "modified_on", "is_disabled", "email", "name", "nickname", "avatar", "roles"],
  5. "additionalProperties": false,
  6. "properties": {
  7. "id": {
  8. "type": "integer",
  9. "description": "User ID",
  10. "minimum": 1,
  11. "example": 1
  12. },
  13. "created_on": {
  14. "type": "string",
  15. "description": "Created Date",
  16. "example": "2020-01-30T09:36:08.000Z"
  17. },
  18. "modified_on": {
  19. "type": "string",
  20. "description": "Modified Date",
  21. "example": "2020-01-30T09:41:04.000Z"
  22. },
  23. "is_disabled": {
  24. "type": "boolean",
  25. "description": "Is user Disabled",
  26. "example": true
  27. },
  28. "email": {
  29. "type": "string",
  30. "description": "Email",
  31. "minLength": 3,
  32. "example": "[email protected]"
  33. },
  34. "name": {
  35. "type": "string",
  36. "description": "Name",
  37. "minLength": 1,
  38. "example": "Jamie Curnow"
  39. },
  40. "nickname": {
  41. "type": "string",
  42. "description": "Nickname",
  43. "example": "James"
  44. },
  45. "avatar": {
  46. "type": "string",
  47. "description": "Gravatar URL based on email, without scheme",
  48. "example": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm"
  49. },
  50. "roles": {
  51. "description": "Roles applied",
  52. "example": ["admin"],
  53. "type": "array",
  54. "items": {
  55. "type": "string"
  56. }
  57. }
  58. }
  59. }