config

README

sdk-gen-config

Documentation

Index

• Constants
• Variables
• func Save(dir string, cfg *Config, opts ...Option) error
• type Config
  • func GetDefaultConfig(getLangDefaultFunc GetLanguageDefaultFunc, langs ...string) (*Config, error)
  • func Load(dir string, opts ...Option) (*Config, error)
• type Force
• type GenerateOn
• type GenerateWorkflow
• type Generation
• type GetLanguageDefaultFunc
• type Inputs
• type Job
• type Jobs
• type LanguageConfig
• type Management
• type Option
  • func WithFileSystemFuncs(rf ReadFileFunc, wf WriteFileFunc) Option
  • func WithLanguageDefaultFunc(f GetLanguageDefaultFunc) Option
  • func WithLanguages(langs ...string) Option
  • func WithUpgradeFunc(f UpgradeFunc) Option
• type Permissions
• type PublishOn
• type PublishWorkflow
• type Push
• type ReadFileFunc
• type Schedule
• type SdkGenConfig
• type SdkGenConfigField
• type UpgradeFunc
• type WorkflowDispatch
• type WriteFileFunc

Constants

const (
	Version               = "1.0.0"
	GithubWritePermission = "write"

	BaseServerURL                   = "baseServerUrl"
	SDKClassName                    = "sdkClassName"
	SingleTagPerOp                  = "singleTagPerOp"
	TagNamespacingDisabled          = "tagNamespacingDisabled"
	Languages                       = "languages"
	Mode                            = "mode"
	GithubAccessToken               = "github_access_token"
	SpeakeasyApiKey                 = "speakeasy_api_key"
	OpenAPIDocAuthHeader            = "openapi_doc_auth_header"
	OpenAPIDocAuthToken             = "openapi_doc_auth_token"
	OpenAPIDocs                     = "openapi_docs"
	OmitDescriptionIfSummaryPresent = "omitDescriptionIfSummaryPresent"
	DisableComments                 = "disableComments"
)

Variables

var CommentFields = []string{DisableComments, OmitDescriptionIfSummaryPresent}

var ErrFailedUpgrade = errors.New("failed to upgrade config")

var ErrNotFound = errors.New("could not find gen.yaml")

Functions

func Save

func Save(dir string, cfg *Config, opts ...Option) error

Types

type Config

type Config struct {
	ConfigVersion string                    `yaml:"configVersion"`
	Management    *Management               `yaml:"management,omitempty"`
	Generation    Generation                `yaml:"generation"`
	Languages     map[string]LanguageConfig `yaml:",inline"`
}

func GetDefaultConfig

func GetDefaultConfig(getLangDefaultFunc GetLanguageDefaultFunc, langs ...string) (*Config, error)

func Load

func Load(dir string, opts ...Option) (*Config, error)

type Force

type Force struct {
	Description string `yaml:"description"`
	Type        string `yaml:"type"`
	Default     bool   `yaml:"default"`
}

type GenerateOn

type GenerateOn struct {
	WorkflowDispatch WorkflowDispatch `yaml:"workflow_dispatch"`
	Schedule         []Schedule       `yaml:"schedule,omitempty"`
}

type GenerateWorkflow

type GenerateWorkflow struct {
	Name        string            `yaml:"name"`
	Env         map[string]string `yaml:"env,omitempty"`
	Permissions Permissions       `yaml:"permissions"`
	On          GenerateOn        `yaml:"on"`
	Jobs        Jobs              `yaml:"jobs"`
}

type Generation

type Generation struct {
	CommentFields map[string]bool `yaml:"comments,omitempty"`
	Fields        map[string]any  `yaml:",inline"`
}

type GetLanguageDefaultFunc

type GetLanguageDefaultFunc func(string) (*LanguageConfig, error)

type Inputs

type Inputs struct {
	Force Force `yaml:"force"`
}

type Job

type Job struct {
	Uses    string            `yaml:"uses"`
	With    map[string]any    `yaml:"with"`
	Secrets map[string]string `yaml:"secrets"`
}

type Jobs

type Jobs struct {
	Generate Job `yaml:"generate,omitempty"`
	Publish  Job `yaml:"publish,omitempty"`
}

type LanguageConfig

type LanguageConfig struct {
	Version string         `yaml:"version"`
	Cfg     map[string]any `yaml:",inline"`
}

type Management

type Management struct {
	DocChecksum       string `yaml:"docChecksum"`
	DocVersion        string `yaml:"docVersion"`
	SpeakeasyVersion  string `yaml:"speakeasyVersion"`
	GenerationVersion string `yaml:"generationVersion,omitempty"`
}

type Option

type Option func(*options)

func WithFileSystemFuncs

func WithFileSystemFuncs(rf ReadFileFunc, wf WriteFileFunc) Option

func WithLanguageDefaultFunc

func WithLanguageDefaultFunc(f GetLanguageDefaultFunc) Option

func WithLanguages

func WithLanguages(langs ...string) Option

func WithUpgradeFunc

func WithUpgradeFunc(f UpgradeFunc) Option

type Permissions

type Permissions struct {
	Checks       string `yaml:"checks"`
	Contents     string `yaml:"contents,omitempty"`
	PullRequests string `yaml:"pull-requests,omitempty"`
	Statuses     string `yaml:"statuses"`
}

type PublishOn

type PublishOn struct {
	Push Push `yaml:"push"`
}

type PublishWorkflow

type PublishWorkflow struct {
	Name string            `yaml:"name"`
	Env  map[string]string `yaml:"env,omitempty"`
	On   PublishOn         `yaml:"on"`
	Jobs Jobs              `yaml:"jobs"`
}

type Push

type Push struct {
	Branches []string `yaml:"branches"`
	Paths    []string `yaml:"paths"`
}

type ReadFileFunc

type ReadFileFunc func(filename string) ([]byte, error)

type Schedule

type Schedule struct {
	Cron string `yaml:"cron"`
}

type SdkGenConfig

type SdkGenConfig struct {
	SdkGenLanguageConfig map[string][]SdkGenConfigField `json:"language_configs"`
	SdkGenCommonConfig   []SdkGenConfigField            `json:"common_config"`
}

type SdkGenConfigField

type SdkGenConfigField struct {
	Name                  string  `yaml:"name" json:"name"`
	Required              bool    `yaml:"required" json:"required"`
	RequiredForPublishing *bool   `yaml:"requiredForPublishing,omitempty" json:"required_for_publishing,omitempty"`
	DefaultValue          *any    `yaml:"defaultValue,omitempty" json:"default_value,omitempty"`
	Description           *string `yaml:"description,omitempty" json:"description,omitempty"`
	Language              *string `yaml:"language,omitempty" json:"language,omitempty"`
	SecretName            *string `yaml:"secretName,omitempty" json:"secret_name,omitempty"`
	ValidationRegex       *string `yaml:"validationRegex,omitempty" json:"validation_regex,omitempty"`
	ValidationMessage     *string `yaml:"validationMessage,omitempty" json:"validation_message,omitempty"`
}

type UpgradeFunc

type UpgradeFunc func(lang, oldVersion, newVersion string, cfg map[string]any) (map[string]any, error)

type WorkflowDispatch

type WorkflowDispatch struct {
	Inputs Inputs `yaml:"inputs"`
}

type WriteFileFunc

type WriteFileFunc func(filename string, data []byte, perm os.FileMode) error