File: issue601_test.go

package info (click to toggle)
golang-github-getkin-kin-openapi 0.124.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,288 kB
  • sloc: sh: 344; makefile: 4
file content (34 lines) | stat: -rw-r--r-- 1,024 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
package openapi3

import (
	"testing"

	"github.com/stretchr/testify/require"
)

func TestIssue601(t *testing.T) {
	// Document is invalid: first validation error returned is because
	//     schema:
	//       example: {key: value}
	// is not how schema examples are defined (but how components' examples are defined. Components are maps.)
	// Correct code should be:
	//     schema: {example: value}
	sl := NewLoader()
	doc, err := sl.LoadFromFile("testdata/lxkns.yaml")
	require.NoError(t, err)

	err = doc.Validate(sl.Context)
	require.ErrorContains(t, err, `invalid components: schema "DiscoveryResult": invalid example: Error at "/type": property "type" is missing`)
	require.ErrorContains(t, err, `| Error at "/nsid": property "nsid" is missing`)

	err = doc.Validate(sl.Context, DisableExamplesValidation())
	require.NoError(t, err)

	// Now let's remove all the invalid parts
	for _, schema := range doc.Components.Schemas {
		schema.Value.Example = nil
	}

	err = doc.Validate(sl.Context)
	require.NoError(t, err)
}