Skip to content

Commit 68c3fcc

Browse files
fmvilasfmvilas
committed
Add some improvements on Markdown template: required on parameters, and separate parameters in headers, query, path, and cookie.
1 parent 0706bc4 commit 68c3fcc

File tree

10 files changed

+85
-13
lines changed

10 files changed

+85
-13
lines changed

‎lib/beautifier.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ const beautifyOperation = (operation, operationName, pathName) => {
8484
param.descriptionAsHTML = mdToHTML(param.description);
8585
if (param.schema) beautifySchema(param.schema);
8686
});
87+
88+
operation.headers = operation.parameters.filter(p => p.in === 'header');
89+
operation.queryParams = operation.parameters.filter(p => p.in === 'query');
90+
operation.pathParams = operation.parameters.filter(p => p.in === 'path');
91+
operation.cookieParams = operation.parameters.filter(p => p.in === 'cookie');
8792
}
8893

8994
if (operation.responses) {

‎templates/markdown/.partials/cookieParams.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#### Cookie parameters
2+
3+
{{#each cookieParams as |cookieParam|}}
4+
{{#if cookieParam.name}}
5+
##### ▷ {{cookieParam.name}}
6+
{{/if}}
7+
8+
{{#if cookieParam.description}}
9+
{{{cookieParam.description}}}
10+
{{/if}}
11+
12+
{{> parameter param=cookieParam paramName=cookieParam.name hideTitle=true}}
13+
14+
{{/each}}

‎templates/markdown/.partials/headers.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#### Headers
2+
3+
{{#each headers as |header|}}
4+
{{#if header.name}}
5+
##### ▷ {{header.name}}
6+
{{/if}}
7+
8+
{{#if header.description}}
9+
{{{header.description}}}
10+
{{/if}}
11+
12+
{{> parameter param=header paramName=header.name hideTitle=true}}
13+
14+
{{/each}}

‎templates/markdown/.partials/operation.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@
88
{{{operation.description}}}
99
{{/if}}
1010

11+
{{#if operation.pathParams}}
12+
{{> pathParams pathParams=operation.pathParams}}
13+
{{/if}}
14+
15+
{{#if operation.headers}}
16+
{{> headers headers=operation.headers}}
17+
{{/if}}
18+
19+
{{#if operation.queryParams}}
20+
{{> queryParams queryParams=operation.queryParams}}
21+
{{/if}}
22+
23+
{{#if operation.cookieParams}}
24+
{{> cookieParams cookieParams=operation.cookieParams}}
25+
{{/if}}
26+
1127
{{#if operation.requestBody}}
1228
#### Request body
1329
{{#each operation.requestBody.content as |contentType contentTypeName| }}
@@ -49,12 +65,6 @@
4965
{{/equal}}
5066
{{/each}}
5167

52-
{{#if operation.parameters}}
53-
#### Parameters
54-
55-
{{> parameters params=operation.parameters hideTitle=true}}
56-
{{/if}}
57-
5868
{{#if operation.responses}}
5969
#### Responses
6070

‎templates/markdown/.partials/param-prop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<tr>
2-
<td>{{tree path}}{{propName}} {{#if required}} <strong>(required)</strong>{{/if}}</td>
2+
<td>{{tree path}}{{propName}} {{#if prop.required}} <strong>(required)</strong>{{/if}}</td>
33
<td>
44
{{#if prop.schema}}
55
{{prop.schema.type}}

‎templates/markdown/.partials/parameters.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
{{#unless hideTitle}}
2-
#### Parameters
3-
{{/unless}}
1+
#### Headers
42

53
{{#each params as |param|}}
6-
{{#equal param.in 'body'}}
7-
{{else}}
4+
{{#equal param.in 'header'}}
85
{{#if param.name}}
96
##### {{param.name}}
107
{{/if}}

‎templates/markdown/.partials/path.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
{{#each path}}
22
{{#validMethod @key}}
33

4+
{{#if ../deprecated}}
5+
### _(DEPRECATED)_ ~~`{{uppercase @key}}` {{../../pathName}}~~
6+
{{else}}
47
### `{{uppercase @key}}` {{../../pathName}}
8+
{{/if}}
59
{{> operation operation=.. operationName=(uppercase @key)}}
610
{{/validMethod}}
711
{{/each}}

‎templates/markdown/.partials/pathParams.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#### Path parameters
2+
3+
{{#each pathParams as |pathParam|}}
4+
{{#if pathParam.name}}
5+
##### &#9655; {{pathParam.name}}
6+
{{/if}}
7+
8+
{{#if pathParam.description}}
9+
{{{pathParam.description}}}
10+
{{/if}}
11+
12+
{{> parameter param=pathParam paramName=pathParam.name hideTitle=true}}
13+
14+
{{/each}}

‎templates/markdown/.partials/queryParams.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#### Query parameters
2+
3+
{{#each queryParams as |queryParam|}}
4+
{{#if queryParam.name}}
5+
##### &#9655; {{queryParam.name}}
6+
{{/if}}
7+
8+
{{#if queryParam.description}}
9+
{{{queryParam.description}}}
10+
{{/if}}
11+
12+
{{> parameter param=queryParam paramName=queryParam.name hideTitle=true}}
13+
14+
{{/each}}

‎templates/markdown/openapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
{{#each openapi.paths as |path pathName|}}
1616
{{#each path as |op opName|}}
1717
{{#validMethod opName}}
18-
- [`{{uppercase opName}}` {{pathName}}](#{{op.slug}})
18+
- [`{{uppercase opName}}` {{pathName}}](#{{op.slug}}) {{#if op.deprecated}}_(deprecated)_{{/if}}
1919
{{/validMethod}}
2020
{{/each}}
2121
{{/each}}

0 commit comments

Comments
 (0)