template

Documentation

Index

• func GetTitle(old string) string
• type ActionGroup
• type ServiceMethod
• type WorkatoTemplate
  • func FromGenDoc(template *gendoc.Template, cfg *config.Config) (*WorkatoTemplate, error)

Functions

func GetTitle

func GetTitle(old string) string

GetTitle converts a joined word in multiple words, lower-cased Example: GetStatus -> Get status

Types

type ActionGroup

type ActionGroup struct {
	Name    string
	Title   string
	Actions []*ServiceMethod
}

ActionGroup is a grouped set of actions with sub actions

type ServiceMethod

type ServiceMethod struct {
	Service *gendoc.Service
	Method  *gendoc.ServiceMethod
}

ServiceMethod is a combined service and method defintion

type WorkatoTemplate

type WorkatoTemplate struct {

	// Name is the name of the connector
	Name string
	// AppBaseURl is the base URL to connect to for the application
	AppBaseURL string
	// DeveloperDocsURL is the URL to view the API docs on
	DeveloperDocsURL string

	// ObjectDefinitions are Workato formatted definitions of messages
	ObjectDefinitions []*schema.ObjectDefinition
	// Actions are Workato formatted defintions of grouped methods
	Actions []*schema.ActionDefinition
	// Picklists are Workato formatted definitions of enums and action groups
	Picklists []*schema.PicklistDefinition
	Methods   []*schema.MethodDefinition

	// Triggers are Workato formatted definitions of grouped triggers
	Triggers []*schema.TriggerDefinition
	// contains filtered or unexported fields
}

WorkatoTemplate is an interface to use when rendering a workato connector https://docs.workato.com/developing-connectors/sdk/sdk-reference.html

func FromGenDoc

func FromGenDoc(template *gendoc.Template, cfg *config.Config) (*WorkatoTemplate, error)

FromGenDoc converts a protoc-gen-doc template to our template file