example

package

v0.4.0 Latest Latest Go to latest Published: Apr 2, 2026 License: MIT Imports: 3 Imported by: 0

Details

This section is empty.

This section is empty.

func New(store *store.Store, value any, opts ...Option) *base.Example

New builds an example from value and applies any additional example options.

func NewRef(name string) *base.Example

NewRef returns an example reference to the named component in components/examples.

type Option func(*base.Example)

Option configures an OpenAPI example object.

func Description(s string) Option

Description sets the long description of the example.

func ExternalValue(url string) Option

ExternalValue sets a URL pointing to the literal example value. Mutually exclusive with the value argument to New.

func Reference(ref string) Option

Reference sets a $ref to a named example component in components/examples.

func Summary(s string) Option

Summary sets a short summary of the example.