Skip to content

v0.6.0

Choose a tag to compare

@daveshanley daveshanley released this 22 Feb 14:17
· 1236 commits to main since this release

v0.6.0 Addresses issue #73 by introducing some enhancements to the index, allowing for relative file handling, and providing a fix to auto-allowing remote and local files to be followed.

A new configuration option is available to document creation for an Index. It's defined as index.SpecIndexConfig and provides three properties:

  • BaseURL of type *url.URL
  • AllowRemoteLookup of type bool
  • AllowFileLookup of type bool

This can be used to configure an index to know where to look when encountering relative paths and if to allow them at all.

Full documentation can be found here.

When creating a new Document, there is also a new datamodel.DocumentConfigutation, which looks almost identical, except
for the Lookup postfix has been replaced with References

config := datamodel.DocumentConfiguration{
		AllowFileReferences:   true,
		AllowRemoteReferences: true,
		BaseURL:               baseURL,
	}

This new config can be used with a new function called NewDocumentWithConfiguration() that is the same as NewDocument() except it has a second argument for accepting the config.

doc, err := NewDocumentWithConfiguration(digitalOcean, &config)

Full documentation can be found here.

The index has been refactored a little to help make it easier to navigate and tuned up to run faster when indexing references.

The digital ocean spec has been added for testing purposes.