replace

Documentation

Index

• func RewriteSchemaToRef(sp *spec.Swagger, key string, ref spec.Ref) error
• func UpdateRef(sp interface{}, key string, ref spec.Ref) error
• func UpdateRefWithSchema(sp *spec.Swagger, key string, sch *spec.Schema) error
• type DeepestRefResult
  • func DeepestRef(sp *spec.Swagger, opts *spec.ExpandOptions, ref spec.Ref) (*DeepestRefResult, error)

Functions

func RewriteSchemaToRef

func RewriteSchemaToRef(sp *spec.Swagger, key string, ref spec.Ref) error

RewriteSchemaToRef replaces a schema with a Ref

func UpdateRef

func UpdateRef(sp interface{}, key string, ref spec.Ref) error

UpdateRef replaces a ref by another one

func UpdateRefWithSchema

func UpdateRefWithSchema(sp *spec.Swagger, key string, sch *spec.Schema) error

UpdateRefWithSchema replaces a ref with a schema (i.e. re-inline schema)

Types

type DeepestRefResult

type DeepestRefResult struct {
	Ref      spec.Ref
	Schema   *spec.Schema
	Warnings []string
}

DeepestRefResult holds the results from DeepestRef analysis

func DeepestRef

func DeepestRef(sp *spec.Swagger, opts *spec.ExpandOptions, ref spec.Ref) (*DeepestRefResult, error)

DeepestRef finds the first definition ref, from a cascade of nested refs which are not definitions.

• if no definition is found, returns the deepest ref.
• pointers to external files are expanded

NOTE: all external $ref's are assumed to be already expanded at this stage.