Glossary of Terms
A brief list of terms as used in the API Blueprint context.
An HTTP transaction (a request-response transaction).
Actions are specified by an HTTP request method within a resource.
An HTTP Application programming interface. Might refer to an API description. See API Blueprint.
The API Blueprint language. A format used to describe API in an API blueprint file.
Atomic data. Most often representing one resource representation in the form of message-body or its validation schema.
Based on the context, attribute (property) of a message-body data structure, or attribute of a resource, or an input attribute of a transition – Action.
An API description. A blueprint file (or a set of files) that describes an API using the API Blueprint language.
A particular data organization, or a description of it. In API Blueprint, data structures and their Attributes are described using the Markdown Syntax for Object Notation – MSON.
Entity being transferred in a payload.
An HTTP transaction message.
An asset representing HTTP transaction message body.
An asset representing HTTP transaction message header.
An URI template variable.
An HTTP transaction message including its discussion and any additional assets such as entity-body validation schema.
A payload may have an identifier – a string for a request payload or an HTTP status code for a response payload.
An entity field (attribute).
A payload containing one specific HTTP Request.
A payload containing one specific HTTP Response.
An API resource specified by its URI. It can also refer to a set of resources matching one URI template.
One manifestation of a resource in the form of a payload. A resource model is an example representation of its resource. Can be referenced later in the place of a payload.
A set of API resources. Its URI matches one specific URI template.
A quality or characteristic of an API Blueprint SECTION.
A validation schema in a form of an asset used to validate (or describe) a message-body.
A compact sequence of characters for describing a range of Uniform Resource Identifiers through variable expansion, see RFC 6570.