Latest OAS3.0 with latest from master branch of the original author

README.md

@@ -38,7 +38,7 @@ resource "Orders" do
     example "Listing orders" do
       do_request
 
-      status.should == 200
+      expect(status).to eq 200
     end
   end
 end
@@ -258,6 +258,7 @@ RspecApiDocumentation.configure do |config|
   config.html_embedded_css_file = nil
 
   # Removes the DSL method `status`, this is required if you have a parameter named status
+  # In this case you can assert response status with `expect(response_status).to eq 200`
   config.disable_dsl_status!
 
   # Removes the DSL method `method`, this is required if you have a parameter named method
@@ -360,7 +361,8 @@ This [format](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/
 
 * Several new options on `parameter` helper.
 
-    - `with_example: true`. This option will adjust your description of the parameter with the passed value.
+    - `with_example: true`. This option will adjust your example of the parameter with the passed value.
+    - `example: <value>`. Will provide a example value for the parameter.
     - `default: <value>`. Will provide a default value for the parameter.
     - `minimum: <integer>`. Will setup upper limit for your parameter. 
     - `maximum: <integer>`. Will setup lower limit for your parameter.
@@ -515,18 +517,18 @@ resource "Account" do
     # default :document is :all
     example "Get a list of all accounts" do
       do_request
-      status.should == 200
+      expect(status).to eq 200
     end
 
     # Don't actually document this example, purely for testing purposes
     example "Get a list on page 2", :document => false do
       do_request(:page => 2)
-      status.should == 404
+      expect(status).to eq 404
     end
 
     # With example_request, you can't change the :document
     example_request "Get a list on page 3", :page => 3 do
-      status.should == 404
+      expect(status).to eq 404
     end
   end
 
@@ -535,12 +537,12 @@ resource "Account" do
 
     example "Creating an account", :document => :private do
       do_request(:email => "[email protected]")
-      status.should == 201
+      expect(status).to eq 201
     end
 
     example "Creating an account - errors", :document => [:private, :developers] do
       do_request
-      status.should == 422
+      expect(status).to eq 422
     end
   end
 end
@@ -609,7 +611,7 @@ resource "Orders" do
     let(:id) { order.id }
 
     example "Get an order" do
-      path.should == "/orders/1" # `:id` is replaced with the value of `id`
+      expect(path).to eq "/orders/1" # `:id` is replaced with the value of `id`
     end
   end
 
@@ -699,7 +701,7 @@ resource "Orders" do
 
   get "/orders" do
     example_request "Headers" do
-      headers.should == { "Accept" => "application/json", "X-Custom" => "dynamic" }
+      expect(headers).to eq { "Accept" => "application/json", "X-Custom" => "dynamic" }
     end
   end
 end
@@ -738,7 +740,7 @@ resource "Orders" do
     # OR let(:order_item_item_id) { 1 }
 
     example "Creating an order" do
-      params.should eq({
+      expect(params).to eq({
         :order => {
           :name => "My Order",
           :item => {
@@ -827,7 +829,7 @@ resource "Order" do
 
       do_request
 
-      status.should == 200
+      expect(status).to eq 200
     end
   end
 end
@@ -847,7 +849,7 @@ resource "Order" do
     example "Listing orders" do
       do_request
 
-      status.should == 200
+      expect(status).to eq 200
     end
   end
 end
@@ -868,7 +870,7 @@ resource "Order" do
 
       do_request
 
-      status.should == 200
+      expect(status).to eq 200
     end
   end
 end
@@ -890,7 +892,7 @@ resource "Orders" do
 
   get "/orders" do
     example_request "Headers" do
-      headers.should == { "Accept" => "application/json" }
+      expect(headers).to eq { "Accept" => "application/json" }
     end
   end
 end
@@ -910,7 +912,7 @@ resource "Order" do
     example "Listing orders" do
       do_request
 
-      response_body.should == [{ :name => "Order 1" }].to_json
+      expect(response_body).to eq [{ :name => "Order 1" }].to_json
     end
   end
 end
@@ -926,7 +928,7 @@ resource "Order" do
     example "Listing orders" do
       do_request
 
-      response_headers["Content-Type"].should == "application/json"
+      expect(response_headers["Content-Type"]).to eq "application/json"
     end
   end
 end
@@ -942,8 +944,8 @@ resource "Order" do
     example "Listing orders" do
       do_request
 
-      status.should == 200
-      response_status.should == 200
+      expect(status).to eq 200
+      expect(response_status).to eq 200
     end
   end
 end
@@ -961,7 +963,7 @@ resource "Orders" do
 
   get "/orders" do
     example "List orders" do
-      query_string.should == "name=My+Orders"
+      expect(query_string).to eq "name=My+Orders"
     end
   end
 end

features/api_blueprint_documentation.feature

@@ -115,6 +115,11 @@ Feature: Generate API Blueprint documentation from test examples
           attribute :name, 'The order name', required: true, :example => 'a name'
           attribute :amount, required: false
           attribute :description, 'The order description', type: 'string', required: false, example: "a description"
+          attribute :category, 'The order category', type: 'string', required: false, default: 'normal', enum: %w[normal priority]
+          attribute :metadata, 'The order metadata', type: 'json', required: false, annotation: <<-MARKDOWN
+    + instructions (optional, string)
+    + notes (optional, string)
+          MARKDOWN
 
           get 'Returns a single order' do
             explanation "This is used to return orders."
@@ -250,6 +255,7 @@ Feature: Generate API Blueprint documentation from test examples
     """
     FORMAT: 1A
     # Example API
+    Example API Description
 
     # Group Instructions
 
@@ -360,6 +366,14 @@ Feature: Generate API Blueprint documentation from test examples
       + name: a name (required) - The order name
       + amount (optional)
       + description: a description (optional, string) - The order description
+      + category (optional, string) - The order category
+          + Default: `normal`
+          + Members
+              + `normal`
+              + `priority`
+      + metadata (optional, json) - The order metadata
+          + instructions (optional, string)
+          + notes (optional, string)
 
     ### Deletes a specific order [DELETE]