openapidiff

package
v0.0.0-...-4d495be Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 22, 2022 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
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"]
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL