diff --git a/features/api_blueprint_documentation.feature b/features/api_blueprint_documentation.feature index a824e0cf..2ac78462 100644 --- a/features/api_blueprint_documentation.feature +++ b/features/api_blueprint_documentation.feature @@ -64,6 +64,7 @@ Feature: Generate API Blueprint documentation from test examples RspecApiDocumentation.configure do |config| config.app = App config.api_name = "Example API" + config.api_explanation = "Example API Description" config.format = :api_blueprint config.request_body_formatter = :json config.request_headers_to_include = %w[Content-Type Host] diff --git a/features/html_documentation.feature b/features/html_documentation.feature index ef2d0aad..33cef81b 100644 --- a/features/html_documentation.feature +++ b/features/html_documentation.feature @@ -24,6 +24,7 @@ Feature: Generate HTML documentation from test examples RspecApiDocumentation.configure do |config| config.app = App config.api_name = "Example API" + config.api_explanation = "Example API Description" config.request_headers_to_include = %w[Cookie] config.response_headers_to_include = %w[Content-Type] end @@ -66,6 +67,12 @@ Feature: Generate HTML documentation from test examples | Greetings | And I should see the api name "Example API" + Scenario: Create an index with proper description + When I open the index + Then I should see the following resources: + | Greetings | + And I should see the api explanation "Example API Description" + Scenario: Example HTML documentation includes the parameters When I open the index And I navigate to "Greeting your favorite gem" diff --git a/features/json_iodocs.feature b/features/json_iodocs.feature index 319855db..e6d7ac37 100644 --- a/features/json_iodocs.feature +++ b/features/json_iodocs.feature @@ -24,6 +24,7 @@ Feature: Json Iodocs RspecApiDocumentation.configure do |config| config.app = App config.api_name = "app" + config.api_explanation = "desc" config.format = :json_iodocs config.io_docs_protocol = "https" end @@ -70,6 +71,7 @@ Feature: Json Iodocs { "app" : { "name" : "app", + "description": "desc", "protocol" : "https", "publicPath" : "", "baseURL" : null diff --git a/features/markdown_documentation.feature b/features/markdown_documentation.feature index 1e461a78..a6cf4957 100644 --- a/features/markdown_documentation.feature +++ b/features/markdown_documentation.feature @@ -49,6 +49,7 @@ Feature: Generate Markdown documentation from test examples RspecApiDocumentation.configure do |config| config.app = App config.api_name = "Example API" + config.api_explanation = "Example API Description" config.format = :markdown config.request_headers_to_include = %w[Content-Type Host] config.response_headers_to_include = %w[Content-Type Content-Length] @@ -148,6 +149,7 @@ Feature: Generate Markdown documentation from test examples Then the file "doc/api/index.markdown" should contain exactly: """ # Example API + Example API Description ## Help diff --git a/features/slate_documentation.feature b/features/slate_documentation.feature index 86e1c5fb..0a3531b0 100644 --- a/features/slate_documentation.feature +++ b/features/slate_documentation.feature @@ -49,6 +49,7 @@ Feature: Generate Slate documentation from test examples RspecApiDocumentation.configure do |config| config.app = App config.api_name = "Example API" + config.api_explanation = "Description" config.format = :slate config.curl_host = 'http://localhost:3000' config.request_headers_to_include = %w[Content-Type Host] diff --git a/features/textile_documentation.feature b/features/textile_documentation.feature index 0cbaa03d..dae338c8 100644 --- a/features/textile_documentation.feature +++ b/features/textile_documentation.feature @@ -49,6 +49,7 @@ Feature: Generate Textile documentation from test examples RspecApiDocumentation.configure do |config| config.app = App config.api_name = "Example API" + config.api_explanation = "Example API Description" config.format = :textile config.request_headers_to_include = %w[Content-Type Host] config.response_headers_to_include = %w[Content-Type Content-Length] @@ -148,6 +149,7 @@ Feature: Generate Textile documentation from test examples Then the file "doc/api/index.textile" should contain exactly: """ h1. Example API + Example API Description h2. Help