@@ -19,7 +19,6 @@ import (
1919 "log"
2020 "net/http"
2121 "net/url"
22- "os"
2322 slashpath "path"
2423 "path/filepath"
2524 "sort"
@@ -34,18 +33,25 @@ import (
3433)
3534
3635// FlattenOpts configuration for flattening a swagger specification.
36+ //
37+ // The BasePath parameter is used to locate remote relative $ref found in the specification.
38+ // This path is a file: it points to the location of the root document and may be either a local
39+ // file path or a URL.
40+ //
41+ // If none specified, relative references (e.g. "$ref": "folder/schema.yaml#/definitions/...")
42+ // found in the spec are searched from the current working directory.
3743type FlattenOpts struct {
3844 Spec * Spec // The analyzed spec to work with
3945 flattenContext * context // Internal context to track flattening activity
4046
41- BasePath string
47+ BasePath string // The location of the root document for this spec to resolve relative $ref
4248
4349 // Flattening options
44- Expand bool // If Expand is true, we skip flattening the spec and expand it instead
45- Minimal bool
46- Verbose bool
47- RemoveUnused bool
48- ContinueOnError bool // Continues when facing some issues
50+ Expand bool // When true, skip flattening the spec and expand it instead (if Minimal is false)
51+ Minimal bool // When true, do not decompose complex structures such as allOf
52+ Verbose bool // enable some reporting on possible name conflicts detected
53+ RemoveUnused bool // When true, remove unused parameters, responses and definitions after expansion/flattening
54+ ContinueOnError bool // Continue when spec expansion issues are found
4955
5056 /* Extra keys */
5157 _ struct {} // require keys
@@ -91,6 +97,7 @@ func newContext() *context {
9197//
9298// There is a minimal and a full flattening mode.
9399//
100+ //
94101// Minimally flattening a spec means:
95102// - Expanding parameters, responses, path items, parameter items and header items (references to schemas are left
96103// unscathed)
@@ -105,6 +112,8 @@ func newContext() *context {
105112// NOTE: arbitrary JSON pointers (other than $refs to top level definitions) are rewritten as definitions if they
106113// represent a complex schema or express commonality in the spec.
107114// Otherwise, they are simply expanded.
115+ // Self-referencing JSON pointers cannot resolve to a type and trigger an error.
116+ //
108117//
109118// Minimal flattening is necessary and sufficient for codegen rendering using go-swagger.
110119//
@@ -137,15 +146,6 @@ func newContext() *context {
137146//
138147func Flatten (opts FlattenOpts ) error {
139148 debugLog ("FlattenOpts: %#v" , opts )
140- // Make sure opts.BasePath is an absolute path
141- if ! filepath .IsAbs (opts .BasePath ) {
142- cwd , _ := os .Getwd ()
143- opts .BasePath = filepath .Join (cwd , opts .BasePath )
144- }
145- // make sure drive letter on windows is normalized to lower case
146- u , _ := url .Parse (opts .BasePath )
147- opts .BasePath = u .String ()
148-
149149 opts .flattenContext = newContext ()
150150
151151 // recursively expand responses, parameters, path items and items in simple schemas.
@@ -180,6 +180,7 @@ func Flatten(opts FlattenOpts) error {
180180 // This inlining deals with name conflicts by introducing auto-generated names ("OAIGen")
181181 var err error
182182 if imported , err = importExternalReferences (& opts ); err != nil {
183+ debugLog ("error in importExternalReferences: %v" , err )
183184 return err
184185 }
185186 opts .Spec .reload () // re-analyze
0 commit comments