converter

Documentation

Index

• type Converter
  • func New(logger *logrus.Logger) *Converter
  • func (c *Converter) ConvertFrom(rd io.Reader) (*plugin.CodeGeneratorResponse, error)
• type ConverterFlags
• type ProtoPackage

Types

type Converter

type Converter struct {
	Flags ConverterFlags
	// contains filtered or unexported fields
}

Converter is everything you need to convert protos to JSONSchemas:

func New

func New(logger *logrus.Logger) *Converter

New returns a configured *Converter (defaulting to draft-04 version):

func (*Converter) ConvertFrom

func (c *Converter) ConvertFrom(rd io.Reader) (*plugin.CodeGeneratorResponse, error)

ConvertFrom tells the convert to work on the given input:

type ConverterFlags

type ConverterFlags struct {
	AllFieldsRequired            bool
	AllowNullValues              bool
	DisallowAdditionalProperties bool
	DisallowBigIntsAsStrings     bool
	EnforceOneOf                 bool
	EnumsAsConstants             bool
	EnumsAsStringsOnly           bool
	EnumsTrimPrefix              bool
	KeepNewLinesInDescription    bool
	PrefixSchemaFilesWithPackage bool
	UseJSONFieldnamesOnly        bool
	UseProtoAndJSONFieldNames    bool
}

ConverterFlags control the behaviour of the converter:

type ProtoPackage

type ProtoPackage struct {
	// contains filtered or unexported fields
}

ProtoPackage describes a package of Protobuf, which is an container of message types.