revision

Documentation

Index

• type Reviser
  • func NewReviser(interfaceOrBytes model.InterfaceOrBytes, desiredVersion string) (upgrader Reviser, err error)
  • func (u *Reviser) GetModelVersion() string
  • func (u *Reviser) GetRevisedBytes(ext string) (bytes []byte, err error)
  • func (u *Reviser) GetRevisedJsonMap() map[string]interface{}
  • func (u *Reviser) Revise() (err error)
• type RevisionOptions
• type RevisionResponse
  • func RevisionCommand(opts *RevisionOptions) (revisionResponse RevisionResponse, err error)

Types

type Reviser

type Reviser struct {
	validation.Validator
	// contains filtered or unexported fields
}

func NewReviser

func NewReviser(interfaceOrBytes model.InterfaceOrBytes, desiredVersion string) (upgrader Reviser, err error)

NewReviser returns an upgrader with a validator created from the desired version.

func (*Reviser) GetModelVersion

func (u *Reviser) GetModelVersion() string

GetModelVersion returns the version of the model being upgraded.

func (*Reviser) GetRevisedBytes

func (u *Reviser) GetRevisedBytes(ext string) (bytes []byte, err error)

GetRevisedBytes returns the upgraded model as bytes, marshalled to the desired extension.

func (*Reviser) GetRevisedJsonMap

func (u *Reviser) GetRevisedJsonMap() map[string]interface{}

GetRevisedJsonMap sets the upgraded model.

func (*Reviser) Revise

func (u *Reviser) Revise() (err error)

type RevisionOptions

type RevisionOptions struct {
	InputFile        string // filepath json or yaml
	OutputFile       string // filepath json or yaml
	Version          string // OSCAL version X.X.X
	ValidationResult string // filepath json or yaml
}

type RevisionResponse

type RevisionResponse struct {
	Reviser      Reviser
	Result       validation.ValidationResult
	Warnings     []string
	RevisedBytes []byte
}

func RevisionCommand

func RevisionCommand(opts *RevisionOptions) (revisionResponse RevisionResponse, err error)

RevisionCommand Runs the revision and returns the revision response For Consumers, this method assumes no ReviseOptions defaults. All defaults are handled in the cobra command.