carbon-io / carbond

MIT License
2 stars 5 forks source link

Enhanced schema descriptions #334

Closed alek-mongodb closed 6 years ago

alek-mongodb commented 6 years ago

Extend existing request/response Body section of aglio docs by specifying:

alek-mongodb commented 6 years ago

Ticks first three boxes: https://github.com/carbon-io/carbond/commit/b5fbbec208e99f1b2f5fbf934c6a2a8f229e55b3

Example:

{
  foo: BOOLEAN (default: true),
  barDate: STRING (date-time),
  baz: INTEGER[1..42]
}
alek-mongodb commented 6 years ago

Ticks the string pattern box: https://github.com/carbon-io/carbond/commit/eb20f166b74fd88066f0595b6ca133d6011053f8 Example:

{
    time: STRING (pattern: '^([01]\d|2[0-3]):?([0-5]\d)$')
}