Example: 1.0.3

Unique key identifying this application

Example: Michael Bryzek

Example: https://www.apibuilder.io

Example: michael@test.apibuilder.io

The actual string representation of this value. If not specified, defaults to 'name'

Full URI to the service.json file of the service we are importing

Example: https://www.apibuilder.io/apicollective/apibuilder-spec/0.7.38/service.json

the fully qualified namespace that we have imported

Example: io.apibuilder

The version of the service that we are importing

Example: 1.0.0

Enums made available by this import

Interfaces made available by this import

Unions made available by this import

Models made available by this import

Annotations made available by this import

Example: MIT

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

The full path to this operation, relative to the service's base url.

Unique key identifying the organization that owns this service

The type of this resource will map to a defined model, enum, or union type

The path to this specific resource. This was added in 2016 to help us differentiate between the resource path and the operation path which can be helpful when, for example, generating method names for operations. This field is optional as some of our input formats (e.g. swagger) do not explicitly differentiate resoure paths.

Documents that this is an apibuilder document, noting the specific version used. Internally the version is then used for backwards compatibility when applicable as new features are added to apibuilder. Note naming refers to the original name of this project, 'apidoc', and is left here to avoid a breaking change for preexisting services.

deprecated:

This field is no longer used in API Builder and may be removed in the future.

Fully qualified namespace for this service

Example: io.apibuilder

Example: 1.0.0

If a type discriminator is provided, serialization of these union types will always contain a field named with the value of the discriminator that will contain the name of the type. This provides a simpler (for many use cases) JSON serialization/deserialization mechanism. When specified, apibuilder itself will verify that none of the types in the union type itself contain a field with the same name as the discriminator

Example: discriminator or type

The names of the types that make up this union type

Minimum: 1

The name of a type (a primitive, model name, or enum name) that makes up this union type

If true, indicates that this type should be used as the default when deserializing union types. This field is only used by union types that require a discriminator and sets the default value for that discriminator during deserialization.

The discriminator value defines the string to use in the discriminator field to identify this type. If not specified, the discriminator value will default to the name of the type itself.