Skip to content

Use tables to represent markdown parameters #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 23, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions features/markdown_documentation.feature
Original file line number Diff line number Diff line change
Expand Up @@ -226,14 +226,11 @@ Feature: Generate Markdown documentation from test examples

### Parameters

Name : name *- required -*
Description : Name of order

Name : amount *- required -*
Description : Amount paid

Name : description
Description : Some comments on the order
| Name | Description | Required | Scope |
|------|-------------|----------|-------|
| name | Name of order | true | |
| amount | Amount paid | true | |
| description | Some comments on the order | false | |

### Request

Expand Down
6 changes: 6 additions & 0 deletions lib/rspec_api_documentation/views/markdown_example.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ def initialize(example, configuration)
self.template_name = "rspec_api_documentation/markdown_example"
end

def parameters
super.each do |parameter|
parameter[:required] = parameter[:required] ? 'true' : 'false'
end
end

def extension
EXTENSION
end
Expand Down
7 changes: 4 additions & 3 deletions templates/rspec_api_documentation/markdown_example.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@
{{# has_parameters? }}

### Parameters
{{# parameters }}

Name : {{ name }}{{# required }} *- required -*{{/ required }}
Description : {{ description }}
| Name | Description | Required | Scope |
|------|-------------|----------|-------|
{{# parameters }}
| {{ name }} | {{ description }} | {{ required }} | {{ scope }} |
{{/ parameters }}

{{/ has_parameters? }}
Expand Down