README
¶
openapi
This repository provides support for traversing openapi documents as parsed by https://github.com/getkin/kin-openapi and also for performing various transformations on those documents to work around inconsistent/incorrect schemas (see the transforms package). Such schemas are often generated by schema generator tools that generate specifications from existing code/APIs.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Visitor ¶
Visitor is called for every node in the walk. It returns true for the walk to continue, false otherwise. The walk will stop when an error is returned.
type Walker ¶
Walker represents the interface implemented by all walkers.
func NewWalker ¶
func NewWalker(v Visitor, opts ...WalkerOption) Walker
NewWalker returns a Walker that will visit every node in an openapi3 document.
type WalkerOption ¶
type WalkerOption func(o *walkerOptions)
WalkerOption represents an option for use when creating a new walker.
func WalkerFollowRefs ¶
func WalkerFollowRefs(v bool) WalkerOption
WalkerFollowRefs controls wether the walker will follow $ref's and flatten them in place.
func WalkerTracePaths ¶
func WalkerTracePaths(v bool) WalkerOption
func WalkerVisitPrefix ¶
func WalkerVisitPrefix(path ...string) WalkerOption
WalkerVisitPrefix adds a prefix that the walk should call the Visitor function for. All other paths will be ignored.
Source Files
Directories