specutil

Documentation

Index

• func BumpVersion(format string, file1 string, file2 string, currentVersion string) (string, error)
• type Diff
  • func DiffSpec(format string, file1 string, file2 string) (Diff, error)
  • func (d *Diff) BreakingChangeCount() int
  • func (d *Diff) MinorChangeCount() int
  • func (d *Diff) PatchChangeCount() int
• type OpenAPIDiff
  • func DiffOpenAPI(file1 string, file2 string) ([]OpenAPIDiff, error)
  • func (oad *OpenAPIDiff) IsBreakingChange() bool
  • func (oad *OpenAPIDiff) IsMinorChange() bool
  • func (oad *OpenAPIDiff) IsPatchChange() bool
  • func (oad *OpenAPIDiff) LevelAsString() string

Functions

func BumpVersion

func BumpVersion(format string, file1 string, file2 string, currentVersion string) (string, error)

Types

type Diff

type Diff struct {
	OpenAPI []OpenAPIDiff
}

func DiffSpec

func DiffSpec(format string, file1 string, file2 string) (Diff, error)

func (*Diff) BreakingChangeCount

func (d *Diff) BreakingChangeCount() int

func (*Diff) MinorChangeCount

func (d *Diff) MinorChangeCount() int

func (*Diff) PatchChangeCount

func (d *Diff) PatchChangeCount() int

type OpenAPIDiff

type OpenAPIDiff struct {
	ID          string `json:"id"`
	Text        string `json:"text"`
	Level       int    `json:"level"`
	Operation   string `json:"operation"`
	OperationID string `json:"operationId"`
	Path        string `json:"path"`
	Source      string `json:"source"`
}

func DiffOpenAPI

func DiffOpenAPI(file1 string, file2 string) ([]OpenAPIDiff, error)

DiffOpenAPI compares two OAS files and returns the differences, calls the oasdiff cli tool to retrieve the json

func (*OpenAPIDiff) IsBreakingChange

func (oad *OpenAPIDiff) IsBreakingChange() bool

func (*OpenAPIDiff) IsMinorChange

func (oad *OpenAPIDiff) IsMinorChange() bool

func (*OpenAPIDiff) IsPatchChange

func (oad *OpenAPIDiff) IsPatchChange() bool

func (*OpenAPIDiff) LevelAsString

func (oad *OpenAPIDiff) LevelAsString() string