doc

package

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

Details

OpenAPI documentation

This section is empty.

This section is empty.

func GetDescription(typ reflect.Type) *string

Utility: get the description from a HasDescription.

func GetSummary(typ reflect.Type) *string

Utility: get the summary from a HasSummary.

type External struct {
	Description string `json:"description"`
	Url         string `json:"url"`
}

func GetExternalDocs(typ reflect.Type) *External

Utility: get the description from a HasDescription.

type HasDescription interface {
	Description() string
}

Implement this on a type to add a description.

type HasExternalDocs interface {
	Docs() External
}

Implement this on a type to add external docs.

type HasSummary interface {
	Summary() string
}

Implement this on a type to add a summary.