wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Render added/changed in info on request and response content types (#1876)

Browse source 
* Render added/changed in info on request and response content types

Fixes: #1774
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Kévin Commaille <76261501+zecakeh@users.noreply.github.com>
This commit is contained in:
Johannes Marbach 2024-06-20 10:46:33 +02:00 • committed by GitHub
parent 5fbfdd6821
commit 27e71fff10
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 15 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

18
layouts/partials/openapi/render-content-type.html
View file

@ -1,16 +1,12 @@
{{/*
Render a table showing content types and their descriptions, given
two arrays with equal length:
Render a table showing content types and their descriptions, given:
* `content_types`: the content type strings
* `descriptions`: the description strings
* `content_types`: OpenAPI data specifying the content types as a dictionary of the form {string: {"schema": JsonSchema}}
*/}}
{{ $content_types := .content_types }}
{{ $descriptions := .descriptions}}
{{ if (gt (len $content_types) 0) }}
@ -21,10 +17,14 @@
<th class="col-description">Description</th>
</tr>
</thead>
{{ range $idx, $content_type := $content_types }}
{{ range $mime, $body := $content_types }}
<tr>
<td><code>{{ $content_type }}</code></td>
<td>{{ index $descriptions $idx | markdownify -}}</td>
<td><code>{{ $mime }}</code></td>
<td>
{{ $body.schema.description | markdownify -}}
{{ if (index $body.schema "x-addedInMatrixVersion") }}{{ partial "added-in" (dict "v" (index $body.schema "x-addedInMatrixVersion")) }}{{ end -}}
{{ if (index $body.schema "x-changedInMatrixVersion") }}{{ partial "changed-in" (dict "changes_dict" (index $body.schema "x-changedInMatrixVersion")) }}{{ end -}}
</td>
</tr>
{{ end }}
</table>

8
layouts/partials/openapi/render-request.html
View file

@ -50,13 +50,7 @@
{{/*
Show the content types and description.
*/}}
{{ $mimes := slice }}
{{ $descriptions := slice }}
{{ range $mime, $body := $request_body.content }}
{{ $mimes = $mimes | append $mime }}
{{ $descriptions = $descriptions | append $request_body.description }}
{{ end }}
{{ partial "openapi/render-content-type" (dict "content_types" $mimes "descriptions" $descriptions) }}
{{ partial "openapi/render-content-type" (dict "content_types" $request_body.content) }}
{{ end }}
<h3>Request body example</h3>

8
layouts/partials/openapi/render-responses.html
View file

@ -123,13 +123,7 @@
{{/*
Show the content types and description.
*/}}
{{ $mimes := slice }}
{{ $descriptions := slice }}
{{ range $mime, $body := $response.content }}
{{ $mimes = $mimes | append $mime }}
{{ $descriptions = $descriptions | append $body.schema.description }}
{{ end }}
{{ partial "openapi/render-content-type" (dict "content_types" $mimes "descriptions" $descriptions) }}
{{ partial "openapi/render-content-type" (dict "content_types" $response.content) }}
{{ end }}
{{ end }}
{{ end }}