setting-object.json 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. {
  2. "type": "object",
  3. "description": "Setting object",
  4. "required": ["id", "name", "description", "value", "meta"],
  5. "additionalProperties": false,
  6. "properties": {
  7. "id": {
  8. "type": "string",
  9. "description": "Setting ID",
  10. "minLength": 1,
  11. "example": "default-site"
  12. },
  13. "name": {
  14. "type": "string",
  15. "description": "Setting Display Name",
  16. "minLength": 1,
  17. "example": "Default Site"
  18. },
  19. "description": {
  20. "type": "string",
  21. "description": "Meaningful description",
  22. "minLength": 1,
  23. "example": "What to show when Nginx is hit with an unknown Host"
  24. },
  25. "value": {
  26. "description": "Value in almost any form",
  27. "example": "congratulations",
  28. "anyOf": [
  29. {
  30. "type": "string",
  31. "minLength": 1
  32. },
  33. {
  34. "type": "integer"
  35. },
  36. {
  37. "type": "object"
  38. },
  39. {
  40. "type": "number"
  41. },
  42. {
  43. "type": "array"
  44. }
  45. ]
  46. },
  47. "meta": {
  48. "description": "Extra metadata",
  49. "example": {
  50. "redirect": "http://example.com",
  51. "html": "<h1>404</h1>"
  52. },
  53. "type": "object"
  54. }
  55. }
  56. }