frank

type Auth struct {
	Type             string `yaml:"type"`
	Token            string `yaml:"token,omitempty"`
	Username         string `yaml:"username,omitempty"`
	Password         string `yaml:"password,omitempty"`
	Key              string `yaml:"key,omitempty"`
	Value            string `yaml:"value,omitempty"`
	Placement        string `yaml:"placement,omitempty"`
	GrantType        string `yaml:"grantType,omitempty"`
	AuthorizationURL string `yaml:"authorizationUrl,omitempty"`
	TokenURL         string `yaml:"tokenUrl,omitempty"`
	CallbackURL      string `yaml:"callbackUrl,omitempty"`
	Scope            string `yaml:"scope,omitempty"`
}

type BrunoConfig struct {
	Ignore []string `yaml:"ignore,omitempty"`
}

type BrunoExtensions struct {
	Bruno *BrunoConfig `yaml:"bruno,omitempty"`
}

type Collection struct {
	OpenCollection string             `yaml:"opencollection"`
	Bundled        bool               `yaml:"bundled,omitempty"`
	Info           CollectionInfo     `yaml:"info"`
	Request        *CollectionRequest `yaml:"request,omitempty"`
	Extensions     *BrunoExtensions   `yaml:"extensions,omitempty"`
	Items          []*CollectionItem  `yaml:"items,omitempty"`
}

type CollectionAuthor struct {
	Name  string `yaml:"name"`
	Email string `yaml:"email,omitempty"`
}

type CollectionInfo struct {
	Name    string             `yaml:"name"`
	Summary string             `yaml:"summary,omitempty"`
	Version string             `yaml:"version,omitempty"`
	Authors []CollectionAuthor `yaml:"authors,omitempty"`
}

type CollectionItem struct {
	Info  ItemInfo          `yaml:"info"`
	HTTP  *RequestHTTP      `yaml:"http,omitempty"`
	Docs  string            `yaml:"docs,omitempty"`
	Items []*CollectionItem `yaml:"items,omitempty"`
}

type CollectionRequest struct {
	Auth *Auth `yaml:"auth,omitempty"`
}

type Environment struct {
	Name      string                `yaml:"name"`
	Variables []EnvironmentVariable `yaml:"variables"`
}

type EnvironmentVariable struct {
	Name  string `yaml:"name"`
	Value string `yaml:"value"`
}

type ExplodedFile struct {
	Path    string // relative path, e.g. "users/list-users.yml"
	Content []byte
}

type Folder struct {
	Info FolderInfo `yaml:"info"`
}

type FolderInfo struct {
	Name string `yaml:"name"`
	Seq  int    `yaml:"seq"`
}

type FolderOutput struct {
	Folder   *Folder
	Requests []*Request
	DirName  string // slugified folder name for filesystem
}

type Frank struct {
	// contains filtered or unexported fields
}

type FrankConfig struct {
	DrDoc                    *model.DrDocument // fully walked DrDocument (required)
	OutputMode               OutputMode        // exploded (default) or bundled
	CollectionName           string            // override info.title
	DefaultTag               string            // folder for untagged ops (default "default")
	IncludeDescriptionAsDocs bool              // operation.description -> docs field
	GenerateEnvironments     bool              // servers[] -> environment files (always on for OutputExploded)
	Logger                   *slog.Logger
}

type FrankResult struct {
	Collection   *Collection
	Environments []*Environment
	Folders      []*FolderOutput
}

type ItemInfo struct {
	Name string   `yaml:"name"`
	Type string   `yaml:"type"`
	Seq  int      `yaml:"seq"`
	Tags []string `yaml:"tags,omitempty"`
}

type OutputMode int

type Request struct {
	Info     RequestInfo `yaml:"info"`
	HTTP     RequestHTTP `yaml:"http"`
	Docs     string      `yaml:"docs,omitempty"`
	FileName string      `yaml:"-"`
}

type RequestBody struct {
	Type string `yaml:"type,omitempty"`
	Data string `yaml:"data,omitempty"`
}

type RequestHTTP struct {
	Method  string          `yaml:"method"`
	URL     string          `yaml:"url"`
	Params  []RequestParam  `yaml:"params,omitempty"`
	Headers []RequestHeader `yaml:"headers,omitempty"`
	Body    *RequestBody    `yaml:"body,omitempty"`
	Auth    any             `yaml:"auth,omitempty"`
}

type RequestHeader struct {
	Name     string `yaml:"name"`
	Value    string `yaml:"value"`
	Disabled bool   `yaml:"disabled,omitempty"`
}

type RequestInfo struct {
	Name string   `yaml:"name"`
	Type string   `yaml:"type"`
	Seq  int      `yaml:"seq"`
	Tags []string `yaml:"tags,omitempty"`
}

type RequestParam struct {
	Name     string `yaml:"name"`
	Value    string `yaml:"value"`
	Type     string `yaml:"type"`
	Disabled bool   `yaml:"disabled,omitempty"`
}