CreateClosedAPIIndexConfig is a helper function to create a new SpecIndexConfig with the AllowRemoteLookup and AllowFileLookup set to false.

CreateOpenAPIIndexConfig is a helper function to create a new SpecIndexConfig with the AllowRemoteLookup and AllowFileLookup set to true.

ExtractFileType returns the file extension of the reference.

NewLocalFSWithConfig creates a new LocalFS with the supplied configuration.

NewRemoteFSWithConfig creates a new RemoteFS using the supplied SpecIndexConfig.

NewRemoteFSWithRootURL creates a new RemoteFS using the supplied root URL.

NewResolver will create a new resolver from a *index.SpecIndex.

NewRolodex creates a new rolodex with the provided index configuration.

NewSpecIndex will create a new index of an OpenAPI or Swagger spec.

NewSpecIndexWithConfig will create a new index of an OpenAPI or Swagger spec.

CircularReferenceResult contains a circular reference found when traversing the graph.

DescriptionReference holds data about a description that was found and where it was found.

IndexingError holds data about something that went wrong during indexing.

LocalFile is a file that has been indexed by the LocalFS.

LocalFS is a file system that indexes local files.

LocalFSConfig is the configuration for the LocalFS.

NodeOrigin represents where a node has come from within a specification.

Reference is a wrapper around *yaml.Node results to make things more manageable when performing algorithms on data models.

ReferenceMapped is a helper struct for mapped references put into sequence (we lose the key).

RemoteFile is a file that has been indexed by the RemoteFS.

RemoteFS is a file system that indexes remote files.

Resolver will use a *index.SpecIndex to stitch together a resolved root tree using all the discovered references in the doc.

ResolvingError represents an issue the resolver had trying to stitch the tree together.

Rolodex is a file system abstraction that allows for the indexing of multiple file systems and the ability to resolve references across those file systems.

SpecIndex is a complete pre-computed index of the entire specification.

SpecIndexConfig is a configuration struct for the SpecIndex introduced in 0.6.0 that provides an expandable set of granular options.

CanBeIndexed is an interface that allows a file to be indexed.

RolodexFile is an interface that represents a file in the rolodex.

RolodexFS is an interface that represents a RolodexFS, is the same interface as `fs.FS`, except it also exposes a GetFiles() signature, to extract all files in the FS.

ExternalLookupFunction is for lookup functions that take a JSONSchema reference and tries to find that node in the URI based document.

FileExtension is the type of file extension.