example

package

v0.1.1 Latest Latest Go to latest Published: Jul 30, 2025 License: MIT Imports: 2 Imported by: 0

Details

Examples provided as part of the OpenAPI spec.

This section is empty.

This section is empty.

func GetExample(typ reflect.Type) *shared.Json

Utility cast to HasExample, get the example.

func GetExamples(typ reflect.Type) *map[string]Example

Utility cast to HasExamples, get the examples.

type Example interface {
	// contains filtered or unexported methods
}

Example Object | Reference Object

type HasExample interface {
	Example() shared.Json
}

Implement this to add a single example of a type without comments.

type HasExamples interface {
	Examples() map[string]Example
}

Implement this to add commented examples.

type Reference shared.Reference

A reference to a Component.

func Ref(to string) Reference

type Spec struct {
	Summary       string
	Description   string
	Value         *shared.Json
	ExternalValue *string
}