// -----------------------------------------------------------------------------
// Enum Typedefs
// -----------------------------------------------------------------------------

// -----------------------------------------------------------------------------
// Model Typedefs
// -----------------------------------------------------------------------------

/**
 * An attribute represents a key/value pair that is optionally used to provide additional instructions / data to the code generator. An example could be an attribute to specify the root import path for a go client..
 * @typedef {Object} Attribute
 * @property {string} name
 * @property {string} value
 */

/**
 * @typedef {Object} Error
 * @property {string} code Machine readable code for this specific error message
 * @property {string} message Description of the error
 */

/**
 * Represents a source file
 * @typedef {Object} File
 * @property {string} name The recommended name for the file.
 * @property {string} [dir] The recommended directory path for the file where appropriate.
 * @property {string} contents The actual source code.
 */

/**
 * The generator metadata.
 * @typedef {Object} Generator
 * @property {string} key
 * @property {string} name
 * @property {string} [language] A comma separate list of the programming language(s) that this generator produces
 * @property {string} [description]
 * @property {string[]} attributes The list of attributes that this code generator can use. You can find the full list of available attributes and their descriptions at http://apibuilder.io/doc/attributes
 */

/**
 * @typedef {Object} Healthcheck
 * @property {string} status
 */

/**
 * The result of invoking a generator.
 * @typedef {Object} Invocation
 * @property {string} source The actual source code.
 * @property {File[]} files A collection of source files
 */

/**
 * The invocation form is the payload send to the code generators when requesting generation of client code.
 * @typedef {Object} InvocationForm
 * @property {Service} service
 * @property {Attribute[]} attributes
 * @property {string} [user_agent]
 */

// -----------------------------------------------------------------------------
// Union Typedefs
// -----------------------------------------------------------------------------