Skip to content
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

Break out non-JSON request/response content types as tables #1756

Merged
merged 2 commits into from
Mar 21, 2024
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clearly indicate that each `Content-Type` may have distinct behaviour on non-JSON requests/responses.
17 changes: 10 additions & 7 deletions layouts/partials/openapi/render-content-type.html
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
{{/*

Render a table showing content type and description, given:
Render a table showing content types and their descriptions, given
two arrays with equal length:

* `content_type`: the content type as a string
* `content_types`: the content type strings

* `description`: the description as a string
* `descriptions`: the description strings

*/}}

{{ $content_type := .content_type }}
{{ $description := .description}}
{{ $content_types := .content_types }}
{{ $descriptions := .descriptions}}

{{ if $content_type }}
{{ if (gt (len $content_types) 0) }}

<table class="content-type-table">
<thead>
<th class="col-name">Content-Type</th>
<th class="col-description">Description</th>
</thead>
{{ range $idx, $content_type := $content_types }}
<tr>
<td><code>{{ $content_type }}</code></td>
<td>{{ $description | markdownify -}}</td>
<td>{{ index $descriptions $idx | markdownify -}}</td>
</tr>
{{ end }}
</table>

{{ end }}
7 changes: 4 additions & 3 deletions layouts/partials/openapi/render-request.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,13 @@ <h3>Request body</h3>
{{/*
Show the content types and description.
*/}}
{{ $mimes := slice }}
{{ $mimes := slice }}
{{ $descriptions := slice }}
{{ range $mime, $body := $request_body.content }}
{{ $mimes = $mimes | append $mime }}
{{ $descriptions = $descriptions | append $request_body.description }}
{{ end }}
{{ $content_type := delimit $mimes "|"}}
{{ partial "openapi/render-content-type" (dict "content_type" $content_type "description" $request_body.description) }}
{{ partial "openapi/render-content-type" (dict "content_types" $mimes "descriptions" $descriptions) }}
{{ end }}

<h3>Request body example</h3>
Expand Down
7 changes: 3 additions & 4 deletions layouts/partials/openapi/render-responses.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,12 @@ <h3>{{$code}} response</h3>
Show the content types and description.
*/}}
{{ $mimes := slice }}
{{ $desc := "" }}
{{ $descriptions := slice }}
{{ range $mime, $body := $response.content }}
{{ $mimes = $mimes | append $mime }}
{{ $desc = $body.schema.description }}
{{ $descriptions = $descriptions | append $body.schema.description }}
{{ end }}
{{ $content_type := delimit $mimes "|"}}
{{ partial "openapi/render-content-type" (dict "content_type" $content_type "description" $desc) }}
{{ partial "openapi/render-content-type" (dict "content_types" $mimes "descriptions" $descriptions) }}
{{ end }}
{{ end }}
{{ end }}