Add description to writers and views

prikha · prikha · commit 1f786b812609 · 2017-08-17T16:42:37.000+03:00
diff --git a/lib/rspec_api_documentation/views/markup_index.rb b/lib/rspec_api_documentation/views/markup_index.rb
@@ -3,16 +3,14 @@
 module RspecApiDocumentation
   module Views
     class MarkupIndex < Mustache
+      delegate :api_name, :api_explanation, to: :@configuration, prefix: false
+
       def initialize(index, configuration)
         @index = index
         @configuration = configuration
         self.template_path = configuration.template_path
       end
 
-      def api_name
-        @configuration.api_name
-      end
-
       def sections
         RspecApiDocumentation::Writers::IndexHelper.sections(examples, @configuration)
       end
diff --git a/lib/rspec_api_documentation/writers/json_iodocs_writer.rb b/lib/rspec_api_documentation/writers/json_iodocs_writer.rb
@@ -94,6 +94,7 @@ def as_json(opts = nil)
         {
           @api_key.to_sym => {
             :name => @configuration.api_name,
+            :description => @configuration.api_explanation,
             :protocol => @configuration.io_docs_protocol,
             :publicPath => "",
             :baseURL => @configuration.curl_host
diff --git a/templates/rspec_api_documentation/html_index.mustache b/templates/rspec_api_documentation/html_index.mustache
@@ -10,7 +10,7 @@
 <body>
 <div class="container">
   <h1>{{ api_name }}</h1>
-
+  {{ api_explanation }}
   {{# sections }}
   <div class="article">
     <h2>{{ resource_name }}</h2>
diff --git a/templates/rspec_api_documentation/markdown_index.mustache b/templates/rspec_api_documentation/markdown_index.mustache
@@ -1,4 +1,5 @@
 # {{ api_name }}
+{{ api_explanation }}
 
 {{# sections }}
 ## {{ resource_name }}
diff --git a/templates/rspec_api_documentation/textile_index.mustache b/templates/rspec_api_documentation/textile_index.mustache
@@ -1,4 +1,5 @@
 h1. {{ api_name }}
+{{ api_explanation }}
 
 {{# sections }}
 h2. {{ resource_name }}

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,7 @@ def as_json(opts = nil)`
`94`	`94`	`{`
`95`	`95`	`@api_key.to_sym => {`
`96`	`96`	`:name => @configuration.api_name,`
	`97`	`+ :description => @configuration.api_explanation,`
`97`	`98`	`:protocol => @configuration.io_docs_protocol,`
`98`	`99`	`:publicPath => "",`
`99`	`100`	`:baseURL => @configuration.curl_host`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# {{ api_name }}`
	`2`	`+{{ api_explanation }}`
`2`	`3`
`3`	`4`	`{{# sections }}`
`4`	`5`	`## {{ resource_name }}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`h1. {{ api_name }}`
	`2`	`+{{ api_explanation }}`
`2`	`3`
`3`	`4`	`{{# sections }}`
`4`	`5`	`h2. {{ resource_name }}`