{"name":"apibuilder generator","organization":{"key":"apicollective"},"application":{"key":"apibuilder-generator"},"namespace":"io.apibuilder.generator.v0","version":"0.12.1","info":{"license":{"name":"MIT","url":"http://opensource.org/licenses/MIT"},"contact":{"name":"Michael Bryzek","url":"http://twitter.com/mbryzek","email":"mbryzek@alum.mit.edu"}},"headers":[],"imports":[{"uri":"http://www.apibuilder.io/apicollective/apibuilder-common/latest/service.json","namespace":"io.apibuilder.common.v0","organization":{"key":"apicollective"},"application":{"key":"apibuilder-common"},"version":"0.16.74","enums":["membership_role"],"interfaces":[],"unions":[],"models":["audit","healthcheck","reference","reference_guid"],"annotations":[]},{"uri":"http://www.apibuilder.io/apicollective/apibuilder-spec/latest/service.json","namespace":"io.apibuilder.spec.v0","organization":{"key":"apicollective"},"application":{"key":"apibuilder-spec"},"version":"0.16.74","enums":["method","parameter_location","response_code_option"],"interfaces":[],"unions":["response_code"],"models":["annotation","apidoc","application","attribute","body","contact","deprecation","enum","enum_value","field","header","import","info","interface","license","model","operation","organization","parameter","resource","response","service","union","union_type"],"annotations":[]}],"enums":[],"interfaces":[],"unions":[],"models":[{"name":"attribute","plural":"attributes","fields":[{"name":"name","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"value","type":"string","required":true,"attributes":[],"annotations":[]}],"attributes":[],"interfaces":[],"description":"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.."},{"name":"error","plural":"errors","fields":[{"name":"code","type":"string","required":true,"attributes":[],"annotations":[],"description":"Machine readable code for this specific error message"},{"name":"message","type":"string","required":true,"attributes":[],"annotations":[],"description":"Description of the error"}],"attributes":[],"interfaces":[]},{"name":"file","plural":"files","fields":[{"name":"name","type":"string","required":true,"attributes":[],"annotations":[],"description":"The recommended name for the file.","example":"ApiCollectiveApiBuilderApiClient.scala"},{"name":"dir","type":"string","required":false,"attributes":[],"annotations":[],"description":"The recommended directory path for the file where appropriate.","example":"io/apicollective/apibuilder"},{"name":"contents","type":"string","required":true,"attributes":[],"annotations":[],"description":"The actual source code."}],"attributes":[],"interfaces":[],"description":"Represents a source file"},{"name":"generator","plural":"generators","fields":[{"name":"key","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"name","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"language","type":"string","required":false,"attributes":[],"annotations":[],"description":"A comma separate list of the programming language(s) that this generator produces","example":"scala"},{"name":"description","type":"string","required":false,"attributes":[],"annotations":[]},{"name":"attributes","type":"[string]","required":true,"attributes":[],"annotations":[],"description":"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","default":"[]"}],"attributes":[],"interfaces":[],"description":"The generator metadata."},{"name":"healthcheck","plural":"healthchecks","fields":[{"name":"status","type":"string","required":true,"attributes":[],"annotations":[],"example":"healthy"}],"attributes":[],"interfaces":[]},{"name":"invocation","plural":"invocations","fields":[{"name":"source","type":"string","required":true,"attributes":[],"annotations":[],"description":"The actual source code.","deprecation":{"description":"Use files instead"}},{"name":"files","type":"[file]","required":true,"attributes":[],"annotations":[],"description":"A collection of source files"}],"attributes":[],"interfaces":[],"description":"The result of invoking a generator."},{"name":"invocation_form","plural":"invocation_forms","fields":[{"name":"service","type":"io.apibuilder.spec.v0.models.service","required":true,"attributes":[],"annotations":[]},{"name":"attributes","type":"[attribute]","required":true,"attributes":[],"annotations":[],"default":"[]"},{"name":"user_agent","type":"string","required":false,"attributes":[],"annotations":[]}],"attributes":[],"interfaces":[],"description":"The invocation form is the payload send to the code generators when requesting generation of client code."}],"resources":[{"type":"generator","plural":"generators","operations":[{"method":"GET","path":"/generators","parameters":[{"name":"key","type":"string","location":"Query","required":false,"description":"Filter generators with this key"},{"name":"limit","type":"integer","location":"Query","required":true,"description":"The number of records to return","default":"100","minimum":0},{"name":"offset","type":"integer","location":"Query","required":true,"description":"Used to paginate. First page of results is 0.","default":"0","minimum":0}],"responses":[{"code":{"integer":{"value":200}},"type":"[generator]","attributes":[]}],"attributes":[],"description":"Get all available generators"},{"method":"GET","path":"/generators/:key","parameters":[{"name":"key","type":"string","location":"Path","required":true}],"responses":[{"code":{"integer":{"value":200}},"type":"generator","attributes":[]},{"code":{"integer":{"value":404}},"type":"unit","attributes":[]}],"attributes":[],"description":"Get generator with this key"}],"attributes":[],"path":"/generators"},{"type":"healthcheck","plural":"healthchecks","operations":[{"method":"GET","path":"/_internal_/healthcheck","parameters":[],"responses":[{"code":{"integer":{"value":200}},"type":"healthcheck","attributes":[]}],"attributes":[]}],"attributes":[],"path":"/_internal_/healthcheck"},{"type":"invocation","plural":"invocations","operations":[{"method":"POST","path":"/invocations/:key","parameters":[{"name":"key","type":"string","location":"Path","required":true}],"responses":[{"code":{"integer":{"value":200}},"type":"invocation","attributes":[]},{"code":{"integer":{"value":409}},"type":"[error]","attributes":[]}],"attributes":[],"description":"Invoke a generator","body":{"type":"invocation_form","attributes":[]}}],"attributes":[],"path":"/invocations"}],"attributes":[],"annotations":[],"apidoc":{"version":"0.12.1"},"base_url":"http://www.apibuilder.io","description":"Documentation for an apibuilder code generator API"}