Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions compilers/openapi/internal/load/load.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ import (

// Options is what Load needs from the compiler's own options. It is a separate
// type rather than the compiler's, because openapi.Options is public API whose
// shape is fixed by ir-design §10 and most of it describes lowering, which
// nothing here can see.
// shape is a published contract (its own doc comment says why) and most of it
// describes lowering, which nothing here can see.
type Options struct {
// AllowExternalRefs lets reference resolution reach outside the document —
// off the filesystem or over the network. Off is the default, so the zero
Expand Down
4 changes: 2 additions & 2 deletions compilers/openapi/openapi.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ func optionsFrom(opts compilers.Options) (Options, error) {

// loadOptions projects Options onto the subset the load phase reads. It exists
// so the mapping lives in one place: load.Options is that package's own input,
// deliberately not this public type, whose shape ir-design §10 fixes and most of
// which describes lowering the loader cannot see.
// deliberately not this public type, whose shape is a published contract (see
// Options) and most of which describes lowering the loader cannot see.
func loadOptions(o Options) load.Options {
out := load.Options{AllowExternalRefs: o.AllowExternalRefs}
if o.Overlay != nil {
Expand Down
4 changes: 2 additions & 2 deletions compilers/openapi/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ const (
//
// It stays whole here while each phase below takes its own input projected from
// it — load.Options, and the strategy the lowering context carries. Its shape is
// a published contract (ir-design §10), and most of it describes work no single
// phase does.
// a published contract, since a caller outside this package constructs this
// exact type by field, and most of it describes work no single phase does.
type Options struct {
// Grouping selects the operation-grouping strategy.
Grouping GroupingStrategy `json:"grouping,omitempty"`
Expand Down
Loading