TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-13 11:25:13 -04:00
Code Issues Packages Projects Releases Wiki Activity

Correct openapi3.Unmarshal example

Browse Source 
Accessing the unmarshaled data structure depends on what `kin-openapi` does. This recently caused a [small breaking change](https://discourse.gohugo.io/t/openapi3-unmarshal-broken-range-cant-iterate/54725/) and may generally be a bit unintuitive, so I also included a brief warning and explanation along with a recent example.
This commit is contained in:
Hazel Virdó 2025-05-19 15:03:15 -04:00 committed by Bjørn Erik Pedersen
parent 580477aa57
commit 677b3fed35
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
content/en/functions/openapi3/Unmarshal.md
View File

@ -39,7 +39,7 @@ To inspect the data structure:
To list the GET and POST operations for each of the API paths:
```go-html-template
{{ range $path, $details := $api.Paths }}
{{ range $path, $details := $api.Paths.Map }}
<p>{{ $path }}</p>
<dl>
{{ with $details.Get }}
@ -54,6 +54,11 @@ To list the GET and POST operations for each of the API paths:
{{ end }}
```
> [!warning]
> The unmarshaled data structure is created with [`kin-openapi`](https://github.com/getkin/kin-openapi). Many fields are structs or pointers (not maps), and therefore require accessors or other methods for indexing and iteration.
> For example, prior to [`kin-openapi` v0.122.0](https://github.com/getkin/kin-openapi#v01220) / [Hugo v0.121.0](https://github.com/gohugoio/hugo/releases/tag/v0.121.0), `Paths` was a map (so `.Paths` was iterable) and it is now a pointer (and requires the `.Paths.Map` accessor, as in the example above).
> See the [`kin-openapi` godoc for OpenAPI 3](https://pkg.go.dev/github.com/getkin/kin-openapi/openapi3) for full type definitions.
Hugo renders this to:
```html