config

type AllOfMergeStrategy string

type Auth struct {
	OAuth2ClientCredentialsEnabled bool `yaml:"oAuth2ClientCredentialsEnabled" description:"Enables support for OAuth2 client credentials grant type"`
	OAuth2PasswordEnabled          bool `yaml:"oAuth2PasswordEnabled" description:"Enables support for OAuth2 resource owner password credentials grant type"`
	HoistGlobalSecurity            bool `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Config struct {
	Config     *Configuration
	ConfigPath string
	LockFile   *LockFile
}

type Configuration struct {
	ConfigVersion string                    `yaml:"configVersion" description:"The version of the configuration file" minLength:"1" required:"true"`
	Generation    Generation                `yaml:"generation" required:"true"`
	Languages     map[string]LanguageConfig `yaml:",inline" jsonschema:"-"`
	New           map[string]bool           `yaml:"-"`
	// contains filtered or unexported fields
}

type DevContainers struct {
	Enabled bool `yaml:"enabled" description:"Whether dev containers are enabled"`
	// This can be a local path or a remote URL
	SchemaPath           string         `yaml:"schemaPath" description:"Path to the schema file for the dev container"`
	AdditionalProperties map[string]any `yaml:",inline" jsonschema:"-"` // Captures any additional properties that are not explicitly defined for backwards/forwards compatibility
	// contains filtered or unexported fields
}

type Examples = lockfile.Examples

type FS interface {
	fs.ReadFileFS
	fs.StatFS
	WriteFile(name string, data []byte, perm os.FileMode) error
}

type Fixes struct {
	NameResolutionDec2023                bool           `yaml:"nameResolutionDec2023,omitempty" description:"Enables name resolution fixes from December 2023"`
	NameResolutionFeb2025                bool           `yaml:"nameResolutionFeb2025" description:"Enables name resolution fixes from February 2025"`
	ParameterOrderingFeb2024             bool           `yaml:"parameterOrderingFeb2024" description:"Enables parameter ordering fixes from February 2024"`
	RequestResponseComponentNamesFeb2024 bool           `` /* 128-byte string literal not displayed */
	SecurityFeb2025                      bool           `yaml:"securityFeb2025" description:"Enables fixes and refactoring for security that were introduced in February 2025"`
	SharedErrorComponentsApr2025         bool           ``                              /* 242-byte string literal not displayed */
	AdditionalProperties                 map[string]any `yaml:",inline" jsonschema:"-"` // Captures any additional properties that are not explicitly defined for backwards/forwards compatibility
	// contains filtered or unexported fields
}

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

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

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

type GeneratedTests = lockfile.GeneratedTests

type Generation struct {
	DevContainers               *DevContainers `yaml:"devContainers,omitempty"`
	BaseServerURL               string         `` /* 143-byte string literal not displayed */
	SDKClassName                string         `yaml:"sdkClassName,omitempty" description:"Generated name of the root SDK class"`
	MaintainOpenAPIOrder        bool           `yaml:"maintainOpenAPIOrder,omitempty" description:"Maintains the order of parameters and fields in the OpenAPI specification"`
	DeduplicateErrors           bool           `yaml:"deduplicateErrors,omitempty" description:"Deduplicates errors that have the same schema"`
	UsageSnippets               *UsageSnippets `yaml:"usageSnippets,omitempty"`
	UseClassNamesForArrayFields bool           `` /* 126-byte string literal not displayed */
	Fixes                       *Fixes         `yaml:"fixes,omitempty"`
	Auth                        *Auth          `yaml:"auth,omitempty"`
	SkipErrorSuffix             bool           `yaml:"skipErrorSuffix,omitempty" description:"Skips the automatic addition of an error suffix to error types"`
	InferSSEOverload            bool           `` /* 199-byte string literal not displayed */
	SDKHooksConfigAccess        bool           `yaml:"sdkHooksConfigAccess,omitempty" description:"Enables access to the SDK configuration from hooks"`
	Schemas                     Schemas        `yaml:"schemas"`
	RequestBodyFieldName        string         `yaml:"requestBodyFieldName" description:"The name of the field to use for the request body in generated SDKs"`

	// Mock server generation configuration.
	MockServer *MockServer `yaml:"mockServer,omitempty"`

	// PersistentEdits configures whether user edits persist across regenerations
	PersistentEdits PersistentEdits `yaml:"persistentEdits"`
	Tests           Tests           `yaml:"tests,omitempty"`

	AdditionalProperties map[string]any `yaml:",inline" jsonschema:"-"` // Captures any additional properties that are not explicitly defined for backwards/forwards compatibility
	// contains filtered or unexported fields
}

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

type Inputs struct {
	Force               Force                `yaml:"force"`
	PushCodeSamplesOnly *PushCodeSamplesOnly `yaml:"push_code_samples_only,omitempty"`
	SetVersion          *SetVersion          `yaml:"set_version,omitempty"`
	Target              *Target              `yaml:"target,omitempty"`
}

type InputsTesting struct {
	Target Target `yaml:"target"`
}

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

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

type LanguageConfig struct {
	Version string         `yaml:"version" description:"SDK version"`
	Cfg     map[string]any `yaml:",inline" jsonschema:"-"`
	// contains filtered or unexported fields
}

type LockFile = lockfile.LockFile

type LockfileOption = lockfile.LoadOption

type Management = lockfile.Management

type MockServer struct {

	// Disables the code generation of the mockserver target.
	Disabled bool `yaml:"disabled" description:"Disables the code generation of the mock server target"`
	// contains filtered or unexported fields
}

type OperationExamples = lockfile.OperationExamples

type Option func(*options)

type OptionalPropertyRenderingOption string

type ParameterExamples = lockfile.ParameterExamples

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

type PersistentEdits struct {

	// Enabled controls preservation of user edits:
	// - "true": enables persistent edits
	// - omitted/empty: disabled but will prompt on dirty detection
	// - "never": disabled and will never prompt
	Enabled *PersistentEditsEnabled `` /* 152-byte string literal not displayed */

	AdditionalProperties map[string]any `yaml:",inline" jsonschema:"-"` // Captures any additional properties
	// contains filtered or unexported fields
}

type PersistentEditsEnabled string

type PublishOn struct {
	Push             Push                   `yaml:"push"`
	WorkflowDispatch *WorkflowDispatchEmpty `yaml:"workflow_dispatch,omitempty"`
}

type PublishWorkflow struct {
	Name        string      `yaml:"name"`
	Permissions Permissions `yaml:"permissions,omitempty"`
	On          PublishOn   `yaml:"on"`
	Jobs        Jobs        `yaml:"jobs"`
}

type PullRequestOn struct {
	Types []string `yaml:"types,omitempty"`
}

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

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

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"`
	TestValue             *any    `yaml:"testValue,omitempty" json:"test_value,omitempty"`
}

type SDKInitStyle string

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

type Schemas struct {
	AllOfMergeStrategy AllOfMergeStrategy `yaml:"allOfMergeStrategy" enum:"deepMerge,shallowMerge" description:"Controls how allOf schemas are merged"`
	// contains filtered or unexported fields
}

type ServerIndex string

type SetVersion struct {
	Description string `yaml:"description"`
	Type        string `yaml:"type"`
}

type TagOn struct {
	Push             Push                  `yaml:"push"`
	WorkflowDispatch WorkflowDispatchEmpty `yaml:"workflow_dispatch"`
}

type TaggingWorkflow struct {
	Name        string      `yaml:"name"`
	Permissions Permissions `yaml:"permissions,omitempty"`
	On          TagOn       `yaml:"on"`
	Jobs        Jobs        `yaml:"jobs"`
}

type Target struct {
	Description string `yaml:"description"`
	Type        string `yaml:"type"`
}

type TestingOn struct {
	PullRequest      Push                    `yaml:"pull_request"`
	Push             *Push                   `yaml:"push,omitempty"`
	WorkflowDispatch WorkflowDispatchTesting `yaml:"workflow_dispatch"`
}

type TestingWorkflow struct {
	Name        string      `yaml:"name"`
	Permissions Permissions `yaml:"permissions,omitempty"`
	On          TestingOn   `yaml:"on"`
	Jobs        Jobs        `yaml:"jobs"`
}

type Tests struct {
	GenerateTests              bool           `yaml:"generateTests" description:"Enables generation of tests"`
	GenerateNewTests           bool           `yaml:"generateNewTests" description:"Enables generation of new tests for any new operations in the OpenAPI specification"`
	SkipResponseBodyAssertions bool           ``                              /* 135-byte string literal not displayed */
	AdditionalProperties       map[string]any `yaml:",inline" jsonschema:"-"` // Captures any additional properties that are not explicitly defined for backwards/forwards compatibility
	// contains filtered or unexported fields
}

type TrackedFile = lockfile.TrackedFile

type TrackedFiles = lockfile.TrackedFiles

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

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

type UsageSnippets struct {
	OptionalPropertyRendering OptionalPropertyRenderingOption ``                                        /* 142-byte string literal not displayed */
	SDKInitStyle              SDKInitStyle                    ``                                        /* 126-byte string literal not displayed */
	ServerToShowInSnippets    ServerIndex                     `yaml:"serverToShowInSnippets,omitempty"` // If unset, no server will be shown, if an integer, use as server_idx, else look for a matching id
	AdditionalProperties      map[string]any                  `yaml:",inline" jsonschema:"-"`           // Captures any additional properties that are not explicitly defined for backwards/forwards compatibility
	// contains filtered or unexported fields
}

type ValidateFunc func(Config) error

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

type WorkflowDispatchEmpty struct{}

type WorkflowDispatchTesting struct {
	Inputs InputsTesting `yaml:"inputs"`
}