Permalink
Browse files

Roll out article update to reflect subsections changes

  • Loading branch information...
1 parent 9ccbc98 commit 8d024ab4d024201bbcdb846fd49520f235cab9c4 @zdne zdne committed Mar 29, 2013
Showing with 13 additions and 2 deletions.
  1. +13 −2 _posts/2013-03-12-New-API-Blueprint-Format-Roll-Out.md
@@ -2,15 +2,26 @@
title: Blueprint Format Roll Out
excerpt: New API Blueprint Format specification has been closed as we are getting ready for its roll out.
layout: post
-date: 2013-03-12 09:00:00 +1000
+date: 2013-03-29 09:00:00 +1000
author: zdenek
published: NO
---
As you may know the [New API Blueprint Format](http://blog.apiary.io/2013/02/20/New-API-Blueprint-Format-Basics/) will be rolling out soon and today I would like to discuss how it will be done.
## 1A Format Specification
-First I would like to thank our awesome users who contributed to the New Format in reaction to my previous [post](http://blog.apiary.io/2013/02/20/New-API-Blueprint-Format-Basics/). In the process we have made quite a few changes to the Format and you can find its [final specification](https://github.com/apiaryio/blueprint-parser/blob/zdne/format1A/doc/APIBlueprintSpecification.md) in our (open sourced) [parser repository](https://github.com/apiaryio/blueprint-parser/tree/zdne/format1A). The specification is also accompanied by a few [examples](https://github.com/apiaryio/blueprint-parser/tree/zdne/format1A/examples) if you want to get a quick peek at what it will look like.
+First I would like to thank our awesome users who contributed to the New Format in reaction to my previous [post](http://blog.apiary.io/2013/02/20/New-API-Blueprint-Format-Basics/).
+
+In the process we have made quite a few changes to the Format. For example, to improve both readability and the process of writing we have decided to leave the "header marks (#) forest" in favor of utilizing "much cleaner" Markdown lists, like so:
+
+ # GET /message_of_the_day
+ Retrieves message of the day.
+
+ + Response 200 (application/json)
+
+ { "message" : "Hello World" }
+
+You can find the New Format's [final specification](https://github.com/apiaryio/blueprint-parser/blob/zdne/format1A/doc/APIBlueprintSpecification.md) in our (open sourced) [parser repository](https://github.com/apiaryio/blueprint-parser/tree/zdne/format1A). The specification is also accompanied by a few [examples](https://github.com/apiaryio/blueprint-parser/tree/zdne/format1A/examples) if you want to get a quick peek at what it will look like.
Note that this first version is only a mere milestone on the [Format evolution](http://blog.apiary.io/2013/01/27/New-API-Blueprint-Format/). However we still keep the main thing the main thing: The **API Blueprint must be the best way possible to both design and document your API**.

0 comments on commit 8d024ab

Please sign in to comment.