exporter

Documentation

Index

• func SyslRefToJSONSchema(syslRef string) string
• type EndpointExporter
• type Exporter
• type OpenAPI3Exporter
  • func MakeOpenAPI3Exporter(apps map[string]*syslwrapper.App, logger *logrus.Logger) *OpenAPI3Exporter
  • func (s *OpenAPI3Exporter) Export() error
  • func (s *OpenAPI3Exporter) GenerateOpenAPI3(app *syslwrapper.App) (*openapi3.Swagger, error)
  • func (s *OpenAPI3Exporter) SerializeOutput(appName string, mode string) ([]byte, error)
• type SwaggerExporter
  • func MakeSwaggerExporter(app *proto.Application, logger *logrus.Logger) *SwaggerExporter
  • func (s *SwaggerExporter) GenerateSwagger() error
  • func (s *SwaggerExporter) SerializeOutput(mode string) ([]byte, error)
• type TransformExporter
  • func MakeTransformExporter(fs afero.Fs, logger *logrus.Logger, rootPath, outPath, transformName string) *TransformExporter
  • func (e *TransformExporter) ExportApp(*sysl.Application) error
  • func (e *TransformExporter) ExportFile(modules []*sysl.Module, modulePaths []string) error
  • func (e *TransformExporter) ExportToWriter(w io.Writer, modules []*sysl.Module, modulePaths []string) error
• type TypeExporter

Functions

func SyslRefToJSONSchema

func SyslRefToJSONSchema(syslRef string) string

Types

type EndpointExporter

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

type Exporter

type Exporter interface {
	// ExportFile reads in a Sysl file from path, converts it to the output format, and writes it to
	// the file system.
	ExportFile(path string) error
	// ExportApp takes a Sysl app, converts it to the output format, and writes it to the file
	// system.
	ExportApp(app *sysl.Application) error
}

Exporter is an interface implemented by all Sysl exporters.

type OpenAPI3Exporter

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

func MakeOpenAPI3Exporter

func MakeOpenAPI3Exporter(apps map[string]*syslwrapper.App, logger *logrus.Logger) *OpenAPI3Exporter

func (*OpenAPI3Exporter) Export

func (s *OpenAPI3Exporter) Export() error

func (*OpenAPI3Exporter) GenerateOpenAPI3

func (s *OpenAPI3Exporter) GenerateOpenAPI3(app *syslwrapper.App) (*openapi3.Swagger, error)

func (*OpenAPI3Exporter) SerializeOutput

func (s *OpenAPI3Exporter) SerializeOutput(appName string, mode string) ([]byte, error)

type SwaggerExporter

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

func MakeSwaggerExporter

func MakeSwaggerExporter(app *proto.Application, logger *logrus.Logger) *SwaggerExporter

func (*SwaggerExporter) GenerateSwagger

func (s *SwaggerExporter) GenerateSwagger() error

func (*SwaggerExporter) SerializeOutput

func (s *SwaggerExporter) SerializeOutput(mode string) ([]byte, error)

type TransformExporter

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

TransformExporter enables exporting into various formats by running embedded arr.ai transform scripts that convert Sysl.

func MakeTransformExporter

func MakeTransformExporter(
	fs afero.Fs,
	logger *logrus.Logger,
	rootPath, outPath,
	transformName string,
) *TransformExporter

func (*TransformExporter) ExportApp

func (e *TransformExporter) ExportApp(*sysl.Application) error

func (*TransformExporter) ExportFile

func (e *TransformExporter) ExportFile(modules []*sysl.Module, modulePaths []string) error

ExportFile reads in a Sysl file from path, converts it to the output format, and writes it to the file system.

func (*TransformExporter) ExportToWriter

func (e *TransformExporter) ExportToWriter(w io.Writer, modules []*sysl.Module, modulePaths []string) error

type TypeExporter

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