replace

package

v0.24.0 Latest Latest Go to latest Published: Sep 26, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Details

View Source

const (
	ErrReplace        replaceError = "flatten replace error"
	ErrUnexpectedType replaceError = "unexpected type used in getPointerFromKey"
)

This section is empty.

func ErrCyclicChain(key string) error

func ErrInvalidPointerType(key string, value any, err error) error

func ErrNoParent(key string, err error) error

func ErrNoSchema(key string) error

func ErrNoSchemaWithRef(key string, value any) error

func ErrNotANumber(key string, err error) error

func ErrUnhandledContainerType(key string, value any) error

func ErrUnhandledParentRewrite(key string, value any) error

func ErrUnhandledParentType(key string, value any) error

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

RewriteSchemaToRef replaces a schema with a Ref

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

UpdateRef replaces a ref by another one

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

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

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

DeepestRefResult holds the results from DeepestRef analysis

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.

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