Skip to content

Fix for issue #2 to support custom group names on apiParam #3

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

Open
Zambonilli wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Fix for issue #2 to support custom group names on apiParam #3

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
50299e7
Fix for issue #2 to support custom group names on apiParam
Zambonilli Apr 21, 2015
4e459ef
Issue #4 Add the defaultValue and allowedValues to the parameter(s) t…
Zambonilli Apr 21, 2015
73e9fe8
Issue #5 Add a back to top link on every endpoint for very large APIs
Zambonilli Apr 21, 2015
b856324
Several Template fixes:
Sep 19, 2015
61e8519
WTF whitespace
Sep 19, 2015
ffb2660
Merge pull request #1 from tinisi/master
Zambonilli Sep 19, 2015
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
51 changes: 40 additions & 11 deletions templates/default.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<a name="top"></a>
# <%= project.name %> v<%= project.version %>

<%= project.description %>
Expand All @@ -18,6 +19,7 @@

<% Object.keys(data[group]).forEach(function (sub) { -%>
## <%= data[group][sub][0].title %>
[Back to top](#top)

<%-: data[group][sub][0].description | undef %>

Expand All @@ -29,21 +31,29 @@
| Name | Type | Description |
|---------|-----------|--------------------------------------|
<% data[group][sub][0].header.fields.Header.forEach(function (header) { -%>
| <%- header.field %> | <%- header.type %> | <%- header.optional ? '**optional**' : '' %> <%- header.description %> |
| <%- header.field %> | <%- header.type %> | <%- header.optional ? '**optional**' : '' %><%- header.description %>|
<% }); //forech parameter -%>
<% } //if parameters -%>
<% if (data[group][sub][0].parameter && data[group][sub][0].parameter.fields.Parameter.length) { -%>

### Parameters

| Name | Type | Description |
|---------|-----------|--------------------------------------|
<% data[group][sub][0].parameter.fields.Parameter.forEach(function (param) { -%>
| <%- param.field %> | <%- param.type %> | <%- param.optional ? '**optional**' : '' %> <%- param.description %> |
<% }); //forech parameter -%>
<% if (data[group][sub][0].parameter) { -%>

<% Object.keys(data[group][sub][0].parameter.fields).forEach(function(g) { -%>

### <%= g %> Parameters

| Name | Type | Description |
|:---------|:-----------|:--------------------------------------|
<% data[group][sub][0].parameter.fields[g].forEach(function (param) { -%>
| <%- param.field %> | <%- param.type %> | <%- param.optional ? '**optional**' : '' %><%- param.description -%>
<% if (param.defaultValue) { -%>
_Default value: <%= param.defaultValue %>_<br><% } -%>
<% if (param.size) { -%>
_Size range: <%- param.size %>_<br><% } -%>
<% if (param.allowedValues) { -%>
_Allowed values: <%- param.allowedValues %>_<% } %>|
<% }); //forech (group) parameter -%>
<% }); //forech param parameter -%>
<% } //if parameters -%>
<% if (data[group][sub][0].examples && data[group][sub][0].examples.length) { -%>

### Examples

<% data[group][sub][0].examples.forEach(function (example) { -%>
Expand All @@ -66,6 +76,25 @@
```
<% }); //foreach success example -%>
<% } //if examples -%>

<% if (data[group][sub][0].success && data[group][sub][0].success.fields) { -%>
<% Object.keys(data[group][sub][0].success.fields).forEach(function(g) { -%>
### <%= g %>

| Name | Type | Description |
|:---------|:-----------|:--------------------------------------|
<% data[group][sub][0].success.fields[g].forEach(function (param) { -%>
| <%- param.field %> | <%- param.type %> | <%- param.optional ? '**optional**' : '' %><%- param.description -%>
<% if (param.defaultValue) { -%>
_Default value: <%- param.defaultValue %>_<br><% } -%>
<% if (param.size) { -%>
_Size range: <%- param.size -%>_<br><% } -%>
<% if (param.allowedValues) { -%>
_Allowed values: <%- param.allowedValues %>_<% } %>|
<% }); //forech (group) parameter -%>
<% }); //forech field -%>
<% } //if success.fields -%>

<% if (data[group][sub][0].error && data[group][sub][0].error.examples && data[group][sub][0].error.examples.length) { -%>
### Error Response

Expand Down