Documentation
¶
Index ¶
- Constants
- type Capabilities
- type Capability
- type CapabilityBasic
- type CapabilityMatch
- type CapabilitySet
- type CapabilityVector
- func (z *CapabilityVector) Creating() error
- func (_ *CapabilityVector) IdentityAlias() string
- func (_ *CapabilityVector) IdentityLabel() string
- func (_ *CapabilityVector) IdentityModel() string
- func (_ *CapabilityVector) IdentityTable() string
- func (z *CapabilityVector) SetWith(o CapabilityVectorSet)
- type CapabilityVectorBasic
- type CapabilityVectorSet
- type CapabilityVectors
- type SwaggerParam
- type SwaggerResponse
- type SwaggerSchema
Constants ¶
const ( CapabilityTable = "api_capability" CapabilityAlias = "ac" CapabilityLabel = "capability" CapabilityTypID = "capability" )
consts of Capability API
const ( CapabilityVectorTable = "api_capability_vector" CapabilityVectorAlias = "cv" CapabilityVectorLabel = "capabilityVector" CapabilityVectorTypID = "capabilityCapabilityVector" )
consts of CapabilityVector API
const ( SwaggerParamLabel = "swaggerParam" SwaggerParamTypID = "capabilitySwaggerParam" )
consts of SwaggerParam swagger
const ( SwaggerSchemaLabel = "swaggerSchema" SwaggerSchemaTypID = "capabilitySwaggerSchema" )
consts of SwaggerSchema swagger
const ( SwaggerResponseLabel = "swaggerResponse" SwaggerResponseTypID = "capabilitySwaggerResponse" )
consts of SwaggerResponse swagger
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Capabilities ¶
type Capabilities []Capability
func (Capabilities) Endpoints ¶
func (z Capabilities) Endpoints() []string
type Capability ¶
type Capability struct {
comm.BaseModel `bun:"table:api_capability,alias:ac" json:"-"`
comm.DefaultModel
CapabilityBasic
comm.MetaField
} // @name capability
Capability API 能力描述
func NewCapabilityWithBasic ¶
func NewCapabilityWithBasic(in CapabilityBasic) *Capability
func NewCapabilityWithID ¶
func NewCapabilityWithID(id any) *Capability
func (*Capability) Creating ¶
func (z *Capability) Creating() error
Creating function call to it's inner fields defined hooks
func (*Capability) IdentityAlias ¶
func (_ *Capability) IdentityAlias() string
func (*Capability) IdentityLabel ¶
func (_ *Capability) IdentityLabel() string
func (*Capability) IdentityModel ¶
func (_ *Capability) IdentityModel() string
func (*Capability) IdentityTable ¶
func (_ *Capability) IdentityTable() string
func (*Capability) SetWith ¶
func (z *Capability) SetWith(o CapabilitySet)
type CapabilityBasic ¶
type CapabilityBasic struct {
// operationId(可为空,公开接口无此字段)
OperationID string `` /* 142-byte string literal not displayed */
// API 路径,如 /api/accounts/{id}
Endpoint string `` /* 135-byte string literal not displayed */
// HTTP 方法 GET/POST/PUT/DELETE 等
Method string `` /* 127-byte string literal not displayed */
// 简短描述
Summary string `bson:"summary" bun:",notnull,type:text" extensions:"x-order=D" form:"summary" json:"summary" pg:",notnull,type:text"`
// 详细描述
Description string `` /* 128-byte string literal not displayed */
// 参数结构 JSON
Parameters []SwaggerParam `` /* 145-byte string literal not displayed */
// 响应结构 map[code]SwaggerResponse
Responses map[string]SwaggerResponse `` /* 143-byte string literal not displayed */
// API 标签
Tags []string `` /* 133-byte string literal not displayed */
// for meta update
MetaDiff *comm.MetaDiff `bson:"-" bun:"-" json:"metaUp,omitempty" pg:"-" swaggerignore:"true"`
} // @name capabilityBasic
func (*CapabilityBasic) EnrichSortableFields ¶
func (z *CapabilityBasic) EnrichSortableFields()
EnrichSortableFields extracts <sortable>field1,field2...</sortable> from Description and appends the sortable fields info to Parameters[sort].Description if sort param exists
func (*CapabilityBasic) GetSubject ¶
func (z *CapabilityBasic) GetSubject() string
GetSubject returns the capability subject (tags + summary + description)
func (*CapabilityBasic) GetSubjectWithParams ¶
func (z *CapabilityBasic) GetSubjectWithParams() string
GetSubjectWithParams returns subject enhanced with parameters info
func (*CapabilityBasic) MetaAddKVs ¶
func (in *CapabilityBasic) MetaAddKVs(args ...any) *CapabilityBasic
type CapabilityMatch ¶
type CapabilityMatch = aigc.MatchResult
CapabilityMatch 能力匹配结果 - 复用 MatchResult
type CapabilitySet ¶
type CapabilitySet struct {
// operationId(可为空,公开接口无此字段)
OperationID *string `extensions:"x-order=A" json:"operationID"`
// API 路径,如 /api/accounts/{id}
Endpoint *string `extensions:"x-order=B" json:"endpoint"`
// HTTP 方法 GET/POST/PUT/DELETE 等
Method *string `extensions:"x-order=C" json:"method"`
// 简短描述
Summary *string `extensions:"x-order=D" json:"summary"`
// 详细描述
Description *string `extensions:"x-order=E" json:"description"`
// 参数结构 JSON
Parameters *[]SwaggerParam `extensions:"x-order=F" json:"parameters,omitempty"`
// 响应结构 map[code]SwaggerResponse
Responses *map[string]SwaggerResponse `extensions:"x-order=G" json:"responses,omitempty"`
// API 标签
Tags *[]string `extensions:"x-order=H" json:"tags,omitempty"`
// for meta update
MetaDiff *comm.MetaDiff `json:"metaUp,omitempty" swaggerignore:"true"`
} // @name capabilitySet
func (*CapabilitySet) MetaAddKVs ¶
func (in *CapabilitySet) MetaAddKVs(args ...any) *CapabilitySet
type CapabilityVector ¶
type CapabilityVector struct {
comm.BaseModel `bun:"table:api_capability_vector,alias:cv" json:"-"`
comm.DefaultModel
CapabilityVectorBasic
comm.MetaField
} // @name capabilityCapabilityVector
CapabilityVector API 能力向量
func NewCapabilityVectorWithBasic ¶
func NewCapabilityVectorWithBasic(in CapabilityVectorBasic) *CapabilityVector
func NewCapabilityVectorWithID ¶
func NewCapabilityVectorWithID(id any) *CapabilityVector
func (*CapabilityVector) Creating ¶
func (z *CapabilityVector) Creating() error
Creating function call to it's inner fields defined hooks
func (*CapabilityVector) IdentityAlias ¶
func (_ *CapabilityVector) IdentityAlias() string
func (*CapabilityVector) IdentityLabel ¶
func (_ *CapabilityVector) IdentityLabel() string
func (*CapabilityVector) IdentityModel ¶
func (_ *CapabilityVector) IdentityModel() string
func (*CapabilityVector) IdentityTable ¶
func (_ *CapabilityVector) IdentityTable() string
func (*CapabilityVector) SetWith ¶
func (z *CapabilityVector) SetWith(o CapabilityVectorSet)
type CapabilityVectorBasic ¶
type CapabilityVectorBasic struct {
// 关联的 Capability ID
CapID oid.OID `bson:"capID" bun:"cap_id,notnull" extensions:"x-order=A" json:"capID" pg:"cap_id,notnull" swaggertype:"string"`
// 主题 基于 summary + description 等生成
Subject string `` /* 130-byte string literal not displayed */
// 语义向量 1024 维
Vector corpus.Vector `` /* 133-byte string literal not displayed */
// for meta update
MetaDiff *comm.MetaDiff `bson:"-" bun:"-" json:"metaUp,omitempty" pg:"-" swaggerignore:"true"`
} // @name capabilityCapabilityVectorBasic
func (*CapabilityVectorBasic) MetaAddKVs ¶
func (in *CapabilityVectorBasic) MetaAddKVs(args ...any) *CapabilityVectorBasic
type CapabilityVectorSet ¶
type CapabilityVectorSet struct {
// 关联的 Capability ID
CapID *string `extensions:"x-order=A" json:"capID"`
// 主题 基于 summary + description 等生成
Subject *string `extensions:"x-order=B" json:"subject"`
// 语义向量 1024 维
Vector *corpus.Vector `extensions:"x-order=C" json:"vector"`
// for meta update
MetaDiff *comm.MetaDiff `json:"metaUp,omitempty" swaggerignore:"true"`
} // @name capabilityCapabilityVectorSet
func (*CapabilityVectorSet) MetaAddKVs ¶
func (in *CapabilityVectorSet) MetaAddKVs(args ...any) *CapabilityVectorSet
type CapabilityVectors ¶
type CapabilityVectors []CapabilityVector
type SwaggerParam ¶
type SwaggerParam struct {
// 参数类型
Type string `extensions:"x-order=A" form:"type" json:"type" yaml:"type"`
// 参数描述
Description string `extensions:"x-order=B" form:"description" json:"description" yaml:"description"`
// 参数名称
Name string `extensions:"x-order=C" form:"name" json:"name" yaml:"name"`
// 参数位置 header/query/body/path
In string `extensions:"x-order=D" form:"in" json:"in" yaml:"in"`
// 是否必填
Required bool `extensions:"x-order=E" form:"required" json:"required,omitempty" yaml:"required"`
// 参数示例
Example string `extensions:"x-order=F" form:"example" json:"example,omitempty" yaml:"example"`
// schema 定义
Schema any `extensions:"x-order=G" json:"schema,omitempty" yaml:"schema"`
} // @name capabilitySwaggerParam
SwaggerParam swagger 参数定义
func FilterParams ¶
func FilterParams(params []SwaggerParam, excludeName string) []SwaggerParam
FilterParams removes parameters with the specified name from the list
type SwaggerResponse ¶
type SwaggerResponse struct {
// 响应描述
Description string `extensions:"x-order=A" form:"description" json:"description" yaml:"description"`
// schema 定义
Schema SwaggerSchema `extensions:"x-order=B" json:"schema,omitempty" yaml:"schema"`
} // @name capabilitySwaggerResponse
SwaggerResponse swagger 响应定义
type SwaggerSchema ¶
type SwaggerSchema struct {
// 引用路径如
Ref string `extensions:"x-order=A" form:"$ref" json:"$ref,omitempty" yaml:"$ref"`
// 类型
Type string `extensions:"x-order=B" form:"type" json:"type,omitempty" yaml:"type"`
// 描述
Description string `extensions:"x-order=C" form:"description" json:"description,omitempty" yaml:"description"`
// allOf 组合
AllOf []SwaggerSchema `extensions:"x-order=D" json:"allOf,omitempty" yaml:"allOf"`
// 属性定义
Properties map[string]SwaggerSchema `extensions:"x-order=E" json:"properties,omitempty" yaml:"properties"`
} // @name capabilitySwaggerSchema
SwaggerSchema swagger schema 定义