Enums Models Clients

apibuilder api json 0.15.11

History | Watch

Specification of the API Builder Input form (api.json). See https://app.apibuilder.io/doc/apiJson

Resources

No resources

Headers

No headers

Imports

No imports

Enums

parameter_location

Name Value Description
path path
query query
form form
header header

Interfaces

No interfaces

Models

annotation

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
description string No -

deprecation deprecation No -

api_json

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

apidoc apidoc No -

info info No -

namespace string No -

base_url string No -

description string No -

imports [import] Yes []

headers [header] Yes []

enums map[enum] Yes {}

interfaces map[interface] Yes {}

unions map[union] Yes {}

models map[model] Yes {}

resources map[resource] Yes {}

annotations map[annotation] Yes {}

attributes [attribute] Yes []

apidoc

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
version string Yes -

Example: 0.14.97

attribute

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

value object Yes -

body

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
type string Yes -

description string No -

attributes [attribute] No -

deprecation deprecation No -

contact

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string No -

Example: Michael Bryzek
url string No -

Example: https://www.apibuilder.io
email string No -

Example: michael@test.apibuilder.io

deprecation

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
description string No -

enum

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
plural string No -

description string No -

values [enum_value] Yes -

attributes [attribute] No -

deprecation deprecation No -

enum_value

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

value string No -

description string No -

attributes [attribute] No -

deprecation deprecation No -

field

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

type string Yes -

description string No -

required boolean Yes true

default string No -

example string No -

minimum long No -

maximum long No -

attributes [attribute] No -

annotations [string] No -

deprecation deprecation No -

header

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

type string Yes -

required boolean Yes true

description string No -

attributes [attribute] No -

deprecation deprecation No -

import

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
uri string Yes -

info

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
contact contact No -

license license No -

interface

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
plural string No -

description string No -

fields [field] No -

attributes [attribute] No -

deprecation deprecation No -

license

Example Json: Minimal | Full

Interfaces: None

Describes the software license contact for this service

Field Type Required? Default Description
name string Yes -

Example: MIT
url string No -

Example: http://opensource.org/licenses/MIT

model

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
description string No -

plural string No -

fields [field] Yes -

attributes [attribute] No -

interfaces [string] No -

deprecation deprecation No -

operation

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
method string Yes -

path string Yes -

description string No -

body body No -

parameters [parameter] No -

responses [response] No -

attributes [attribute] No -

deprecation deprecation No -

parameter

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

type string Yes -

location parameter_location Yes query

description string No -

required boolean Yes true

default string No -

minimum long No -

maximum long No -

example string No -

attributes [attribute] No -

deprecation deprecation No -

resource

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
path string No -

description string No -

operations [operation] Yes -

attributes [attribute] No -

deprecation deprecation No -

response

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
type string Yes -

headers [header] No -

description string No -

deprecation deprecation No -

attributes [attribute] No -

union

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
plural string No -

discriminator string No -

description string No -

types [union_type] Yes -

Minimum: 1
attributes [attribute] No -

interfaces [string] No -

deprecation deprecation No -

union_type

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
type string Yes -

description string No -

default boolean Yes false

discriminator_value string No -

attributes [attribute] No -

deprecation deprecation No -

Unions

No unions

Annotations

No annotations