openapimcp

type ArgBinding struct {
	ArgName             string // property name in the tool input schema
	Location            string // path | query | header | cookie | querystring
	Name                string // wire parameter name
	Required            bool
	Explode             bool
	Style               string
	ContentType         string // media type the whole value is serialized in (content-declared parameters)
	Group               string // optional 3.2 querystring this field was flattened from
	RequiredIfGroupSent bool   // required whenever any field of Group is sent
}

type BodyBinding struct {
	Mode           string   // flattened | single
	ArgNames       []string // flattened: body properties present at the top level
	SingleArg      string   // single: the one property carrying the whole body
	ContentType    string
	RequiredIfSent []string // flattened, optional body: fields a body must carry whenever one is sent
}

type Document struct {
	Title           string
	Version         string // info.version
	Description     string
	OpenAPIVersion  string // detected spec version, e.g. "2.0", "3.0.3", "3.1.0"
	Self            string // 3.2 $self, if any
	Servers         []string
	SecuritySchemes map[string]SecurityScheme
	GlobalSecurity  []SecurityRequirement
	Operations      []Operation
	Warnings        []string
}

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

type FactoryOption func(*factoryOptions)

type HeaderResolver func(ctx context.Context) (http.Header, error)

type Operation struct {
	ID          string
	Method      string // upper-case HTTP method
	Path        string
	Summary     string
	Description string
	Deprecated  bool
	Tags        []string
	Params      []Parameter
	Body        *RequestBody
	Security    []SecurityRequirement // op-level requirements; meaningful when HasSecurity
	HasSecurity bool                  // op declared its own security (even if empty)
	Servers     []string              // op/path-level server override
	Unsupported string                // non-empty: reason the operation cannot become a tool
}

type Parameter struct {
	Name        string
	In          string
	Description string
	Required    bool
	Explode     *bool
	Style       string // form | simple | spaceDelimited | pipeDelimited | tabDelimited | deepObject | label | matrix
	Schema      map[string]any
	ContentType string // set when declared through `content`: the value is serialized whole in this media type
	Unsupported string // why no value can be sent (schema false); checked after operation-level replacement
}

type ParseOptions struct {
	MaxBytes int    // 0 = MaxSpecBytes
	SpecURL  string // used to resolve relative server URLs
}

type PreviewResult struct {
	Title            string                 `json:"title"`
	Version          string                 `json:"version"`
	OpenAPIVersion   string                 `json:"openapi_version"`
	Description      string                 `json:"description,omitempty"`
	Servers          []string               `json:"servers"`
	BaseURL          string                 `json:"base_url,omitempty"`
	OperationServers bool                   `json:"operation_servers,omitempty"` // no base URL needed: every tool's operation declares its own server
	SecuritySchemes  []SecurityScheme       `json:"security_schemes"`
	Tools            []ToolSummary          `json:"tools"`
	Unsupported      []UnsupportedOperation `json:"unsupported"`
	Warnings         []string               `json:"warnings"`
	ToolCount        int                    `json:"tool_count"`
	SpecSize         int                    `json:"spec_size"`
	SpecHash         string                 `json:"spec_hash"`
}

type RequestBody struct {
	ContentType      string
	Required         bool
	Description      string
	Schema           map[string]any
	FormDelimiters   map[string]string // Form fields whose arrays join into one value with this delimiter (Swagger 2.0 collectionFormat)
	FormObjectStyles map[string]string // Form fields whose objects use a declared style: form (exploded), formPacked or deepObject
}

type SecurityRequirement map[string][]string

type SecurityScheme struct {
	Name        string `json:"name"`
	Type        string `json:"type"`                 // apiKey | http | oauth2 | openIdConnect | mutualTLS
	In          string `json:"in,omitempty"`         // apiKey: header | query | cookie
	ParamName   string `json:"param_name,omitempty"` // apiKey: header/query/cookie name
	Scheme      string `json:"scheme,omitempty"`     // http: bearer | basic | ...
	Description string `json:"description,omitempty"`
	Supported   bool   `json:"supported"`
	Reason      string `json:"reason,omitempty"` // why unsupported
}

type ServerOptions struct {
	ClientName       string
	Synthesis        *Synthesis
	BaseURL          string // resolved upstream base
	BaseURLExplicit  bool   // true when the admin set it; op-level servers are then ignored
	Credentials      map[string]schemas.MCPOpenAPICredential
	HTTPClient       *http.Client
	Headers          HeaderResolver
	MaxResponseBytes int
	Logger           schemas.Logger
}

type Synthesis struct {
	Document    *Document
	Tools       []Tool
	Unsupported []UnsupportedOperation
	Warnings    []string
}

type SynthesizeOptions struct {
	ClientName        string // budgets the tool-name length against the "<client>-" prefix
	IncludeDeprecated bool
}

type Tool struct {
	Name        string
	Operation   Operation
	Description string
	InputSchema json.RawMessage
	Args        []ArgBinding
	Body        *BodyBinding
	Annotations mcp.ToolAnnotation
	Warnings    []string
}

type ToolSummary struct {
	Name        string             `json:"name"`
	OperationID string             `json:"operation_id,omitempty"`
	Method      string             `json:"method"`
	Path        string             `json:"path"`
	Summary     string             `json:"summary,omitempty"`
	Description string             `json:"description,omitempty"`
	Deprecated  bool               `json:"deprecated,omitempty"`
	InputSchema json.RawMessage    `json:"input_schema"`
	Annotations mcp.ToolAnnotation `json:"annotations"`
	Warnings    []string           `json:"warnings,omitempty"`
}

type UnsupportedOperation struct {
	OperationID string `json:"operation_id,omitempty"`
	Method      string `json:"method"`
	Path        string `json:"path"`
	Reason      string `json:"reason"`
}

type Version struct {
	Raw      string // the declared version string
	Swagger2 bool   // Swagger 2.0 document
	Major    int    // 2 or 3
	Minor    int    // 0, 1, 2 (clamped to 2 for newer 3.x minors)
}