health-object.json 866 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. {
  2. "type": "object",
  3. "description": "Health object",
  4. "additionalProperties": false,
  5. "required": ["status", "version"],
  6. "properties": {
  7. "status": {
  8. "type": "string",
  9. "description": "Healthy",
  10. "example": "OK"
  11. },
  12. "setup": {
  13. "type": "boolean",
  14. "description": "Whether the initial setup has been completed",
  15. "example": true
  16. },
  17. "version": {
  18. "type": "object",
  19. "description": "The version object",
  20. "example": {
  21. "major": 2,
  22. "minor": 0,
  23. "revision": 0
  24. },
  25. "additionalProperties": false,
  26. "required": ["major", "minor", "revision"],
  27. "properties": {
  28. "major": {
  29. "type": "integer",
  30. "minimum": 0,
  31. "example": 2
  32. },
  33. "minor": {
  34. "type": "integer",
  35. "minimum": 0,
  36. "example": 10
  37. },
  38. "revision": {
  39. "type": "integer",
  40. "minimum": 0,
  41. "example": 1
  42. }
  43. }
  44. }
  45. }
  46. }