openapidiff

Documentation

Index

• Variables
• func Flags() []cli.Flag
• type Differ
  • func NewClient() (Differ, error)
• type Options

Variables

var (
	DefaultOpts = Options{

		OpenAPIDiffJarFile:  utils.StringPtr(""),
		OpenAPIDiffJavaOpts: utils.StringPtr(""),
		Format:              utils.StringPtr("json"),
	}
)

Functions

func Flags

func Flags() []cli.Flag

Types

type Differ

type Differ interface {
	DiffDocuments(oldDoc, newDoc models.SpecDoc, cfg *diff.Config, opts *Options) (*diff.Result, error)
}

func NewClient

func NewClient() (Differ, error)

type Options

type Options struct {
	OpenAPIDiffJarFile  *string // file path of the OpenAPI JAR file, set by Flags
	OpenAPIDiffJavaOpts *string // Java options for running openapi-diff, e.g. -Xms512m -Xmx1024m, set by Flags
	Format              *string // format to use for outputting results [string] [choices: "html", "json", "markdown", "html", "text"] [default: "json"]
}