openapi

type Compiler struct{}

type ExtensionPromotions = lowering.ExtensionPromotions

type ExtensionTarget = lowering.ExtensionTarget

type GroupingStrategy = lowering.GroupingStrategy

type Limits struct {
	// MaxSourceBytes bounds one source document's size in bytes, checked before
	// it is parsed.
	MaxSourceBytes int `json:"maxSourceBytes,omitzero"`
	// MaxSourceNodes bounds the YAML nodes one source document parses to,
	// checked before the typed model is built from it.
	MaxSourceNodes int `json:"maxSourceNodes,omitzero"`
	// MaxEnumMembers bounds the members of a single enum. An enum past it lowers
	// as the top type with an error diagnostic naming the budget; the rest of the
	// document still lowers.
	MaxEnumMembers int `json:"maxEnumMembers,omitzero"`
	// MaxAliasSurplus bounds the nodes YAML aliases may add to one source
	// document, or to its overlay, beyond the document's own: what the document
	// costs once every alias stands in for a copy of what it names, less what it
	// costs as written. A document with no alias adds nothing, so this never
	// refuses one for its size. A source past it is refused before the typed
	// model is built from it, where that cost would be paid, and an overlay
	// before it is applied.
	//
	// Turning it off does not turn off alias refusal. A document whose aliases
	// expand it past both 128 times its own size and 32,768 nodes is refused
	// whatever this says, as openapi/alias-amplification rather than
	// openapi/budget-exceeded, because that is the shape of a bomb rather than of
	// a large document. What is left unbounded is how far a document within that
	// ratio may expand, so its cost is at most that multiple of its own size.
	MaxAliasSurplus int `json:"maxAliasSurplus,omitzero"`
}

type Options struct {
	// Grouping selects the operation-grouping strategy.
	Grouping GroupingStrategy `json:"grouping,omitempty"`
	// StreamingMedia selects which media types imply a stream. The zero value is
	// the default list, on; a caller who wants only what a document declares
	// disables it.
	StreamingMedia StreamingMedia `json:"streamingMedia"`

	// Promotions selects which vendor extensions are read into typed IR fields.
	// The zero value is the default mapping, on; a caller who wants extensions
	// kept verbatim and nothing more disables it.
	Promotions ExtensionPromotions `json:"promotions"`
	// AllowExternalRefs lets reference resolution leave the source document —
	// reading files off disk and fetching http(s) URLs. Off by default, because
	// compilers.Source is the whole input ("the caller loads bytes so compilation
	// stays pure and reentrant") and a spec is untrusted data whose $refs would
	// otherwise name any readable file or reachable host. A $ref leaving the
	// document is reported unresolved instead of followed.
	//
	// Turning it on departs from that contract knowingly, and buys less than it
	// looks: resolution reads relative to the process working directory, so the
	// same bytes compile differently in two directories, and the resolved content
	// still does not reach lowering — Sources records one entry either way
	// (GitHub #74 carries the multi-file work).
	AllowExternalRefs bool `json:"allowExternalRefs"`
	// Overlay is an OpenAPI Overlay document to apply to the source before
	// lowering, or nil for none. It is the source-document patching hook
	// architecture §2.2 names, and is deliberately not the IR overlay pass beside
	// it: a fix that has to land before naming and hoisting heuristics read the
	// broken shape cannot be made afterwards.
	Overlay *Overlay `json:"overlay,omitzero"`
	// Limits bounds how large an input this compile will lower. The zero value
	// takes every default.
	Limits Limits `json:"limits"`
}

type Overlay struct {
	// Path names the overlay document. It is recorded as the overlay's
	// SourceInfo path and never opened.
	Path string `json:"path,omitempty"`
	// Data is the overlay document's bytes.
	Data []byte `json:"data,omitempty"`
	// Lax turns off strict application.
	//
	// Strict — the zero value — is the default because an action whose selector
	// matches nothing is nearly always a typo in a JSONPath, and an overlay that
	// silently does nothing ships an SDK missing the very fix it was written to
	// make. Under strict such an action is reported and the compile refuses;
	// under lax it is not reported at all.
	Lax bool `json:"lax,omitzero"`
}

type StreamingMedia = lowering.StreamingMedia