aggregator

Documentation

Index

• func FilterSpecByPaths(sp *spec.Swagger, keepPathPrefixes []string)
• func FilterSpecByPathsWithoutSideEffects(sp *spec.Swagger, keepPathPrefixes []string) *spec.Swagger
• func MergeSpecs(dest, source *spec.Swagger) error
• func MergeSpecsFailOnDefinitionConflict(dest, source *spec.Swagger) error
• func MergeSpecsIgnorePathConflict(dest, source *spec.Swagger) error

Functions

func FilterSpecByPaths

func FilterSpecByPaths(sp *spec.Swagger, keepPathPrefixes []string)

FilterSpecByPaths removes unnecessary paths and definitions used by those paths. i.e. if a Path removed by this function, all definitions used by it and not used anywhere else will also be removed.

func FilterSpecByPathsWithoutSideEffects

func FilterSpecByPathsWithoutSideEffects(sp *spec.Swagger, keepPathPrefixes []string) *spec.Swagger

FilterSpecByPathsWithoutSideEffects removes unnecessary paths and definitions used by those paths. i.e. if a Path removed by this function, all definitions used by it and not used anywhere else will also be removed. It does not modify the input, but the output shares data structures with the input.

func MergeSpecs

func MergeSpecs(dest, source *spec.Swagger) error

MergeSpecs copies paths and definitions from source to dest, rename definitions if needed. dest will be mutated, and source will not be changed. It will fail on path conflicts. The source is not mutated.

func MergeSpecsFailOnDefinitionConflict

func MergeSpecsFailOnDefinitionConflict(dest, source *spec.Swagger) error

MergeSpecsFailOnDefinitionConflict is differ from MergeSpecs as it fails if there is a definition conflict. The source is not mutated.

func MergeSpecsIgnorePathConflict

func MergeSpecsIgnorePathConflict(dest, source *spec.Swagger) error

MergeSpecsIgnorePathConflict is the same as MergeSpecs except it will ignore any path conflicts by keeping the paths of destination. It will rename definition conflicts. The source is not mutated.