MediaType example incorrectly uses low-level node reference

[danielgtaylor]

I've run into a minor bug where an OpenAPI 3 MediaType example is being incorrectly loaded from the low-level model into the high-level model. It is being represented as a low-level node ref. The same example field inside the schema does work correctly.

As a temporary workaround I have done this:

for mt, item := range op.RequestBody.Content {
	// HACK: example is just a low-level node ref which may in fact just
	// be a node representing `null` or the real example.
	if n, ok := item.Example.(low.NodeReference[any]); ok {
		item.Example = n.Value
	}

Here's a simple test to show the bug in action:

$ go run ./bug
Obj {{"foo": "hello"} 0x1400011da40 0x1400011d9a0}             <---- whoops
Schema {"bar": "world"}

Code:

package main

import (
	"fmt"

	"github.com/pb33f/libopenapi"
)

var data = `
openapi: "3.0"
paths:
  /test:
    get:
      responses:
        "200":
          content:
            application/json:
              example: "{\"foo\": \"hello\"}"
              schema:
                type: object
                example: "{\"bar\": \"world\"}"
                properties:
                  foo:
                    type: string
                  bar:
                    type: string
`

func main() {
	doc, err := libopenapi.NewDocument([]byte(data))
	if err != nil {
		panic(err)
	}

	result, errs := doc.BuildV3Model()
	if len(errs) > 0 {
		panic(errs)
	}

	m := result.Model

	fmt.Println("Obj", m.Paths.PathItems["/test"].Get.Responses.Codes["200"].Content["application/json"].Example)

	fmt.Println("Schema", m.Paths.PathItems["/test"].Get.Responses.Codes["200"].Content["application/json"].Schema.Schema().Example)
}

Part of danielgtaylor/restish#115.

[daveshanley]

Nice catch! I'll address this ASAP.

[daveshanley]

This has been resolved, and the example is now correctly pulled up into the high-level model (forgot the .Value). It's fixed in v0.1.11

Thanks once again for your help to make this a better library!