config

type APIConfig struct {
	// BaseURL is the base URL for all requests to this API.
	BaseURL string `json:"base_url,omitempty"`
	// SpecURL is the URL of the OpenAPI spec for this API (optional).
	// Mutually exclusive with SpecFiles; SpecFiles takes precedence when both are set.
	SpecURL string `json:"spec_url,omitempty"`
	// AllowCrossOriginSpec permits discovery from Link-header spec URLs on
	// hosts other than base_url. Private, loopback, link-local, and
	// unspecified IP literal targets are still rejected.
	AllowCrossOriginSpec bool `json:"allow_cross_origin_spec,omitempty"`
	// SpecFiles is an ordered list of local file paths or URLs to load the API
	// spec from. Multiple files are deep-merged in order (later entries win on
	// conflict). When set, network spec discovery is skipped entirely.
	SpecFiles []string `json:"spec_files,omitempty"`
	// OperationBase, when set, is an absolute path resolved against base_url for
	// paths generated from OpenAPI operations. Useful when operation paths should
	// escape or replace a sub-path in base_url.
	OperationBase string `json:"operation_base,omitempty"`
	// CommandLayout controls how generated operations are arranged under the
	// API command. Empty or "flat" keeps one flat command namespace; "tags"
	// groups operations under first-tag subcommands.
	CommandLayout string `json:"command_layout,omitempty"`
	// ServerVariables supplies explicit values for OpenAPI server URL variables.
	// Values are used for generated operation path resolution; enum values from
	// remote specs are never expanded eagerly.
	ServerVariables map[string]string `json:"server_variables,omitempty"`
	// URLOverrides rewrites resolved request URL prefixes before execution.
	// It is useful when an OpenAPI document names canonical servers but this
	// profile should route requests to staging, local, or test endpoints.
	URLOverrides map[string]string `json:"url_overrides,omitempty"`
	// AllowedOperationOrigins permits generated commands to use operation- or
	// path-level OpenAPI servers on origins outside base_url.
	AllowedOperationOrigins []string `json:"allowed_operation_origins,omitempty"`
	// Profiles is a map of profile name to profile configuration.
	Profiles map[string]*ProfileConfig `json:"profiles,omitempty"`
	// Pagination holds optional per-API pagination configuration.
	Pagination *PaginationConfig `json:"pagination,omitempty"`
	// RetryMaxWait caps Retry-After/X-Retry-In delays for this API when no
	// command-line or environment override is supplied.
	RetryMaxWait string `json:"retry_max_wait,omitempty"`
	// PreserveHeaderCase sends user/API-supplied header names with their
	// configured casing for broken HTTP/1.x servers that treat names as
	// case-sensitive. It cannot affect HTTP/2, where header names are lowercase
	// by protocol.
	PreserveHeaderCase bool `json:"preserve_header_case,omitempty"`
}

type AuthConfig struct {
	// Type identifies the auth mechanism (e.g. "http-basic", "oauth-client-credentials").
	Type string `json:"type,omitempty"`
	// Params holds handler-specific configuration, e.g. {"username": "alice"}.
	Params map[string]string `json:"params,omitempty"`
}

type CacheConfig struct {
	// MaxSize is the maximum cache size (e.g. "100MB"). Default: "100MB".
	MaxSize string `json:"max_size,omitempty"`
}

type Config struct {
	// APIs is a map of short API name to per-API configuration.
	APIs map[string]*APIConfig `json:"apis,omitempty"`

	// AuthProfiles holds named auth configurations that API profiles can
	// reference with auth_ref.
	AuthProfiles map[string]*AuthConfig `json:"auth_profiles,omitempty"`

	// Cache holds global cache settings.
	Cache CacheConfig `json:"cache,omitempty"`

	// Theme customizes syntax highlighting for readable terminal output.
	// Keys are Chroma token names or Restish theme aliases; values are Chroma
	// style descriptors such as "#afd787" or "bold #ff5f87".
	Theme map[string]string `json:"theme,omitempty"`

	// ThemeSource records the source URL last used by `config theme set`.
	ThemeSource string `json:"theme_source,omitempty"`

	// Plugins holds per-plugin configuration keyed by plugin name (without the
	// "restish-" prefix). Each value is stored as raw JSON so that restish
	// itself does not need to know the shape of each plugin's config.
	// Plugins can read their config via the "config-read" message.
	//
	// Example restish.json entry:
	//   "plugins": {
	//     "bulk": { "concurrency": 4, "retry": true }
	//   }
	Plugins map[string]json.RawMessage `json:"plugins,omitempty"`

	// Migration describes a one-time v1 -> v2 config migration that happened
	// while loading this config. It is not persisted back into restish.json.
	Migration *MigrationInfo `json:"-"`
}

type ConfigDiagnostics struct {
	UnknownFields []UnknownFieldDiagnostic
}

type ConfigPatchOperation struct {
	Path   []string
	Value  any
	Delete bool
}

type ConfigShapeError struct {
	Errors []error
}

type CredentialConfig struct {
	// Auth holds inline authentication configuration for this credential.
	Auth *AuthConfig `json:"auth,omitempty"`
	// AuthRef names a top-level auth_profiles entry to use for this credential.
	AuthRef string `json:"auth_ref,omitempty"`
	// Satisfies lists requirement values, such as OAuth scopes or non-OAuth
	// roles, that this credential is intended to satisfy.
	Satisfies []string `json:"satisfies,omitempty"`
}

type MigrationInfo struct {
	SourcePath string
	BackupPath string
	Warnings   []string
}

type PaginationConfig struct {
	// ItemsPath is a filter expression that extracts the items array from the
	// response body (e.g. "data" for JSON:API, "results" for some REST APIs).
	// When empty, the body itself is used (if it is an array).
	ItemsPath string `json:"items_path,omitempty"`
	// NextPath is a filter expression that extracts the next-page URL from the
	// response body (alternative to Link header rel="next").
	NextPath string `json:"next_path,omitempty"`
	// PageParam is the URL query parameter that increments between pages when
	// an API has no next links or next_path metadata.
	PageParam string `json:"page_param,omitempty"`
}

type ParseError struct {
	Path   string
	Err    error
	Line   int
	Column int
}

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

type ProfileConfig struct {
	// BaseURL overrides the API-level base_url when this profile is active.
	BaseURL string `json:"base_url,omitempty"`
	// OperationBase overrides API-level operation_base when this profile is active.
	OperationBase string `json:"operation_base,omitempty"`
	// Headers is a list of persistent "Name: Value" headers sent with every request.
	Headers []string `json:"headers,omitempty"`
	// Query is a list of persistent "key=value" query params sent with every request.
	Query []string `json:"query,omitempty"`
	// CACertPath is an optional PEM CA bundle for this profile.
	CACertPath string `json:"ca_cert,omitempty"`
	// ClientCertPath is the PEM client certificate path for this profile.
	ClientCertPath string `json:"client_cert,omitempty"`
	// ClientKeyPath is the PEM client private key path for this profile.
	ClientKeyPath string `json:"client_key,omitempty"`
	// TLSSigner selects a tls-signer plugin for mTLS client certificate signing.
	TLSSigner string `json:"tls_signer,omitempty"`
	// TLSSignerParams passes plugin-specific configuration to the tls-signer.
	TLSSignerParams map[string]string `json:"tls_signer_params,omitempty"`
	// ServerVariables overrides API-level OpenAPI server URL variables for this
	// profile when generating operation paths.
	ServerVariables map[string]string `json:"server_variables,omitempty"`
	// URLOverrides overrides or extends API-level URL prefix rewrites for this
	// profile.
	URLOverrides map[string]string `json:"url_overrides,omitempty"`
	// Auth holds authentication configuration for this profile.
	Auth *AuthConfig `json:"auth,omitempty"`
	// AuthRef names a top-level auth_profiles entry to use for this profile.
	AuthRef string `json:"auth_ref,omitempty"`
	// Credentials maps operation credential requirement IDs to auth
	// configurations that satisfy them.
	Credentials map[string]*CredentialConfig `json:"credentials,omitempty"`
}

type UnknownFieldDiagnostic struct {
	Path       string
	Field      string
	Line       int
	Column     int
	Suggestion string
	Hint       string
}