openapigenerator

type APIEachTemplate struct {
	Metadata Metadata // Metadata for the template, like artifact group and ID
	Common   GlobalTemplate
	Package  string
	Service  Service
}

type APIOnceTemplate struct {
	Metadata Metadata // Metadata for the template, like artifact group and ID
	Common   GlobalTemplate
	Package  string
}

type Auth struct {
	Methods []AuthMethod
}

type AuthMethod struct {
	Name        string
	Description string
	Type        string // Type of the auth method, e.g. "apiKey", "http", "oauth2"
	Variant     string // Variant of the auth method, e.g. "apiKey-header", "apiKey-query", "oauth-client-credentials", "oauth-password-credentials"
	Scheme      string
	HeaderParam string // HeaderParam is the name of the header parameter, if applicable
	QueryParam  string // QueryParam is the name of the query parameter, if applicable
	TokenUrl    string // TokenUrl is the URL to the token endpoint, if applicable
}

type CodeGenerator interface {
	// Id returns a unique id for this generator
	Id() string

	// Description returns a human-readable description of the generator
	Description() string

	// Generate generates code
	Generate(opts GenerateOpts) error

	// TemplateData processes a openapi document and returns a data model to be used in the templates
	TemplateData(opts TemplateDataOpts) (DocumentModel, error)

	// ToClassName converts a name to a language-specific class name
	ToClassName(name string) string

	// ToFunctionName converts a name to a language-specific function name
	ToFunctionName(name string) string

	// ToPropertyName converts a name to a language-specific property name
	ToPropertyName(name string) string

	// ToParameterName converts a name to a language-specific parameter name
	ToParameterName(name string) string

	// ToConstantName converts a name to a language-specific constant name
	ToConstantName(name string) string

	// ToCodeType converts a schema to a language-specific type
	ToCodeType(schema *base.Schema, schemaType CodeTypeSchemaType, required bool) (CodeType, error)

	// PostProcessType is used for post-processing a type (e.g. void type if the type is empty)
	PostProcessType(codeType CodeType) CodeType

	// IsPrimitiveType checks if a type is a primitive type
	IsPrimitiveType(input string) bool

	// TypeToImport returns the import path for a given type
	TypeToImport(typeName CodeType) string
}

type CodeType struct {
	Name                 string // Name of the type
	Declaration          string // Declaration of the type
	QualifiedDeclaration string // Qualified declaration of the type (with package name, pointer, optional, etc.)
	Type                 string // Type of the type
	QualifiedType        string // Qualified type of the type (with package name)
	TypeArgs             []CodeType
	IsArray              bool
	IsList               bool
	IsMap                bool
	IsNullable           bool
	IsPointer            bool
	IsVoid               bool
	IsPostProcessed      bool
	ImportPath           string
}

type CodeTypeSchemaType string

type CommonPackages struct {
	Root       string
	Client     string
	Models     string
	Responses  string
	Enums      string
	Operations string
	Auth       string
}

type DocumentModel struct {
	Name            string
	DisplayName     string
	Description     string
	Tags            map[string]Tag
	Endpoints       Endpoints
	Auth            Auth
	Services        map[string]Service
	Operations      []Operation
	OperationsByTag map[string][]Operation
	Models          []Model
	Enums           []Enum
	Packages        CommonPackages // Packages holds the import paths for output packages
}

type Documentation struct {
	Title string `yaml:"title,omitempty"`
	URL   string `yaml:"url,omitempty"`
}

type Endpoint struct {
	Type        string
	URL         string
	Description string
}

type Endpoints []Endpoint

type Enum struct {
	Name             string                                  `yaml:"name"`
	Description      string                                  `yaml:"description,omitempty"`
	Parent           CodeType                                `yaml:"parent,omitempty"`
	ValueType        CodeType                                `yaml:"valueType,omitempty"`
	AllowedValues    map[string]openapidocument.AllowedValue `yaml:"allowedValues,omitempty"`
	Imports          []string                                `yaml:"imports,omitempty"`
	Deprecated       bool                                    `yaml:"deprecated,omitempty"`
	DeprecatedReason string                                  `yaml:"deprecatedReason,omitempty"`
}

type EnumEachTemplate struct {
	Metadata Metadata // Metadata for the template, like artifact group and ID
	Common   GlobalTemplate
	Package  string
	Name     string
	Enum     Enum
}

type GenerateOpts struct {
	DryRun           bool
	Doc              *libopenapi.DocumentModel[v3.Document]
	OutputDir        string
	TemplateId       string
	PackageConfig    CommonPackages
	ArtifactGroupId  string
	ArtifactId       string
	RepositoryUrl    string
	LicenseName      string
	LicenseUrl       string
	Provider         appconf.ProviderConf
	GeneratorNames   []string
	GeneratorOutputs []string
}

type GlobalTemplate struct {
	GeneratorProperties map[string]string
	Endpoints           Endpoints
	Auth                Auth
	Packages            CommonPackages
	Services            map[string]Service
	Operations          []Operation
	Models              []Model
	Enums               []Enum
}

type Metadata struct {
	ArtifactGroupId  string
	ArtifactId       string
	Name             string
	DisplayName      string
	Description      string
	RepositoryUrl    string   // RepositoryUrl is the URL to the repository (without protocol or .git suffix)
	LicenseName      string   // LicenseName is the name of the license (MIT, Apache-2.0, etc.)
	LicenseUrl       string   // LicenseUrl is the URL to the license
	GeneratorNames   []string // GeneratorNames is a list of all active generators
	GeneratorOutputs []string // GeneratorOutputs is a list of all output directories for the active generators
}

type Model struct {
	Name             string     `yaml:"name"`
	Description      string     `yaml:"description,omitempty"`
	Parent           CodeType   `yaml:"parent,omitempty"`
	Properties       []Property `yaml:"properties,omitempty"`
	AnyOf            []Model    `yaml:"anyOf,omitempty"`
	AllOf            []Model    `yaml:"allOf,omitempty"`
	OneOf            []Model    `yaml:"oneOf,omitempty"`
	Imports          []string   `yaml:"imports,omitempty"`
	Deprecated       bool       `yaml:"deprecated,omitempty"`
	DeprecatedReason string     `yaml:"deprecatedReason,omitempty"`
	IsTypeAlias      bool       `yaml:"isTypeAlias,omitempty"`
}

type ModelEachTemplate struct {
	Metadata Metadata // Metadata for the template, like artifact group and ID
	Common   GlobalTemplate
	Package  string
	Name     string
	Model    Model
}

type ModelOpts struct {
	Generator     CodeGenerator
	Doc           *libopenapi.DocumentModel[v3.Document]
	PackageConfig CommonPackages
}

type ModelsOnceTemplate struct {
	Metadata Metadata // Metadata for the template, like artifact group and ID
	Common   GlobalTemplate
	Models   []Model
}

type Operation struct {
	Name                     string                              `yaml:"name,omitempty"`
	Path                     string                              `yaml:"path"`
	PathSegments             []PathSegment                       `yaml:"pathSegments,omitempty"`
	Method                   string                              `yaml:"method"`
	Summary                  string                              `yaml:"summary,omitempty"`     // Short description
	Description              string                              `yaml:"description,omitempty"` // Long description
	Tag                      string                              `yaml:"tag,omitempty"`
	Tags                     []string                            `yaml:"tags,omitempty"`
	ReturnType               CodeType                            `yaml:"returnType,omitempty"`
	Deprecated               bool                                `yaml:"deprecated,omitempty"`
	DeprecatedReason         string                              `yaml:"deprecatedReason,omitempty"`
	Parameters               []Parameter                         `yaml:"parameters,omitempty"`          // Parameters holds all parameters, including static ones that can not be overridden
	MutableParameters        []Parameter                         `yaml:"mutableParameters,omitempty"`   // MutableParameters can be supplied by the user
	ImmutableParameters      []Parameter                         `yaml:"immutableParameters,omitempty"` // ImmutableParameters can not be overridden by the user
	PathParameters           []Parameter                         `yaml:"pathParameters,omitempty"`
	MutablePathParameters    []Parameter                         `yaml:"mutablePathParameters,omitempty"`
	ImmutablePathParameters  []Parameter                         `yaml:"immutablePathParameters,omitempty"`
	QueryParameters          []Parameter                         `yaml:"queryParameters,omitempty"`
	MutableQueryParameters   []Parameter                         `yaml:"mutableQueryParameters,omitempty"`
	ImmutableQueryParameters []Parameter                         `yaml:"immutableQueryParameters,omitempty"`
	HeaderParameters         []Parameter                         `yaml:"headerParameters,omitempty"`
	MutableHeaderParameter   []Parameter                         `yaml:"mutableHeaderParameter,omitempty"`
	ImmutableHeaderParameter []Parameter                         `yaml:"immutableHeaderParameter,omitempty"`
	CookieParameters         []Parameter                         `yaml:"cookieParameters,omitempty"`
	MutableCookieParameter   []Parameter                         `yaml:"mutableCookieParameter,omitempty"`
	ImmutableCookieParameter []Parameter                         `yaml:"immutableCookieParameter,omitempty"`
	BodyParameter            *Parameter                          `yaml:"bodyParameter,omitempty"`
	Imports                  []string                            `yaml:"imports,omitempty"`
	Documentation            []Documentation                     `yaml:"documentation,omitempty"`
	Stability                string                              `yaml:"stability,omitempty"`
	Extensions               *orderedmap.Map[string, *yaml.Node] `yaml:"extensions,omitempty"` // Extensions are custom extensions to the operation
}

type OperationEachTemplate struct {
	Metadata  Metadata // Metadata for the template, like artifact group and ID
	Common    GlobalTemplate
	Package   string
	Name      string
	Operation Operation
}

type OperationOpts struct {
	Generator     CodeGenerator
	Doc           *libopenapi.DocumentModel[v3.Document]
	PackageConfig CommonPackages
}

type OperationsOnceTemplate struct {
	Metadata Metadata // Metadata for the template, like artifact group and ID
	Common   GlobalTemplate
}

type Parameter struct {
	Name             string                                  `yaml:"name,omitempty"`
	FieldName        string                                  `yaml:"fieldName,omitempty"` // FieldName is the original name of the parameter
	In               string                                  `yaml:"in,omitempty"`
	Description      string                                  `yaml:"description,omitempty"`
	Type             CodeType                                `yaml:"type,omitempty"`
	IsPrimitiveType  bool                                    `yaml:"isPrimitiveType,omitempty"`
	IsImmutable      bool                                    `yaml:"isImmutable,omitempty"`
	Required         bool                                    `yaml:"required,omitempty"`
	AllowedValues    map[string]openapidocument.AllowedValue `yaml:"allowedValues,omitempty"`
	StaticValue      string                                  `yaml:"staticValue,omitempty"`
	Deprecated       bool                                    `yaml:"deprecated,omitempty"`
	DeprecatedReason string                                  `yaml:"deprecatedReason,omitempty"`
	Stability        string                                  `yaml:"stability,omitempty"`
}

type PathSegment struct {
	Value         string
	IsParameter   bool
	ParameterName string
}

type Property struct {
	Name            string                                  `yaml:"name" required:"true"`  // Name is the parameter name
	FieldName       string                                  `yaml:"fieldName,omitempty"`   // FieldName is the original name of the parameter
	Title           string                                  `yaml:"title,omitempty"`       // Title is the human-readable name of the parameter
	Description     string                                  `yaml:"description,omitempty"` // Description is the human-readable description of the parameter
	Type            CodeType                                `yaml:"type,omitempty"`
	IsPrimitiveType bool                                    `yaml:"isPrimitiveType,omitempty"`
	Nullable        bool                                    `yaml:"nullable,omitempty"`
	AllowedValues   map[string]openapidocument.AllowedValue `yaml:"allowedValues,omitempty"`
	Items           []Property                              `yaml:"items,omitempty"`
}

type SchemaDefinition struct {
	Type   string
	Format string
}

type Service struct {
	Name          string `yaml:"name"`
	Type          string `yaml:"type,omitempty"` // Type returns the CodeType used for the service
	Description   string `yaml:"description,omitempty"`
	Operations    []Operation
	Documentation []Documentation `yaml:"documentation,omitempty"`
}

type SupportOnceTemplate struct {
	Metadata Metadata             // Metadata for the template, e.g. artifact group, ID, etc.
	Provider appconf.ProviderConf // Provider contains information about the product or company providing the API
	Common   GlobalTemplate       // Common template data, e.g. API name, project name, etc.
}

type Tag struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description,omitempty"`
}

type TemplateDataOpts struct {
	Doc           *libopenapi.DocumentModel[v3.Document]
	PackageConfig CommonPackages
}