Format 1A9 Release: Named Endpoints

This release enhances the API Blueprint with a new feature called Named Endpoints.

Examples

You can see an example blueprint using these new feature here.

Format 1A8 Release: MSON

This release brings following new features to API Blueprint:

• Ability to describe Message-body Attributes and Data Structures
• Ability to define a Link Relation Identifier for an Action
• Allowing the user to add an URI template after the HTTP method when defining an Action.
• Support MSON-like syntax for URI Parameters section.

There are 3 types of Attribute sections in API Blueprint and each of them mean different things. They are Resource Attributes, Action Attributes and Payload Attributes

Examples

Find examples of the new features in following blueprints: Attributes, Advanced Attributes, Data Structures and Advanced Action.

Parser

As of this release the API Blueprint parser – Snow Crash – is now superseded by its "harness" – Drafter. You can use the new CLI tool Drafter to parse, lint API Blueprint format 1A8 and retrieve a JSON or YAML representations of API Blueprint AST

Format 1A7 Release: Lazy Referencing

This release brings the possibility to reference a Resource Model before its definition

For example:

# API

# Collection of Items [/items]
+ Model (application/json)

        [ { item 1 }, { item 2 } ]

## Create New Item [POST]
+ Request

    [Item][]

+ Response 200 

    [Collection of Items][]

# Item [/items/{id}]
+ Model (application/json)

        { item }

See #71

Format 1A6 Release: URI Templates

This release incorporates supported URI Templates syntax into the API Blueprint Specification, addressing the following issues:

• Incorporate basic URI Template syntax #78
• Clarify scope of URI Parameters section #79

Format 1A5 Release: Request & Response pairing

This release adds implicit action request and response pairing into transaction example groups – a group of request and resource messages that can be treated as an example of one HTTP transaction.

Refer to Action Section specification for description and example.

Maintenance Release: Format 1A4

This release brings completely restructured specification. The API Blueprint Specification is now divided into two main parts:

1. Description of the langue and general principles
2. Reference discussion of the individual building blocks (blueprint sections)

Overall the specification is now simplified. Many superfluous references (e.g. to MultiMarkdown) were removed. More emphasis was added on examples and the document structure.

Format 1A3 Release

This release deprecates resource and action section headers subsection. These sections will be removed completely in a a future version of API Blueprint as they will be superseded by the API Blueprint Traits #47.

Format 1A2 Release

This lifts off most of the restrictions on API Blueprint Identifiers.

Format 1A Release

Format 1A

This is the formal release of Format 1A.

Future Releases

Format 1An

Additional release should include only clarifications to specification and / or examples. Versioned as 1A1, 1A2 ...

Format 1B

First planned feature release after 1B New features will be released under 1B. Refer to the Format 1B Milestone.

Format X

Future plans are listed under the Format X Milestone.

Format 1A Release Candidate 2

The Format 1A release candidate 2.