mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-09 12:37:49 +00:00
50c1d80563
This allows vacuum to operate outside of the OpenAPI world. Exciting! Signed-off-by: Dave Shanley <dave@quobix.com>
58 lines
2.3 KiB
Go
58 lines
2.3 KiB
Go
// Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package datamodel
|
|
|
|
import (
|
|
"net/http"
|
|
"net/url"
|
|
)
|
|
|
|
// DocumentConfiguration is used to configure the document creation process. It was added in v0.6.0 to allow
|
|
// for more fine-grained control over controls and new features.
|
|
//
|
|
// The default configuration will set AllowFileReferences to false and AllowRemoteReferences to false, which means
|
|
// any non-local (local being the specification, not the file system) references, will be ignored.
|
|
type DocumentConfiguration struct {
|
|
// The BaseURL will be the root from which relative references will be resolved from if they can't be found locally.
|
|
// Schema must be set to "http/https".
|
|
BaseURL *url.URL
|
|
|
|
// RemoteURLHandler is a function that will be used to retrieve remote documents. If not set, the default
|
|
// remote document getter will be used.
|
|
// Resolves [#132]: https://github.com/pb33f/libopenapi/issues/132
|
|
RemoteURLHandler func(url string) (*http.Response, error)
|
|
|
|
// If resolving locally, the BasePath will be the root from which relative references will be resolved from.
|
|
// It's usually the location of the root specification.
|
|
BasePath string // set the Base Path for resolving relative references if the spec is exploded.
|
|
|
|
// AllowFileReferences will allow the index to locate relative file references. This is disabled by default.
|
|
AllowFileReferences bool
|
|
|
|
// AllowRemoteReferences will allow the index to lookup remote references. This is disabled by default.
|
|
AllowRemoteReferences bool
|
|
|
|
// AvoidIndexBuild will avoid building the index. This is disabled by default, only use if you are sure you don't need it.
|
|
// This is useful for developers building out models that should be indexed later on.
|
|
AvoidIndexBuild bool
|
|
|
|
// BypassDocumentCheck will bypass the document check. This is disabled by default. This will allow any document to
|
|
// passed in and used. Only enable this when parsing non openapi documents.
|
|
BypassDocumentCheck bool
|
|
}
|
|
|
|
func NewOpenDocumentConfiguration() *DocumentConfiguration {
|
|
return &DocumentConfiguration{
|
|
AllowFileReferences: true,
|
|
AllowRemoteReferences: true,
|
|
}
|
|
}
|
|
|
|
func NewClosedDocumentConfiguration() *DocumentConfiguration {
|
|
return &DocumentConfiguration{
|
|
AllowFileReferences: false,
|
|
AllowRemoteReferences: false,
|
|
}
|
|
}
|