openapi

type ErrorRecorder interface {
	// AddError records that the given error occurred.
	// See the documentation on loader.Package.AddError for more information.
	AddError(error)
}

type Flattener interface {
	FlattenType(typ TypeIdent) *apiext.JSONSchemaProps
}

type PackageOverride func(p *parser, pkg *loader.Package)

type Parser interface {
	// NeedPackage indicates that types and type-checking information
	// is needed for the given package.
	NeedPackage(pkg *loader.Package)
	NeedOpenAPIFor(typeIdent TypeIdent)
	FindProviderAPIs() []TypeIdent
	PrintSchemata()
}

type SchemaMarker interface {
	// ApplyToSchema is called after the rest of the schema for a given type
	// or field is generated, to modify the schema appropriately.
	ApplyToSchema(*apiext.JSONSchemaProps) error
}

type SchemaVisitor interface {
	// Visit is called for each schema node.  If it returns a visitor,
	// the visitor will be called on each direct child node, and then
	// this visitor will be called again with `nil` to indicate that
	// all children have been visited.  If a nil visitor is returned,
	// children are not visited.
	//
	// It is *NOT* safe to save references to the given schema.
	// Make deepcopies if you need to keep things around beyond
	// the lifetime of the call.
	Visit(schema *apiext.JSONSchemaProps) SchemaVisitor
}

type TypeIdent struct {
	Package *loader.Package
	Name    string
}