Skip to content

Add clearer slate support in README. Reorganize slate_example.mustach… #412

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.

Sign up for GitHub

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 3 commits into from
Oct 4, 2018
Merged

Add clearer slate support in README. Reorganize slate_example.mustach… #412

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98de6ee
Add clearer slate support in README. Reorganize slate_example.mustach…
E1337Kat Oct 4, 2018
c301750
Fix for Travis CI tool.
E1337Kat Oct 4, 2018
03d2751
Fix curl not being used. Fix cucumber test.
E1337Kat Oct 4, 2018
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
Prev Previous commit
Fix curl not being used. Fix cucumber test.
  • Loading branch information
@E1337Kat
E1337Kat committed Oct 4, 2018
commit 03d2751edf1383a5367b5a2486dd33f04a88c262
2 changes: 1 addition & 1 deletion features/slate_documentation.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,11 +236,11 @@ Feature: Generate Slate documentation from test examples

#### Parameters


```json
name=Order+3&amount=33.0
```


| Name | Description |
|:-----|:------------|
| name *required* | Name of order |
Expand Down
12 changes: 7 additions & 5 deletions templates/rspec_api_documentation/slate_example.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,28 @@

### Request

{{# requests }}
{{# curl }}
```shell
{{{ curl }}}
```
{{/ curl }}
{{/ requests }}

#### Endpoint

`{{ http_method }} {{ route }}`

{{# requests}}
{{# requests }}
```plaintext
{{ request_method }} {{ request_path }}
{{ request_headers_text }}
```
{{/ requests}}
{{/ requests }}

#### Parameters

{{# requests}}
{{# requests }}
{{# request_query_parameters_text }}
```json
{{ request_query_parameters_text }}
Expand All @@ -52,7 +54,7 @@ None known.
### Response


{{# response_status}}
{{# response_status }}
```plaintext
{{ response_headers_text }}
{{ response_status }} {{ response_status_text}}
Expand All @@ -75,4 +77,4 @@ None known.
| {{#scope}}{{scope}}[{{/scope}}{{ name }}{{#scope}}]{{/scope}} | {{{ description }}} |
{{/ response_fields }}
{{/ has_response_fields? }}
{{/ requests}}
{{/ requests }}