Adding examples to a responses block

[chrsvl]

Hey folks,

First off, thanks a lot for your efforts with this lib, it's helped me a lot!

I have tried to generate the following yaml file with openapi-go but for now have failed miserably:

paths:
  /endpoint_name:
    post:
      tags:
        - An_endpoint
      summary: An endpoint doing stuff
      requestBody:
        omitted
      responses:
        "201":
          description: all good
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: "#/components/schemas/object_1"
                  - $ref: "#/components/schemas/object_2"
              examples:
                responseOne:
                  summary: "First possible answer"
                  value:
                    code: "1234567890123456789012"
                responseTwo:
                  summary: "Other possible answer"
                  value:
                    code: "0000000000000000000000"

That would result in the following representation:

I searched in the past discussions and only found this one, but when I tried applying it to my case it did not work either.

Do you have an idea of what I am missing here?

Thanks a lot in advance!

[vearutop]

Hello, please check a test for an example: https://github.com/swaggest/openapi-go/blob/v0.2.53/openapi3/reflect_test.go#L1213.
(And also upgrade to latest version, since there was a bug that discarded manual changes like this)

func TestNewReflector_examples(t *testing.T) {
	r := openapi3.NewReflector()

	op, err := r.NewOperationContext(http.MethodGet, "/")
	require.NoError(t, err)

	type O1 struct {
		F1   int    `json:"f1,omitempty"`
		Code string `json:"code"`
	}

	type O2 struct {
		F2   int    `json:"f2,omitempty"`
		Code string `json:"code"`
	}

	st := http.StatusCreated

	op.AddRespStructure(jsonschema.OneOf(O1{}, O2{}), func(cu *openapi.ContentUnit) {
		cu.HTTPStatus = st
	})

	if o3, ok := op.(openapi3.OperationExposer); ok {
		c := openapi3.MediaType{}
		c.Examples = map[string]openapi3.ExampleOrRef{
			"responseOne": {
				Example: (&openapi3.Example{}).WithSummary("First possible answer").WithValue(O1{Code: "1234567890123456789012"}),
			},
			"responseTwo": {
				Example: (&openapi3.Example{}).WithSummary("Other possible answer").WithValue(O2{Code: "0000000000000000000000"}),
			},
		}
		resp := openapi3.Response{}
		resp.WithContentItem("application/json", c)

		o3.Operation().Responses.WithMapOfResponseOrRefValuesItem(strconv.Itoa(st), openapi3.ResponseOrRef{
			Response: &resp,
		})
	}

	require.NoError(t, r.AddOperation(op))
	assertjson.EqMarshal(t, `{
	  "openapi":"3.0.3","info":{"title":"","version":""},
	  "paths":{
		"/":{
		  "get":{
			"responses":{
			  "201":{
				"description":"Created",
				"content":{
				  "application/json":{
					"schema":{
					  "oneOf":[
						{"$ref":"#/components/schemas/Openapi3TestO1"},
						{"$ref":"#/components/schemas/Openapi3TestO2"}
					  ]
					},
					"examples":{
					  "responseOne":{
						"summary":"First possible answer",
						"value":{"code":"1234567890123456789012"}
					  },
					  "responseTwo":{
						"summary":"Other possible answer",
						"value":{"code":"0000000000000000000000"}
					  }
					}
				  }
				}
			  }
			}
		  }
		}
	  },
	  "components":{
		"schemas":{
		  "Openapi3TestO1":{
			"type":"object",
			"properties":{"code":{"type":"string"},"f1":{"type":"integer"}}
		  },
		  "Openapi3TestO2":{
			"type":"object",
			"properties":{"code":{"type":"string"},"f2":{"type":"integer"}}
		  }
		}
	  }
	}`, r.SpecSchema())
}

It is a bit complicated, and probably would have a better place in ContentUnit, but the problem is to come up with a reasonable API for both 3.0 and 3.1.

[chrsvl]

Thanks a lot!