ToolMatter
Your Apps in Action
Risersoft
Buy
Try
Explore
Documentation
Public
Use this form to visualize apibuilder.io schema.
{{repoTitle.MainEntity}}
name - The human readable name of this service. Used for display, and as the basis for generating a unique key for URL.
.apidoc
_
apidoc.version - Specifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec.
.info
_
.info.contact
_
info.contact.name - Identifying name of the contact person/organization
info.contact.url - URL pointing to the contact information
info.contact.email - Email address of the contact person/organization
.info.license
_
info.license.name - Name of the license - e.g. MIT
info.license.url - URL of the license itself
namespace - Specifies the namespace for this service. Namespace is primarily used when other services import definitions from your service and in the code generators when defining things like package names. If not specified, we will automatically generate a namespace based on [organization namespace].[formatted service name].[major version number]. Note that by default API Builder includes the major version number in the package name which allows service authors and clients to interact with multiple versions of the service where changes have been made in a non backwards compatible way.
base_url - The base URL where this service is hosted. Must start with http.
description - optional description for what this service provides. Supports GFM.
imports JSON Array defining any other services whose schema definitions we would like to import into our service.
#
uri
Actions
{{$index+1}}.
headers JSON Array defining any HTTP Headers that the service understands or expects.
#
name
type
required
description
deprecation.description
Actions
{{$index+1}}.
{{row.name}}
{{row.type}}
{{row.requiredSelected.DisplayText}}
{{row.description}}
{{row.deprecation.description}}
.enums
_
.interfaces
_
.models
_
.unions
_
.resources
_
attributes JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.
#
name
Actions
{{$index+1}}.
annotations JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.
#
Values
Actions
{{$index+1}}.
{{repoTitle.MainEntity}}
{{repoTitle.MainEntity}}
name - The name of the header.
type - The type of this header. Acceptable values are either the name of an enum or string. To specify a collection (meaning multiple values for this header can be provided), the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]".
required - boolean: true|false. By default, all headers are considered required. To make a parameter optional, set "required" to false.
description - Optional description for what this header provides. Supports GFM.
attributes JSON Array defining additional meta data about this header for use by generators.
#
name
Actions
{{$index+1}}.
.deprecation
_headers
deprecation.description - Optional, but recommended to contain notes for what the user is supposed to do now that this property is deprecated. Supports GFM.
{{repoTitle.MainEntity}}
.value
_attributes
Download Json
{{message}}
ToolMatter