converter

package

v0.0.0-...-28a72a9 Latest Latest Go to latest Published: Aug 21, 2023 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Converter struct {
	Source      *os.File
	PackageName string
}

func (c *Converter) ConvertToYAML() (string, error)

ConvertToYAML converts the Source proto file to YAML format and returns it as a string

func (c *Converter) GetYAMLComment(comment *proto.Comment, indentLvl int) string

GetYAMLComment returns a properly formatted YAML comment for the given proto comment (or an empty string if the comment is nil)

func (c Converter) GetYAMLMapField(field *proto.MapField) string

GetYAMLMapField returns a YAML formatted field for a given 'normal' field

func (c Converter) GetYAMLNormalField(field *proto.NormalField) string

GetYAMLNormalField returns a YAML formatted field for a given 'normal' field

func (c *Converter) GetYAMLPreamble() string

GetYAMLPreamble emits the OpenAPI YAML schema preamble

func (c *Converter) GetYAMLTypeFromMessage(message *proto.Message) string

GetYAMLTypeFromMessage emits OpenAPI YAML type information for a proto message