path: root/uml/api.lua

require 'Coat'
require 'Coat.Types'

class 'Method'

has._method         = { is = 'ro', isa = 'string', required = true }
has.path            = { is = 'ro', isa = 'string', required = true }
has.expected_status = { is = 'ro', isa = 'table<number>' }
has.required_params = { is = 'ro', isa = 'table<string>' }
has.optional_params = { is = 'ro', isa = 'table<string>' }
has.base_url        = { is = 'ro', isa = 'string' }
has.description     = { is = 'ro', isa = 'string' }
has.authentication  = { is = 'ro', isa = 'boolean' }
has.formats         = { is = 'ro', isa = 'table<string>' }


class 'API'

has.name            = { is = 'ro', isa = 'string', required = true }
has.methods         = { is = 'ro', isa = 'table<string,Method>', required = true }
has.base_url        = { is = 'ro', isa = 'string' }
has.description     = { is = 'ro', isa = 'string' }
has.authentication  = { is = 'ro', isa = 'boolean' }
has.formats         = { is = 'ro', isa = 'table<string>' }
has.version         = { is = 'ro', isa = 'string' }
has.authority       = { is = 'ro', isa = 'string' }
has.meta            = { is = 'ro', isa = 'table<string,string>' }