model

type ApiBody struct {
	// Name is the parameter that supplies the body, e.g. callbackData for
	// `@RequestBody String callbackData`. A formatter keeps it visible when the
	// body carries no fields of its own, where the parameter name is the only
	// thing distinguishing one scalar payload from another. Empty for a
	// response, which no parameter supplies.
	Name      string       `json:"name,omitempty"`
	MediaType string       `json:"mediaType,omitempty"`
	Body      *ObjectModel `json:"body,omitempty"`
	Example   any          `json:"example,omitempty"`
}

type ApiEndpoint struct {
	Name        string         `json:"name"`
	Folder      string         `json:"folder,omitempty"`
	Description string         `json:"description,omitempty"`
	Tags        []string       `json:"tags,omitempty"`
	Path        string         `json:"path"`
	Method      string         `json:"method,omitempty"` // empty for non-HTTP protocols
	Protocol    string         `json:"protocol"`         // "http", "grpc", "websocket", etc.
	Parameters  []ApiParameter `json:"parameters,omitempty"`
	Headers     []ApiHeader    `json:"headers,omitempty"`
	RequestBody *ApiBody       `json:"requestBody,omitempty"`
	Response    *ApiBody       `json:"response,omitempty"`
	// Consumes lists the request media types the endpoint declares (JAX-RS
	// @Consumes, Spring consumes=...). Empty when the source declares none, so
	// a formatter can tell a declared content type from a collector default.
	Consumes []string `json:"consumes,omitempty"`
	// Produces lists the response media types the endpoint declares (JAX-RS
	// @Produces, Spring produces=...). Empty when the source declares none.
	Produces []string `json:"produces,omitempty"`
	// Metadata holds protocol-specific extensions without polluting the core struct.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type ApiHeader struct {
	Name        string `json:"name"`
	Value       string `json:"value,omitempty"`
	Description string `json:"description,omitempty"`
	Example     string `json:"example,omitempty"`
	Required    bool   `json:"required"`
}

type ApiParameter struct {
	Name string `json:"name"`
	// Type is the parameter kind: "text" or "file". A file parameter is a
	// multipart part, never a query argument.
	Type     string `json:"type"` // "text" | "file"
	Required bool   `json:"required"`
	In       string `json:"in"` // "query" | "path" | "header" | "cookie" | "body" | "form"
	// TypeName is the declared type in the source language, e.g. "Long" or
	// "String", so a caller can tell them apart. Empty when the collector
	// cannot name the type.
	TypeName    string   `json:"typeName,omitempty"`
	Default     string   `json:"default,omitempty"`
	Description string   `json:"description,omitempty"`
	Example     string   `json:"example,omitempty"`
	Enum        []string `json:"enum,omitempty"`
}

type FieldModel struct {
	Model        *ObjectModel   `json:"model"`
	Comment      string         `json:"comment,omitempty"`
	Required     bool           `json:"required"`
	DefaultValue string         `json:"defaultValue,omitempty"`
	Options      []FieldOption  `json:"options,omitempty"`
	Demo         string         `json:"demo,omitempty"`
	Advanced     map[string]any `json:"advanced,omitempty"`
	Generic      bool           `json:"generic,omitempty"`
}

type FieldOpt func(*FieldModel)

type FieldOption struct {
	Value any    `json:"value"`
	Desc  string `json:"desc,omitempty"`
}

type ObjectModel struct {
	Kind       ObjectModelKind        `json:"kind"`
	TypeName   string                 `json:"typeName"`
	Fields     map[string]*FieldModel `json:"fields,omitempty"`
	Items      *ObjectModel           `json:"items,omitempty"`
	KeyModel   *ObjectModel           `json:"keyModel,omitempty"`
	ValueModel *ObjectModel           `json:"valueModel,omitempty"`
}

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

type ObjectModelKind string