raml08openapi3

Documentation

Index

• Constants
• Variables
• func ReadFileOperations(filename string) (*openapi3.OperationMores, error)

Constants

const (
	RAMLKeyDescription = "description"
	RAMLKeyDisplayName = "displayName"
)

Variables

var (
	ErrOperationMoreSetMissing  = errors.New("required parameter operationSetMore is empty")
	ErrRAMLDescriptionNotString = errors.New("format for RAML description is not string")
	ErrRAMLDispNameNotString    = errors.New("format for RAML description is not string")
)

Functions

func ReadFileOperations

func ReadFileOperations(filename string) (*openapi3.OperationMores, error)

ReadFileOperations reads a RAML v0.8 file and returns a set of `openapi3edit.OperationMore` structs. The properties `path`, `method`, `summary`, `description` are populated. OpenAPI `summary` is populated by the `displayName` property. Currently, this reads a JSON formatted file into a map[string]interface. This is useful after converting a RAML v0.8 spec using https://github.com/daviemakz/oas-raml-converter-cli.