workflow

type Auth struct {
	Header string `yaml:"authHeader" description:"A HTTP Header Name" required:"true"`
	Secret string `yaml:"authSecret" description:"A HTTP Header Value" required:"true"`
	// contains filtered or unexported fields
}

type CodeSamples struct {
	Output   string          `yaml:"output,omitempty" description:"The output file name"`
	Registry *SourceRegistry `yaml:"registry,omitempty" description:"The output registry location."`
	Style    *string         `` // Oneof "standard", "readme" (default: standard) (see codesamples.go)
	/* 126-byte string literal not displayed */
	LangOverride *string `` // The value to use for the "lang" field of each codeSample (default: auto-detect)
	/* 127-byte string literal not displayed */
	LabelOverride *CodeSamplesLabelOverride `yaml:"labelOverride,omitempty" description:"Optional label override for the code sample. Default is to use the operationId."` // The value to use for the "label" field of each codeSample (default: operationId)
	Blocking      *bool                     ``                                                                                                                             // Default: true. If false, code samples failures will not consider the workflow as failed
	/* 130-byte string literal not displayed */
	Disabled *bool `yaml:"disabled,omitempty" description:"Optional flag to disable code samples."` // Default: false. If true, code samples will not be generated
	// contains filtered or unexported fields
}

type CodeSamplesLabelOverride struct {
	FixedValue *string `yaml:"fixedValue,omitempty" description:"Optional fixed value for the label."`
	Omit       *bool   `yaml:"omit,omitempty" description:"Optional flag to omit the label."`
}

type Dependent struct {
	Location     string `yaml:"location" description:"The local path to the repository" required:"true"`
	CloneCommand string `yaml:"cloneCommand,omitempty" description:"Optional command to clone the repository"`
	// contains filtered or unexported fields
}

type Document struct {
	Location LocationString `` /* 151-byte string literal not displayed */
	Auth     *Auth          `yaml:",inline"`
	// contains filtered or unexported fields
}

type FallbackCodeSamples struct {
	FallbackCodeSamplesLanguage string `yaml:"fallbackCodeSamplesLanguage,omitempty" required:"true"`
}

type FilterOperationsOptions struct {
	Operations string `yaml:"operations" description:"Comma-separated list of operations to filter" required:"true"` // Comma-separated list of operations to filter
	Include    *bool  `yaml:"include,omitempty" description:"Include the specified operations (mutually exclusive with exclude)"`
	Exclude    *bool  `yaml:"exclude,omitempty" description:"Exclude the specified operations (mutually exclusive with include)"`
}

type Java struct {
	OSSRHUsername     string `yaml:"ossrhUsername" required:"true"`
	OSSHRPassword     string `yaml:"ossrhPassword" required:"true"`
	GPGSecretKey      string `yaml:"gpgSecretKey" required:"true"`
	GPGPassPhrase     string `yaml:"gpgPassPhrase" required:"true"`
	UseSonatypeLegacy bool   `yaml:"useSonatypeLegacy,omitempty" required:"true"`
	// contains filtered or unexported fields
}

type LocationString string

type LockFile struct {
	SpeakeasyVersion string                `yaml:"speakeasyVersion"`
	Sources          map[string]SourceLock `yaml:"sources"`
	Targets          map[string]TargetLock `yaml:"targets"`

	Workflow Workflow `yaml:"workflow"`
}

type MockServer struct {

	// When enabled, the mockserver will be started during testing.
	Enabled *bool `yaml:"enabled,omitempty" description:"Defaults to true. If false, the mock API server will not be started."`
	// contains filtered or unexported fields
}

type NPM struct {
	Token string `yaml:"token" required:"true"`
	// contains filtered or unexported fields
}

type NormalizeOptions struct {
	PrefixItems *bool `yaml:"prefixItems,omitempty"`
}

type Nuget struct {
	APIKey string `yaml:"apiKey" required:"true"`
	// contains filtered or unexported fields
}

type Overlay struct {
	FallbackCodeSamples *FallbackCodeSamples `yaml:"fallbackCodeSamples,omitempty"`
	Document            *Document            `yaml:"document,omitempty"`
}

type Packagist struct {
	Username string `yaml:"username" required:"true"`
	Token    string `yaml:"token" required:"true"`
	// contains filtered or unexported fields
}

type Publishing struct {
	NPM       *NPM       `yaml:"npm,omitempty" description:"NPM (Typescript) publishing configuration."`
	PyPi      *PyPi      `yaml:"pypi,omitempty" description:"PyPI (Python)publishing configuration."`
	Packagist *Packagist `yaml:"packagist,omitempty" description:"Packagist (PHP) publishing configuration."`
	Java      *Java      `yaml:"java,omitempty" description:"Maven (Java) publishing configuration."`
	RubyGems  *RubyGems  `yaml:"rubygems,omitempty" description:"Rubygems (Ruby) publishing configuration."`
	Nuget     *Nuget     `yaml:"nuget,omitempty" description:"NuGet (C#) publishing configuration."`
	Terraform *Terraform `yaml:"terraform,omitempty"`
	// contains filtered or unexported fields
}

type PyPi struct {
	Token string `yaml:"token" required:"true"`
	// contains filtered or unexported fields
}

type RubyGems struct {
	Token string `yaml:"token" required:"true"`
	// contains filtered or unexported fields
}

type Source struct {
	Inputs          []Document       `` /* 138-byte string literal not displayed */
	Overlays        []Overlay        `yaml:"overlays,omitempty" description:"A list of overlay files (OpenAPI Overlay Specification)"`
	Transformations []Transformation `yaml:"transformations,omitempty" description:"A list of transformations to apply to the OpenAPI document"`
	Output          *string          `yaml:"output,omitempty" description:"The output file name (optional)"`
	Ruleset         *string          `yaml:"ruleset,omitempty" description:"The linting ruleset to use (optional)"`
	Registry        *SourceRegistry  `yaml:"registry,omitempty" description:"The openapi registry configuration"`
	// contains filtered or unexported fields
}

type SourceLock struct {
	SourceNamespace      string   `yaml:"sourceNamespace,omitempty"`
	SourceRevisionDigest string   `yaml:"sourceRevisionDigest,omitempty"`
	SourceBlobDigest     string   `yaml:"sourceBlobDigest,omitempty"`
	Tags                 []string `yaml:"tags,omitempty"`
}

type SourceRegistry struct {
	Location SourceRegistryLocation `yaml:"location" description:"The registry location to use (for snapshotting/change tracking)" required:"true"`
	Tags     []string               `yaml:"tags,omitempty" description:"The list of tags to use for the registry"`
	// contains filtered or unexported fields
}

type SourceRegistryLocation string

type SpeakeasyRegistryDocument struct {
	OrganizationSlug string
	WorkspaceSlug    string
	NamespaceID      string
	NamespaceName    string
	// Reference could be tag or revision hash sha256:...
	Reference string
}

type Target struct {
	Target      string       `yaml:"target" enum:"csharp,go,java,mcp-typescript,php,python,ruby,swift,terraform,typescript,unity,postman" required:"true"`
	Source      string       `yaml:"source" required:"true"`
	Output      *string      `yaml:"output,omitempty"`
	Publishing  *Publishing  `yaml:"publish,omitempty"`
	CodeSamples *CodeSamples `yaml:"codeSamples,omitempty"`

	// Configuration for target testing. By default, target testing is disabled.
	Testing *Testing `yaml:"testing,omitempty"`
	// contains filtered or unexported fields
}

type TargetLock struct {
	Source                    string `yaml:"source"`
	SourceNamespace           string `yaml:"sourceNamespace,omitempty"`
	SourceRevisionDigest      string `yaml:"sourceRevisionDigest,omitempty"`
	SourceBlobDigest          string `yaml:"sourceBlobDigest,omitempty"`
	CodeSamplesNamespace      string `yaml:"codeSamplesNamespace,omitempty"`
	CodeSamplesRevisionDigest string `yaml:"codeSamplesRevisionDigest,omitempty"`
	CodeSamplesBlobDigest     string `yaml:"codeSamplesBlobDigest,omitempty"`
}

type Terraform struct {
	GPGPrivateKey string `yaml:"gpgPrivateKey" required:"true"`
	GPGPassPhrase string `yaml:"gpgPassPhrase" required:"true"`
}

type Testing struct {

	// When enabled, the target will be tested as part of the workflow.
	Enabled *bool `yaml:"enabled,omitempty" description:"Defaults to false. If true, the target will be tested as part of the workflow."`

	// Configuration for mockserver handling during testing. By default, the
	// mockserver is enabled.
	MockServer *MockServer `` /* 169-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Transformation struct {
	RemoveUnused        *bool                    `yaml:"removeUnused,omitempty" description:"Remove unused components from the OpenAPI document"`
	FilterOperations    *FilterOperationsOptions `yaml:"filterOperations,omitempty" description:"Filter operations from the OpenAPI document"`
	Cleanup             *bool                    `yaml:"cleanup,omitempty" description:"Clean up the OpenAPI document"`
	Format              *bool                    `yaml:"format,omitempty"`
	JQSymbolicExecution *bool                    `yaml:"jqSymbolicExecution,omitempty"`
	Normalize           *NormalizeOptions        `yaml:"normalize,omitempty"`
	// contains filtered or unexported fields
}

type Version string

type Workflow struct {
	Version          string               `yaml:"workflowVersion" description:"The version of the workflow schema" const:"1.0.0" required:"true"`
	SpeakeasyVersion Version              `yaml:"speakeasyVersion,omitempty" description:"The version of the speakeasy CLI"`
	Sources          map[string]Source    `yaml:"sources" description:"A map of source names to source configurations, where the output is an OpenAPI document"`
	Targets          map[string]Target    `` /* 126-byte string literal not displayed */
	Dependents       map[string]Dependent `` // Currently only used by one customer. Used to make rebuilding dependent SDKs that live elsewhere easier.
	/* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}