{ "components": { "schemas": { "annotation": { "properties": { "description": { "type": "string" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "type": "object" }, "api_json": { "properties": { "name": { "type": "string" }, "info": { "$ref": "#/components/schemas/info" }, "namespace": { "type": "string" }, "base_url": { "type": "string" }, "description": { "type": "string" }, "imports": { "items": { "$ref": "#/components/schemas/import" }, "type": "array", "default": "[]" }, "headers": { "items": { "$ref": "#/components/schemas/header" }, "type": "array", "default": "[]" }, "enums": { "default": "{}" }, "interfaces": { "default": "{}" }, "unions": { "default": "{}" }, "models": { "default": "{}" }, "resources": { "default": "{}" }, "annotations": { "default": "{}" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array", "default": "[]" } }, "required": [ "name", "imports", "headers", "enums", "interfaces", "unions", "models", "resources", "annotations", "attributes" ], "type": "object" }, "attribute": { "properties": { "name": { "type": "string" }, "value": { "type": "object" } }, "required": [ "name", "value" ], "type": "object" }, "body": { "properties": { "type": { "type": "string" }, "description": { "type": "string" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "type" ], "type": "object" }, "contact": { "properties": { "name": { "type": "string", "example": "Michael Bryzek" }, "url": { "type": "string", "example": "https://www.apibuilder.io" }, "email": { "type": "string", "example": "michael@test.apibuilder.io" } }, "type": "object" }, "deprecation": { "properties": { "description": { "type": "string" } }, "type": "object" }, "enum": { "properties": { "plural": { "type": "string" }, "description": { "type": "string" }, "values": { "items": { "$ref": "#/components/schemas/enum_value" }, "type": "array" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "values" ], "type": "object" }, "enum_value": { "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "name" ], "type": "object" }, "field": { "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean", "default": "true" }, "default": { "type": "string" }, "example": { "type": "string" }, "minimum": { "type": "integer", "format": "int64" }, "maximum": { "type": "integer", "format": "int64" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "annotations": { "items": { "type": "string" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "name", "type", "required" ], "type": "object" }, "header": { "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean", "default": "true" }, "description": { "type": "string" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "name", "type", "required" ], "type": "object" }, "import": { "properties": { "uri": { "type": "string" } }, "required": [ "uri" ], "type": "object" }, "info": { "properties": { "contact": { "$ref": "#/components/schemas/contact" }, "license": { "$ref": "#/components/schemas/license" } }, "type": "object" }, "interface": { "properties": { "plural": { "type": "string" }, "description": { "type": "string" }, "fields": { "items": { "$ref": "#/components/schemas/field" }, "type": "array" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "type": "object" }, "license": { "description": "Describes the software license contact for this service", "properties": { "name": { "type": "string", "example": "MIT" }, "url": { "type": "string", "example": "http://opensource.org/licenses/MIT" } }, "required": [ "name" ], "type": "object" }, "model": { "properties": { "description": { "type": "string" }, "plural": { "type": "string" }, "fields": { "items": { "$ref": "#/components/schemas/field" }, "type": "array" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "fields" ], "type": "object" }, "operation": { "properties": { "method": { "type": "string" }, "path": { "type": "string" }, "description": { "type": "string" }, "body": { "$ref": "#/components/schemas/body" }, "parameters": { "items": { "$ref": "#/components/schemas/parameter" }, "type": "array" }, "responses": { "items": { "$ref": "#/components/schemas/response" }, "type": "array" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "method", "path" ], "type": "object" }, "parameter": { "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "location": { "$ref": "#/components/schemas/parameter_location", "default": "query" }, "description": { "type": "string" }, "required": { "type": "boolean", "default": "true" }, "default": { "type": "string" }, "minimum": { "type": "integer", "format": "int64" }, "maximum": { "type": "integer", "format": "int64" }, "example": { "type": "string" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "name", "type", "location", "required" ], "type": "object" }, "resource": { "properties": { "path": { "type": "string" }, "description": { "type": "string" }, "operations": { "items": { "$ref": "#/components/schemas/operation" }, "type": "array" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "operations" ], "type": "object" }, "response": { "properties": { "type": { "type": "string" }, "headers": { "items": { "$ref": "#/components/schemas/header" }, "type": "array" }, "description": { "type": "string" }, "deprecation": { "$ref": "#/components/schemas/deprecation" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" } }, "required": [ "type" ], "type": "object" }, "union": { "properties": { "plural": { "type": "string" }, "discriminator": { "type": "string" }, "description": { "type": "string" }, "types": { "items": { "$ref": "#/components/schemas/union_type" }, "type": "array", "minItems": 1 }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "types" ], "type": "object" }, "union_type": { "properties": { "type": { "type": "string" }, "description": { "type": "string" }, "default": { "type": "boolean", "default": "false" }, "discriminator_value": { "type": "string" }, "attributes": { "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "deprecation": { "$ref": "#/components/schemas/deprecation" } }, "required": [ "type", "default" ], "type": "object" }, "parameter_location": { "description": "Possible values: path,query,form,header.", "enum": [ "path", "query", "form", "header" ], "type": "string" } } }, "info": { "contact": { "name": "Michael Bryzek", "url": "http://twitter.com/mbryzek", "email": "mbryzek@alum.mit.edu" }, "description": "Specification of the API Builder Input form (api.json). See https://app.apibuilder.io/doc/apiJson", "license": { "name": "MIT", "url": "http://opensource.org/licenses/MIT" }, "termsOfService": "", "title": "apibuilder api json", "version": "0.15.71" }, "openapi": "3.0.2", "paths": {}, "servers": [ {} ] }