config

package module

Go to main page

Versions in this module

v1

v1.24.0

Sep 24, 2024

Changes in this version

type LockFile

+ AST string

type Management

+ ASTVersion string

v1.23.5

Oct 8, 2024

v1.23.4

Oct 4, 2024

Changes in this version

type Management

+ GenerationTimestamp string

type PublishOn

+ WorkflowDispatch WorkflowDispatchEmpty

+ type WorkflowDispatchEmpty struct

v1.23.3

Sep 27, 2024

v1.23.2

Sep 24, 2024

v1.23.1

Sep 18, 2024

v1.23.0

Sep 16, 2024

v1.22.0

Sep 13, 2024

v1.21.1

Sep 12, 2024

v1.21.0

Sep 9, 2024

v1.20.0

Sep 5, 2024

Changes in this version

+ type Examples = *orderedmap.OrderedMap[string, *orderedmap.OrderedMap[string, OperationExamples]]

type LockFile

+ Examples Examples

+ type OperationExamples struct

+ Parameters *ParameterExamples

+ RequestBody *orderedmap.OrderedMap[string, yaml.Node]

+ Responses *orderedmap.OrderedMap[string, *orderedmap.OrderedMap[string, yaml.Node]]

+ type ParameterExamples struct

+ Header *orderedmap.OrderedMap[string, yaml.Node]

+ Path *orderedmap.OrderedMap[string, yaml.Node]

+ Query *orderedmap.OrderedMap[string, yaml.Node]

v1.19.0

Aug 15, 2024

Changes in this version

type Generation

+ MockServer *MockServer

+ type MockServer struct

+ Disabled bool

v1.18.0

Aug 15, 2024

v1.17.1

Aug 12, 2024

v1.17.0

Jul 30, 2024

v1.16.2

Jul 11, 2024

v1.16.1

Jul 9, 2024

v1.16.0

Jul 8, 2024

Changes in this version

type Option

+ func WithValidateFunc(f ValidateFunc) Option

+ type ValidateFunc func(Config) error

v1.15.4

Jul 1, 2024

v1.15.3

Jul 1, 2024

v1.15.2

Jun 30, 2024

v1.15.1

Jun 30, 2024

v1.15.0

Jun 20, 2024

Changes in this version

type Inputs

+ Target *Target

+ type Target struct

+ Description string

+ Type string

v1.14.12

Jun 19, 2024

Changes in this version

type Inputs

+ SetVersion *SetVersion

+ type SetVersion struct

+ Description string

+ Type string

v1.14.11

Jun 17, 2024

Changes in this version

type Inputs

+ PushCodeSamplesOnly *PushCodeSamplesOnly

type Jobs

+ Tag Job

+ type PushCodeSamplesOnly struct

+ Default bool

+ Description string

+ Type string

+ type TagOn struct

+ Push Push

+ WorkflowDispatch WorkflowDispatchTagging

+ type TaggingWorkflow struct

+ Jobs Jobs

+ Name string

+ On TagOn

+ Permissions Permissions

+ type WorkflowDispatchTagging struct

v1.14.10

Jun 14, 2024

v1.14.10-alpha

Jun 15, 2024

v1.14.9

Jun 14, 2024

v1.14.8

Jun 14, 2024

Changes in this version

+ const DefaultGithubTokenSecretName

+ const DefaultSpeakeasyAPIKeySecretName

+ func FormatGithubSecret(secret string) string

+ func FormatGithubSecretName(name string) string

type GenerateWorkflow

+ func DefaultGenerationFile() *GenerateWorkflow

v1.14.7

Jun 11, 2024

v1.14.6

Jun 7, 2024

v1.14.5

Jun 4, 2024

v1.14.4

May 31, 2024

v1.14.3

May 23, 2024

v1.14.2

May 1, 2024

v1.14.1

Apr 30, 2024

Changes in this version

type Fixes

+ MethodSignaturesApr2024 bool

v1.14.0

Apr 26, 2024

Changes in this version

type PublishWorkflow

+ Permissions Permissions

v1.13.0

Apr 25, 2024

v1.12.0

Apr 23, 2024

v1.11.7

Apr 22, 2024

v1.11.6

Apr 22, 2024

v1.11.5

Apr 22, 2024

v1.11.4

Apr 19, 2024

v1.11.3

Apr 18, 2024

v1.11.2

Apr 18, 2024

v1.11.1

Apr 17, 2024

v1.11.0

Apr 16, 2024

v1.10.2

Apr 11, 2024

v1.10.1

Apr 10, 2024

v1.10.0

Apr 10, 2024

Changes in this version

+ func FindConfigFile(dir string, fileSystem FS) (*workspace.FindWorkspaceResult, error)

+ type FS interface

+ WriteFile func(name string, data []byte, perm os.FileMode) error

type Option

+ func WithDontWrite() Option

+ func WithFileSystem(fs FS) Option

v1.9.3

Apr 2, 2024

v1.9.2

Mar 29, 2024

v1.9.1

Mar 20, 2024

v1.9.0

Mar 20, 2024

v1.8.1

Mar 19, 2024

v1.8.0

Mar 19, 2024

v1.7.5

Feb 27, 2024

v1.7.4

Feb 27, 2024

v1.7.3

Feb 23, 2024

Changes in this version

+ type Auth struct

+ OAuth2ClientCredentialsEnabled bool

type Generation

+ Auth *Auth

v1.7.2

Feb 12, 2024

v1.7.1

Feb 8, 2024

v1.7.0

Feb 8, 2024

Changes in this version

type Config

+ ConfigPath string

v1.6.5

Feb 5, 2024

v1.6.4

Feb 5, 2024

Changes in this version

type Fixes

+ RequestResponseComponentNamesFeb2024 bool

v1.6.3

Feb 1, 2024

Changes in this version

type Fixes

+ ParameterOrderingFeb2024 bool

v1.6.2

Feb 1, 2024

v1.6.1

Jan 12, 2024

Changes in this version

+ func GetTemplateVersion(dir, target string, opts ...Option) (string, error)

v1.6.0

Jan 11, 2024

v1.5.1

Jan 5, 2024

v1.5.0

Dec 21, 2023

Changes in this version

+ func GetConfigChecksum(dir string, opts ...Option) (string, error)

+ func SaveConfig(dir string, cfg *Configuration, opts ...Option) error

+ func SaveLockFile(dir string, lockFile *LockFile, opts ...Option) error

type Config

+ Config *Configuration

+ LockFile *LockFile

+ type Configuration struct

+ ConfigVersion string

+ Generation Generation

+ Languages map[string]LanguageConfig

+ New map[string]bool

+ func (c *Configuration) GetGenerationFieldsMap() (map[string]any, error)

+ type LockFile struct

+ AdditionalProperties map[string]any

+ Features map[string]map[string]string

+ GeneratedFiles []string

+ ID string

+ LockVersion string

+ Management Management

+ func NewLockFile() *LockFile

type Management

+ ConfigChecksum string

+ InstallationURL string

+ Published bool

+ ReleaseVersion string

+ RepoSubDirectory string

+ RepoURL string

v1.4.1

Dec 19, 2023

v1.4.0

Dec 14, 2023

Changes in this version

+ type Fixes struct

+ AdditionalProperties map[string]any

+ NameResolutionDec2023 bool

type Generation

+ Fixes *Fixes

v1.3.0

Dec 5, 2023

Changes in this version

type Generation

+ UseClassNamesForArrayFields bool

v1.2.0

Nov 9, 2023

Changes in this version

type Comments

+ AdditionalProperties map[string]any

type DevContainers

+ AdditionalProperties map[string]any

type Generation

+ AdditionalProperties map[string]any

+ UsageSnippets *UsageSnippets

type Management

+ AdditionalProperties map[string]any

+ type OptionalPropertyRenderingOption string

+ const OptionalPropertyRenderingOptionAlways

+ const OptionalPropertyRenderingOptionNever

+ const OptionalPropertyRenderingOptionWithExample

+ type UsageSnippets struct

+ AdditionalProperties map[string]any

+ OptionalPropertyRendering OptionalPropertyRenderingOption

v1.1.0

Nov 4, 2023

Changes in this version

type Generation

+ MaintainOpenAPIOrder bool

v1.0.0

Oct 27, 2023

Changes in this version

type Comments

+ DisableComments bool

type Config

+ func (c *Config) GetGenerationFieldsMap() (map[string]any, error)

type Generation

+ RepoURL string

+ type SDKGenConfig struct

+ SDKGenCommonConfig []SDKGenConfigField

+ SDKGenLanguageConfig map[string][]SDKGenConfigField

+ type SDKGenConfigField struct

+ DefaultValue *any

+ Description *string

+ Language *string

+ Name string

+ Required bool

+ RequiredForPublishing *bool

+ SecretName *string

+ TestValue *any

+ ValidationMessage *string

+ ValidationRegex *string

+ func GetGenerationDefaults(newSDK bool) []SDKGenConfigField

v0

v0.8.4

Oct 2, 2023

Changes in this version

type Option

+ func WithTransformerFunc(f TransformerFunc) Option

+ type TransformerFunc func(*Config) (*Config, error)

v0.8.3

Sep 12, 2023

v0.8.2

Sep 12, 2023

Changes in this version

+ type DevContainers struct

+ Enabled bool

+ SchemaPath bool

type Generation

+ DevContainers *DevContainers

v0.8.1

Aug 7, 2023

v0.8.0

Aug 3, 2023

Changes in this version

type Config

+ Features map[string]string

v0.7.2

Jul 12, 2023

Changes in this version

+ const ClientServerStatusCodesAsErrors

v0.7.1

Jul 6, 2023

Changes in this version

type Config

+ New bool

v0.7.0

Jul 6, 2023

v0.6.2

Jun 16, 2023

Changes in this version

+ const SpeakeasyServerURL

v0.6.1

Jun 16, 2023

Changes in this version

type GenerateWorkflow

+ Env map[string]string

type PublishWorkflow

+ Env map[string]string

v0.6.0

Jun 15, 2023

Changes in this version

type Job

+ Env map[string]string

v0.5.0

May 17, 2023

Changes in this version

+ const DisableComments

+ const OmitDescriptionIfSummaryPresent

v0.4.3

May 2, 2023

Changes in this version

+ var CommentFields = []string

v0.4.2

May 1, 2023

Changes in this version

+ const BaseServerURL

+ const GithubAccessToken

+ const GithubWritePermission

+ const Languages

+ const Mode

+ const OpenAPIDocAuthHeader

+ const OpenAPIDocAuthToken

+ const OpenAPIDocs

+ const SDKClassName

+ const SingleTagPerOp

+ const SpeakeasyApiKey

+ const TagNamespacingDisabled

+ const TelemetryEnabled

+ type Force struct

+ Default bool

+ Description string

+ Type string

+ type GenerateOn struct

+ Schedule []Schedule

+ WorkflowDispatch WorkflowDispatch

+ type GenerateWorkflow struct

+ Jobs Jobs

+ Name string

+ On GenerateOn

+ Permissions Permissions

type Generation

+ CommentFields map[string]bool

+ Fields map[string]any

+ type Inputs struct

+ Force Force

+ type Job struct

+ Secrets map[string]string

+ Uses string

+ With map[string]any

+ type Jobs struct

+ Generate Job

+ Publish Job

+ type Permissions struct

+ Checks string

+ Contents string

+ PullRequests string

+ Statuses string

+ type PublishOn struct

+ Push Push

+ type PublishWorkflow struct

+ Jobs Jobs

+ Name string

+ On PublishOn

+ type Push struct

+ Branches []string

+ Paths []string

+ type Schedule struct

+ Cron string

type SdkGenConfigField

+ Language *string

+ SecretName *string

+ type WorkflowDispatch struct

+ Inputs Inputs

v0.4.1

Apr 28, 2023

v0.4.0

Apr 11, 2023

v0.3.2

Mar 29, 2023

Changes in this version

+ type SdkGenConfigField struct

+ DefaultValue *string

+ Description *string

+ Name string

+ Required bool

+ RequiredForPublishing *bool

+ ValidationMessage *string

+ ValidationRegex *string

v0.3.1

Mar 27, 2023

Changes in this version

+ type SdkGenConfig struct

+ SdkGenCommonConfig []LanguageConfigField

+ SdkGenLanguageConfig map[string][]LanguageConfigField

v0.3.0

Mar 22, 2023

Changes in this version

type Generation

+ SingleTagPerOp bool

v0.2.1

Mar 22, 2023

Changes in this version

type LanguageConfigField

+ RequiredForPublishing *bool

v0.2.0

Mar 21, 2023

Changes in this version

type Management

+ GenerationVersion string

v0.1.7

Mar 5, 2023

v0.1.6

Mar 1, 2023

v0.1.5

Feb 27, 2023

Changes in this version

+ type LanguageConfigField struct

+ DefaultValue *string

+ Description *string

+ Name string

+ Required bool

+ ValidationMessage *string

+ ValidationRegex *string

v0.1.4

Feb 27, 2023

v0.1.3

Feb 27, 2023

v0.1.2

Feb 27, 2023

v0.1.1

Feb 27, 2023

v0.1.0

Feb 27, 2023

Changes in this version

type Generation

+ SDKFlattening bool

v0.0.6

Feb 19, 2023

v0.0.5

Feb 19, 2023

v0.0.4

Feb 18, 2023

Changes in this version

type Option

+ func WithLanguages(langs ...string) Option

v0.0.3

Feb 18, 2023

Changes in this version

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

v0.0.2

Feb 18, 2023

Changes in this version

type Option

+ func WithUpgradeFunc(f UpgradeFunc) Option

v0.0.1

Feb 16, 2023

Changes in this version

+ const Version

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

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

+ type Comments struct

+ Disabled bool

+ OmitDescriptionIfSummaryPresent bool

+ type Config struct

+ ConfigVersion string

+ Generation Generation

+ Languages map[string]LanguageConfig

+ Management *Management

+ func GetDefaultConfig(lang string, getLangDefaultFunc GetLanguageDefaultFunc) (*Config, error)

+ func Load(dir string, lang string, uf UpgradeFunc, opts ...Option) (*Config, error)

+ type Generation struct

+ BaseServerURL string

+ Comments *Comments

+ SDKClassName string

+ TagNamespacingDisabled bool

+ TelemetryEnabled bool

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

+ type LanguageConfig struct

+ Cfg map[string]any

+ Version string

+ type Management struct

+ DocChecksum string

+ DocVersion string

+ SpeakeasyVersion string

+ type Option func(*options)

+ func WithFileSystemFuncs(rf ReadFileFunc, wf WriteFileFunc) Option

+ func WithLanguageDefaultFunc(f GetLanguageDefaultFunc) Option

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

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

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL