File tree Expand file tree Collapse file tree 6 files changed +15
-0
lines changed Expand file tree Collapse file tree 6 files changed +15
-0
lines changed Original file line number Diff line number Diff line change @@ -64,6 +64,7 @@ Feature: Generate API Blueprint documentation from test examples
64
64
RspecApiDocumentation.configure do |config|
65
65
config.app = App
66
66
config.api_name = "Example API"
67
+ config.api_explanation = "Example API Description"
67
68
config.format = :api_blueprint
68
69
config.request_body_formatter = :json
69
70
config.request_headers_to_include = %w[Content-Type Host]
Original file line number Diff line number Diff line change @@ -24,6 +24,7 @@ Feature: Generate HTML documentation from test examples
24
24
RspecApiDocumentation.configure do |config|
25
25
config.app = App
26
26
config.api_name = "Example API"
27
+ config.api_explanation = "Example API Description"
27
28
config.request_headers_to_include = %w[Cookie]
28
29
config.response_headers_to_include = %w[Content-Type]
29
30
end
@@ -66,6 +67,12 @@ Feature: Generate HTML documentation from test examples
66
67
| Greetings |
67
68
And I should see the api name "Example API"
68
69
70
+ Scenario : Create an index with proper description
71
+ When I open the index
72
+ Then I should see the following resources:
73
+ | Greetings |
74
+ And I should see the api explanation "Example API Description"
75
+
69
76
Scenario : Example HTML documentation includes the parameters
70
77
When I open the index
71
78
And I navigate to "Greeting your favorite gem"
Original file line number Diff line number Diff line change @@ -24,6 +24,7 @@ Feature: Json Iodocs
24
24
RspecApiDocumentation.configure do |config|
25
25
config.app = App
26
26
config.api_name = "app"
27
+ config.api_explanation = "desc"
27
28
config.format = :json_iodocs
28
29
config.io_docs_protocol = "https"
29
30
end
@@ -70,6 +71,7 @@ Feature: Json Iodocs
70
71
{
71
72
"app" : {
72
73
"name" : "app",
74
+ "description": "desc",
73
75
"protocol" : "https",
74
76
"publicPath" : "",
75
77
"baseURL" : null
Original file line number Diff line number Diff line change @@ -49,6 +49,7 @@ Feature: Generate Markdown documentation from test examples
49
49
RspecApiDocumentation.configure do |config|
50
50
config.app = App
51
51
config.api_name = "Example API"
52
+ config.api_explanation = "Example API Description"
52
53
config.format = :markdown
53
54
config.request_headers_to_include = %w[Content-Type Host]
54
55
config.response_headers_to_include = %w[Content-Type Content-Length]
@@ -148,6 +149,7 @@ Feature: Generate Markdown documentation from test examples
148
149
Then the file "doc/api/index.markdown" should contain exactly:
149
150
"""
150
151
# Example API
152
+ Example API Description
151
153
152
154
## Help
153
155
Original file line number Diff line number Diff line change @@ -49,6 +49,7 @@ Feature: Generate Slate documentation from test examples
49
49
RspecApiDocumentation.configure do |config|
50
50
config.app = App
51
51
config.api_name = "Example API"
52
+ config.api_explanation = "Description"
52
53
config.format = :slate
53
54
config.curl_host = 'http://localhost:3000'
54
55
config.request_headers_to_include = %w[Content-Type Host]
Original file line number Diff line number Diff line change @@ -49,6 +49,7 @@ Feature: Generate Textile documentation from test examples
49
49
RspecApiDocumentation.configure do |config|
50
50
config.app = App
51
51
config.api_name = "Example API"
52
+ config.api_explanation = "Example API Description"
52
53
config.format = :textile
53
54
config.request_headers_to_include = %w[Content-Type Host]
54
55
config.response_headers_to_include = %w[Content-Type Content-Length]
@@ -148,6 +149,7 @@ Feature: Generate Textile documentation from test examples
148
149
Then the file "doc/api/index.textile" should contain exactly:
149
150
"""
150
151
h1. Example API
152
+ Example API Description
151
153
152
154
h2. Help
153
155
You can’t perform that action at this time.
0 commit comments