An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
TypeScript agentic-aiai-agentknowledge-baselocal-firstmarkdownmcpmindmapnote-takingself-hostedsiyuanworkspace
// SiYuan - https://github.com/siyuan-note/siyuan
// Copyright (c) 2020-present, b3log.org
// SPDX-License-Identifier: AGPL-3.0-or-later
package apicontract
type AVTable struct {
// 仅日历布局返回字段绑定及一周起始日;创建、更新系统时间作为只读日期源。
Calendar *AVCalendarSettings `json:"calendar,omitempty" api:"optional"`
// 回显本次请求的日期范围,省略范围的请求不返回此字段。
CalendarRange *AVCalendarRange `json:"calendarRange,omitempty" api:"optional"`
// 可访问且通过筛选的定位条目的开始时间,单位为毫秒;无有效定位日期时省略。
// 发布读取先过滤不可访问条目,再重新计算此日期、定位行索引及 rowCount。
CalendarTargetDate *int64 `json:"calendarTargetDate,omitempty" api:"optional"`
*AVBaseInstance
Columns []*AVTableColumn `json:"columns" api:"optional,nullable"`
Rows []*AVTableRow `json:"rows" api:"optional,nullable"`
RowCount int `json:"rowCount" api:"optional,nullable"`
}
type AVBaseInstance struct {
ConditionalColors []*AVConditionalColorRule `json:"conditionalColors" api:"optional,nullable"`
ID string `json:"id" api:"optional,nullable"`
Icon string `json:"icon" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
Desc string `json:"desc" api:"optional,nullable"`
HideAttrViewName bool `json:"hideAttrViewName" api:"optional,nullable"`
Filters []*AVViewFilter `json:"filters" api:"optional,nullable"`
Sorts []*AVViewSort `json:"sorts" api:"optional,nullable"`
Group *AVViewGroup `json:"group" api:"optional,nullable"`
PageSize int `json:"pageSize" api:"optional,nullable"`
ShowIcon bool `json:"showIcon" api:"optional,nullable"`
WrapField bool `json:"wrapField" api:"optional,nullable"`
GroupKey *AVKey `json:"groupKey,omitempty" api:"optional,nullable"`
GroupValue *AVValue `json:"groupValue,omitempty" api:"optional,nullable"`
Groups []AVViewInstance `json:"groups,omitempty" api:"optional,nullable"`
GroupCalc *AVGroupCalc `json:"groupCalc,omitempty" api:"optional,nullable"`
GroupFolded bool `json:"groupFolded" api:"optional,nullable"`
GroupHidden int `json:"groupHidden" api:"optional,nullable"`
}
type AVViewFilter struct {
Column string `json:"column" api:"optional,nullable"`
ValueSource string `json:"valueSource,omitempty" api:"optional,nullable,enum=stored|rendered"`
Qualifier string `json:"quantifier,omitempty" api:"optional,nullable"`
Operator string `json:"operator" api:"optional,nullable,enum=|=|!=|>|>=|<|<=|Contains|Does not contains|Contains any item|Does not contain any item|Is empty|Is not empty|Starts with|Ends with|Is between|Is true|Is false"`
Value *AVValue `json:"value" api:"optional,nullable"`
RelativeDate *AVRelativeDate `json:"relativeDate,omitempty" api:"optional,nullable"`
RelativeDate2 *AVRelativeDate `json:"relativeDate2,omitempty" api:"optional,nullable"`
DateEndpoint string `json:"dateEndpoint,omitempty" api:"optional,nullable,enum=start|end"`
Combination string `json:"combination,omitempty" api:"optional,nullable,enum=and|or"`
Filters []*AVViewFilter `json:"filters,omitempty" api:"optional,nullable"`
}
type AVValue struct {
ID string `json:"id,omitempty" api:"optional,nullable"`
KeyID string `json:"keyID,omitempty" api:"optional,nullable"`
BlockID string `json:"blockID,omitempty" api:"optional,nullable"`
Type string `json:"type,omitempty" api:"optional,nullable,enum=block|text|number|date|select|mSelect|url|email|phone|location|mAsset|template|created|updated|checkbox|relation|rollup|lineNumber"`
IsDetached bool `json:"isDetached,omitempty" api:"optional,nullable"`
CreatedAt int64 `json:"createdAt,omitempty" api:"optional,nullable"`
UpdatedAt int64 `json:"updatedAt,omitempty" api:"optional,nullable"`
Block *AVValueBlock `json:"block,omitempty" api:"optional,nullable"`
Text *AVValueText `json:"text,omitempty" api:"optional,nullable"`
Number *AVValueNumber `json:"number,omitempty" api:"optional,nullable"`
Date *AVValueDate `json:"date,omitempty" api:"optional,nullable"`
MSelect []*AVValueSelect `json:"mSelect,omitempty" api:"optional,nullable"`
URL *AVValueURL `json:"url,omitempty" api:"optional,nullable"`
Email *AVValueEmail `json:"email,omitempty" api:"optional,nullable"`
Phone *AVValuePhone `json:"phone,omitempty" api:"optional,nullable"`
Location *AVValueLocation `json:"location,omitempty" api:"optional,nullable"`
MAsset []*AVValueAsset `json:"mAsset,omitempty" api:"optional,nullable"`
Template *AVValueTemplate `json:"template,omitempty" api:"optional,nullable"`
Created *AVValueCreated `json:"created,omitempty" api:"optional,nullable"`
Updated *AVValueUpdated `json:"updated,omitempty" api:"optional,nullable"`
Checkbox *AVValueCheckbox `json:"checkbox,omitempty" api:"optional,nullable"`
Relation *AVValueRelation `json:"relation,omitempty" api:"optional,nullable"`
Rollup *AVValueRollup `json:"rollup,omitempty" api:"optional,nullable"`
RenderedContent string `json:"renderedContent,omitempty" api:"optional,nullable"`
// 显示模板已计算时为 true,空结果仍以模板显示;关联内容使用目标主键模板,原始 block 内容和标识不变。
// 这是运行时显示信息,不写入数据库文件;旧响应未包含此字段时沿用 renderedContent 和字段模板配置。
HasRenderTemplate bool `json:"hasRenderTemplate,omitempty" api:"optional,nullable"`
}
type AVValueBlock struct {
CollectionRuleID string `json:"collectionRuleID,omitempty" api:"optional"`
ID string `json:"id,omitempty" api:"optional,nullable"`
// 游离条目可独立设置图标;绑定条目与目标块共享图标,无图标的普通块在绑定时继承条目图标。
Icon string `json:"icon,omitempty" api:"optional,nullable"`
Content string `json:"content" api:"optional,nullable"`
RefSubtype string `json:"refSubtype,omitempty" api:"optional,nullable,enum=s|d"`
Created int64 `json:"created,omitempty" api:"optional,nullable"`
Updated int64 `json:"updated,omitempty" api:"optional,nullable"`
}
type AVValueText struct {
Content string `json:"content" api:"optional,nullable"`
Rich *AVValueTextRich `json:"rich,omitempty" api:"optional,nullable"`
}
type AVValueTextRich struct {
Spec int `json:"spec" api:"optional,nullable,const=1"`
Format string `json:"format" api:"optional,nullable,enum=kramdown"`
Content string `json:"content" api:"optional,nullable"`
}
type AVValueNumber struct {
Content float64 `json:"content" api:"optional,nullable"`
IsNotEmpty bool `json:"isNotEmpty" api:"optional,nullable"`
Format string `json:"format" api:"optional,nullable"`
FormattedContent string `json:"formattedContent" api:"optional,nullable"`
}
type AVValueDate struct {
Content int64 `json:"content" api:"optional,nullable"`
IsNotEmpty bool `json:"isNotEmpty" api:"optional,nullable"`
HasEndDate bool `json:"hasEndDate" api:"optional,nullable"`
IsNotTime bool `json:"isNotTime" api:"optional,nullable"`
Content2 int64 `json:"content2" api:"optional,nullable"`
IsNotEmpty2 bool `json:"isNotEmpty2" api:"optional,nullable"`
FormattedContent string `json:"formattedContent" api:"optional,nullable"`
}
type AVValueSelect struct {
Content string `json:"content" api:"optional,nullable"`
Color string `json:"color" api:"optional,nullable"`
ResolvedColor *AVAttributeViewColor `json:"resolvedColor,omitempty" api:"optional,nullable"`
}
type AVAttributeViewColor struct {
Light AVAttributeViewColorTheme `json:"light" api:"optional,nullable"`
Dark AVAttributeViewColorTheme `json:"dark" api:"optional,nullable"`
}
type AVAttributeViewColorTheme struct {
Color string `json:"color" api:"optional,nullable"`
BackgroundColor string `json:"backgroundColor" api:"optional,nullable"`
}
type AVValueURL struct {
Content string `json:"content" api:"optional,nullable"`
}
type AVValueEmail struct {
Content string `json:"content" api:"optional,nullable"`
}
type AVValuePhone struct {
Content string `json:"content" api:"optional,nullable"`
}
// AVValueLocation 保存单个位置的 WGS84 坐标,不执行坐标系转换。
// API 使用具名成员,不接受无标签的坐标数组。
// 界面按经度、纬度显示并使用具名字段输入;规范文本复制与导出保留纬度、经度顺序。
// 纬度和经度必须同时为空或同时提供,范围分别为 [-90,90] 和 [-180,180],零是有效坐标。
// 更新时省略成员保留原值,显式 null 同时清空两个坐标;名称可以独立存在。
// 位置值拒绝坐标系及其他额外字段,字段不提供默认坐标系设置。
// 位置字段的文本筛选条件放在 AVValue.Text.Content,不将搜索词解析成坐标。
type AVValueLocation struct {
Name string `json:"name,omitempty" api:"optional,nullable"`
Latitude *float64 `json:"latitude,omitempty" api:"optional,nullable"`
Longitude *float64 `json:"longitude,omitempty" api:"optional,nullable"`
// 来源文本不参与判空、筛选和排序。仅修改名称时保留;修改坐标时若省略则清空。
OriginalInput string `json:"originalInput,omitempty" api:"optional,nullable"`
}
type AVValueAsset struct {
Type string `json:"type" api:"optional,nullable,enum=file|image"`
Name string `json:"name" api:"optional,nullable"`
Content string `json:"content" api:"optional,nullable"`
}
type AVValueTemplate struct {
Content string `json:"content" api:"optional,nullable"`
}
type AVValueCreated struct {
Content int64 `json:"content" api:"optional,nullable"`
IsNotEmpty bool `json:"isNotEmpty" api:"optional,nullable"`
Content2 int64 `json:"content2" api:"optional,nullable"`
IsNotEmpty2 bool `json:"isNotEmpty2" api:"optional,nullable"`
FormattedContent string `json:"formattedContent" api:"optional,nullable"`
}
type AVValueUpdated struct {
Content int64 `json:"content" api:"optional,nullable"`
IsNotEmpty bool `json:"isNotEmpty" api:"optional,nullable"`
Content2 int64 `json:"content2" api:"optional,nullable"`
IsNotEmpty2 bool `json:"isNotEmpty2" api:"optional,nullable"`
FormattedContent string `json:"formattedContent" api:"optional,nullable"`
}
type AVValueCheckbox struct {
Checked bool `json:"checked" api:"optional,nullable"`
}
type AVValueRelation struct {
BlockIDs []string `json:"blockIDs" api:"optional,nullable"`
Contents []*AVValue `json:"contents" api:"optional,nullable"`
}
type AVValueRollup struct {
Contents []*AVValue `json:"contents" api:"optional,nullable"`
}
type AVRelativeDate struct {
Count int `json:"count" api:"optional,nullable"`
Unit int `json:"unit" api:"optional,nullable"`
Direction int `json:"direction" api:"optional,nullable"`
}
type AVViewSort struct {
Column string `json:"column" api:"optional,nullable"`
ValueSource string `json:"valueSource,omitempty" api:"optional,nullable,enum=stored|rendered"`
Order string `json:"order" api:"optional,nullable,enum=|ASC|DESC"`
DateEndpoint string `json:"dateEndpoint,omitempty" api:"optional,nullable,enum=start|end"`
}
type AVViewGroup struct {
Field string `json:"field" api:"optional,nullable"`
ValueSource string `json:"valueSource,omitempty" api:"optional,nullable,enum=stored|rendered"`
Method int `json:"method" api:"optional,nullable"`
Range *AVGroupRange `json:"range,omitempty" api:"optional,nullable"`
Order int `json:"order" api:"optional,nullable"`
HideEmpty bool `json:"hideEmpty" api:"optional,nullable"`
}
type AVGroupRange struct {
NumStart float64 `json:"numStart" api:"optional,nullable"`
NumEnd float64 `json:"numEnd" api:"optional,nullable"`
NumStep float64 `json:"numStep" api:"optional,nullable"`
}
type AVKey struct {
// 属性面板字段可见性:空值沿用全局设置,always 始终显示,hide-empty 空白时隐藏,hide 始终隐藏。
AttributePanelVisibility string `json:"attributePanelVisibility,omitempty" api:"optional,nullable,enum=|always|hide-empty|hide"`
ID string `json:"id" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
Type string `json:"type" api:"optional,nullable,enum=block|text|number|date|select|mSelect|url|email|phone|location|mAsset|template|created|updated|checkbox|relation|rollup|lineNumber"`
Icon string `json:"icon" api:"optional,nullable"`
Desc string `json:"desc" api:"optional,nullable"`
Options []*AVSelectOption `json:"options,omitempty" api:"optional,nullable"`
NumberFormat string `json:"numberFormat" api:"optional,nullable"`
// lunar 为日期字段的整列农历录入与显示设置,时间戳保持不变,旧格式及空值仍使用公历。
// 离线对照表覆盖公历 1901-02-19 至 2100-12-31,范围外的旧值保留并显示范围提示。
DateFormat string `json:"dateFormat,omitempty" api:"optional,nullable,enum=|full|month-day-year|day-month-year|year-month-day|lunar"`
Template string `json:"template" api:"optional,nullable"`
RenderTemplate string `json:"renderTemplate,omitempty" api:"optional,nullable"`
Relation *AVRelation `json:"relation,omitempty" api:"optional,nullable"`
Rollup *AVRollup `json:"rollup,omitempty" api:"optional,nullable"`
Date *AVDate `json:"date,omitempty" api:"optional,nullable"`
Created *AVCreated `json:"created,omitempty" api:"optional,nullable"`
Updated *AVUpdated `json:"updated,omitempty" api:"optional,nullable"`
}
type AVSelectOption struct {
Name string `json:"name" api:"optional,nullable"`
Color string `json:"color" api:"optional,nullable"`
Desc string `json:"desc" api:"optional,nullable"`
ResolvedColor *AVAttributeViewColor `json:"resolvedColor,omitempty" api:"optional,nullable"`
}
type AVRelation struct {
AvID string `json:"avID" api:"optional,nullable"`
IsTwoWay bool `json:"isTwoWay" api:"optional,nullable"`
BackKeyID string `json:"backKeyID" api:"optional,nullable"`
CandidateFilters []*AVViewFilter `json:"candidateFilters,omitempty" api:"optional,nullable"`
}
type AVRollup struct {
RelationKeyID string `json:"relationKeyID" api:"optional,nullable"`
KeyID string `json:"keyID" api:"optional,nullable"`
Calc *AVRollupCalc `json:"calc" api:"optional,nullable"`
Filters []*AVViewFilter `json:"filters,omitempty" api:"optional,nullable"`
}
type AVRollupCalc struct {
Operator string `json:"operator" api:"optional,nullable"`
Result *AVValue `json:"result" api:"optional,nullable"`
}
type AVDate struct {
AutoFillNow bool `json:"autoFillNow" api:"optional,nullable"`
FillSpecificTime bool `json:"fillSpecificTime" api:"optional,nullable"`
}
type AVCreated struct {
IncludeTime bool `json:"includeTime" api:"optional,nullable"`
}
type AVUpdated struct {
IncludeTime bool `json:"includeTime" api:"optional,nullable"`
}
type AVGroupCalc struct {
Field string `json:"field" api:"optional,nullable"`
FieldCalc *AVFieldCalc `json:"calc" api:"optional,nullable"`
}
type AVFieldCalc struct {
Operator string `json:"operator" api:"optional,nullable"`
Result *AVValue `json:"result" api:"optional,nullable"`
Template string `json:"template,omitempty" api:"optional,nullable"`
}
type AVTableColumn struct {
*AVBaseInstanceField
Pin bool `json:"pin" api:"optional,nullable"`
Width string `json:"width" api:"optional,nullable"`
Align string `json:"align" api:"optional,nullable,enum=|left|center|right"`
}
type AVBaseInstanceField struct {
ID string `json:"id" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
Type string `json:"type" api:"optional,nullable,enum=block|text|number|date|select|mSelect|url|email|phone|location|mAsset|template|created|updated|checkbox|relation|rollup|lineNumber"`
Icon string `json:"icon" api:"optional,nullable"`
Wrap bool `json:"wrap" api:"optional,nullable"`
Hidden bool `json:"hidden" api:"optional,nullable"`
Desc string `json:"desc" api:"optional,nullable"`
Calc *AVFieldCalc `json:"calc" api:"optional,nullable"`
Options []*AVSelectOption `json:"options,omitempty" api:"optional,nullable"`
NumberFormat string `json:"numberFormat" api:"optional,nullable"`
// lunar 按字段启用农历,单元格继续返回原始毫秒时间戳;范围与兼容语义见 AVKey.DateFormat。
DateFormat string `json:"dateFormat,omitempty" api:"optional,nullable,enum=|full|month-day-year|day-month-year|year-month-day|lunar"`
Template string `json:"template" api:"optional,nullable"`
RenderTemplate string `json:"renderTemplate,omitempty" api:"optional,nullable"`
Relation *AVRelation `json:"relation,omitempty" api:"optional,nullable"`
Rollup *AVRollup `json:"rollup,omitempty" api:"optional,nullable"`
Date *AVDate `json:"date,omitempty" api:"optional,nullable"`
Created *AVCreated `json:"created,omitempty" api:"optional,nullable"`
Updated *AVUpdated `json:"updated,omitempty" api:"optional,nullable"`
}
type AVTableRow struct {
ConditionalColors *AVItemConditionalColors `json:"conditionalColors,omitempty" api:"optional"`
ID string `json:"id" api:"optional,nullable"`
Cells []*AVTableCell `json:"cells" api:"optional,nullable"`
}
type AVTableCell struct {
*AVBaseValue
Color string `json:"color" api:"optional,nullable"`
BgColor string `json:"bgColor" api:"optional,nullable"`
}
type AVBaseValue struct {
ID string `json:"id" api:"optional,nullable"`
Value *AVValue `json:"value" api:"optional,nullable"`
ValueType string `json:"valueType" api:"optional,nullable,enum=block|text|number|date|select|mSelect|url|email|phone|location|mAsset|template|created|updated|checkbox|relation|rollup|lineNumber"`
}
type AVGallery struct {
*AVBaseInstance
CoverFrom int `json:"coverFrom" api:"optional,nullable"`
CoverFromAssetKeyID string `json:"coverFromAssetKeyID,omitempty" api:"optional,nullable"`
CardAspectRatio int `json:"cardAspectRatio" api:"optional,nullable"`
CardAspectRatioValue float64 `json:"cardAspectRatioValue" api:"optional,nullable"`
CardSize int `json:"cardSize" api:"optional,nullable"`
CardWidth int `json:"cardWidth" api:"optional,nullable"`
CardLayout int `json:"cardLayout" api:"optional,nullable"`
FitImage bool `json:"fitImage" api:"optional,nullable"`
DisplayFieldName bool `json:"displayFieldName" api:"optional,nullable"`
DisplayEmptyFields bool `json:"displayEmptyFields" api:"optional,nullable"`
Fields []*AVGalleryField `json:"fields" api:"optional,nullable"`
Cards []*AVGalleryCard `json:"cards" api:"optional,nullable"`
CardCount int `json:"cardCount" api:"optional,nullable"`
}
type AVGalleryField struct {
*AVBaseInstanceField
FullRow bool `json:"fullRow" api:"optional,nullable"`
}
type AVGalleryCard struct {
ConditionalColors *AVItemConditionalColors `json:"conditionalColors,omitempty" api:"optional"`
ID string `json:"id" api:"optional,nullable"`
Values []*AVGalleryFieldValue `json:"values" api:"optional,nullable"`
CoverURL string `json:"coverURL" api:"optional,nullable"`
CoverContent string `json:"coverContent" api:"optional,nullable"`
CoverPosition *AVCardCoverPosition `json:"coverPosition,omitempty" api:"optional,nullable"`
}
type AVGalleryFieldValue struct {
*AVBaseValue
}
type AVCardCoverPosition struct {
Image string `json:"image" api:"optional,nullable"`
X float64 `json:"x" api:"optional,nullable"`
Y float64 `json:"y" api:"optional,nullable"`
}
type AVKanban struct {
*AVBaseInstance
CoverFrom int `json:"coverFrom" api:"optional,nullable"`
CoverFromAssetKeyID string `json:"coverFromAssetKeyID,omitempty" api:"optional,nullable"`
CardAspectRatio int `json:"cardAspectRatio" api:"optional,nullable"`
CardAspectRatioValue float64 `json:"cardAspectRatioValue" api:"optional,nullable"`
CardSize int `json:"cardSize" api:"optional,nullable"`
CardWidth int `json:"cardWidth" api:"optional,nullable"`
CardLayout int `json:"cardLayout" api:"optional,nullable"`
FitImage bool `json:"fitImage" api:"optional,nullable"`
DisplayFieldName bool `json:"displayFieldName" api:"optional,nullable"`
DisplayEmptyFields bool `json:"displayEmptyFields" api:"optional,nullable"`
FillColBackgroundColor bool `json:"fillColBackgroundColor" api:"optional,nullable"`
Fields []*AVKanbanField `json:"fields" api:"optional,nullable"`
Cards []*AVKanbanCard `json:"cards" api:"optional,nullable"`
CardCount int `json:"cardCount" api:"optional,nullable"`
}
type AVKanbanField struct {
*AVBaseInstanceField
FullRow bool `json:"fullRow" api:"optional,nullable"`
}
type AVKanbanCard struct {
ConditionalColors *AVItemConditionalColors `json:"conditionalColors,omitempty" api:"optional"`
ID string `json:"id" api:"optional,nullable"`
Values []*AVKanbanFieldValue `json:"values" api:"optional,nullable"`
CoverURL string `json:"coverURL" api:"optional,nullable"`
CoverContent string `json:"coverContent" api:"optional,nullable"`
CoverPosition *AVCardCoverPosition `json:"coverPosition,omitempty" api:"optional,nullable"`
}
type AVKanbanFieldValue struct {
*AVBaseValue
}
type AVKeyValues struct {
Key *AVKey `json:"key" api:"optional,nullable"`
Values []*AVValue `json:"values,omitempty" api:"optional,nullable"`
}
type AVViewData struct {
ID string `json:"id" api:"optional,nullable"`
Icon string `json:"icon" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
Desc string `json:"desc" api:"optional,nullable"`
HideAttrViewName bool `json:"hideAttrViewName" api:"optional,nullable"`
Type string `json:"type" api:"optional,nullable,enum=table|list|gallery|kanban|calendar"`
PageSize int `json:"pageSize" api:"optional,nullable"`
}
type AVNewItemTemplate struct {
ID string `json:"id" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
// 游离条目和文档条目均支持预设图标;省略或为空时使用相应的默认图标。
Icon string `json:"icon,omitempty" api:"optional,nullable"`
TargetType string `json:"targetType" api:"optional,nullable,enum=detached|document"`
PrimaryKeyTemplate string `json:"primaryKeyTemplate,omitempty" api:"optional,nullable"`
FieldValues map[string]*AVNewItemFieldValue `json:"fieldValues,omitempty" api:"optional,nullable"`
SaveLocation *AVNewItemSaveLocation `json:"saveLocation,omitempty" api:"optional,nullable"`
ContentTemplatePath string `json:"contentTemplatePath,omitempty" api:"optional,nullable"`
HideInFileTree bool `json:"hideInFileTree,omitempty" api:"optional,nullable"`
// 创建后是否由交互客户端分屏打开绑定或游离条目。省略或 null 时仅日历条目自动打开;false 禁止自动打开。
// 该配置随模板保存,API 调用本身不会打开界面;移动端使用已有的页面或弹层。
OpenAfterCreate *bool `json:"openAfterCreate,omitempty" api:"optional,nullable"`
}
type AVNewItemFieldValue struct {
Mode string `json:"mode" api:"optional,nullable,enum=static|currentTime"`
Value *AVValue `json:"value,omitempty" api:"optional,nullable"`
}
type AVNewItemSaveLocation struct {
BoxID string `json:"boxID,omitempty" api:"optional,nullable"`
PathTemplate string `json:"pathTemplate" api:"optional,nullable"`
}
type AVAttributeViewContextFilter struct {
Spec int `json:"spec" api:"optional,nullable,const=1"`
KeyID string `json:"keyID" api:"optional,nullable"`
}
type AVAttributeViewContextFilterField struct {
ID string `json:"id" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
Icon string `json:"icon" api:"optional,nullable"`
TargetAvID string `json:"targetAvID" api:"optional,nullable"`
}
type AVAttributeViewData struct {
Spec int `json:"spec" api:"optional,nullable"`
ID string `json:"id" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
CustomColors []*AVAttributeViewCustomColor `json:"customColors" api:"optional,nullable"`
KeyValues []*AVKeyValues `json:"keyValues" api:"optional,nullable"`
KeyIDs []string `json:"keyIDs" api:"optional,nullable"`
ViewID string `json:"viewID" api:"optional,nullable"`
Views []*AVView `json:"views" api:"optional,nullable"`
NewItemTemplates []*AVNewItemTemplate `json:"newItemTemplates,omitempty" api:"optional,nullable"`
DefaultTemplateID string `json:"defaultTemplateID,omitempty" api:"optional,nullable"`
Automations *AVAutomationConfig `json:"automations,omitempty" api:"optional"`
CardCoverPositions map[string]map[string]*AVCardCoverPosition `json:"cardCoverPositions,omitempty" api:"optional,nullable"`
}
type AVAttributeViewCustomColor struct {
Index int `json:"index" api:"optional,nullable"`
Hidden bool `json:"hidden,omitempty" api:"optional,nullable"`
AVAttributeViewColor
}
type AVView struct {
ConditionalColors []*AVConditionalColorRule `json:"conditionalColors" api:"optional,nullable"`
ID string `json:"id" api:"optional,nullable"`
Icon string `json:"icon" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
HideAttrViewName bool `json:"hideAttrViewName" api:"optional,nullable"`
Desc string `json:"desc" api:"optional,nullable"`
Filters []*AVViewFilter `json:"filters,omitempty" api:"optional,nullable"`
Sorts []*AVViewSort `json:"sorts,omitempty" api:"optional,nullable"`
PageSize int `json:"pageSize" api:"optional,nullable"`
LayoutType string `json:"type" api:"optional,nullable,enum=table|list|gallery|kanban|calendar"`
Table *AVLayoutTable `json:"table,omitempty" api:"optional,nullable"`
Calendar *AVLayoutCalendar `json:"calendar,omitempty" api:"optional,nullable"`
List *AVLayoutTable `json:"list,omitempty" api:"optional,nullable"`
Gallery *AVLayoutGallery `json:"gallery,omitempty" api:"optional,nullable"`
Kanban *AVLayoutKanban `json:"kanban,omitempty" api:"optional,nullable"`
ItemIDs []string `json:"itemIds,omitempty" api:"optional,nullable"`
Group *AVViewGroup `json:"group,omitempty" api:"optional,nullable"`
GroupCreated int64 `json:"groupCreated" api:"optional,nullable"`
Groups []*AVView `json:"groups,omitempty" api:"optional,nullable"`
GroupItemIDs []string `json:"groupItemIds" api:"optional,nullable"`
GroupCalc *AVGroupCalc `json:"groupCalc,omitempty" api:"optional,nullable"`
GroupKey *AVKey `json:"groupKey,omitempty" api:"optional,nullable"`
GroupVal *AVValue `json:"groupVal,omitempty" api:"optional,nullable"`
GroupFolded bool `json:"groupFolded" api:"optional,nullable"`
GroupHidden int `json:"groupHidden" api:"optional,nullable"`
GroupSort int `json:"groupSort" api:"optional,nullable"`
}
type AVLayoutTable struct {
*AVBaseLayout
Columns []*AVViewTableColumn `json:"columns" api:"optional,nullable"`
}
type AVBaseLayout struct {
Spec int `json:"spec" api:"optional,nullable"`
ID string `json:"id" api:"optional,nullable"`
ShowIcon bool `json:"showIcon" api:"optional,nullable"`
WrapField bool `json:"wrapField" api:"optional,nullable"`
}
type AVViewTableColumn struct {
*AVBaseField
Pin bool `json:"pin" api:"optional,nullable"`
Width string `json:"width" api:"optional,nullable"`
Align string `json:"align,omitempty" api:"optional,nullable,enum=|left|center|right"`
Calc *AVFieldCalc `json:"calc,omitempty" api:"optional,nullable"`
}
type AVBaseField struct {
ID string `json:"id" api:"optional,nullable"`
Wrap bool `json:"wrap" api:"optional,nullable"`
Hidden bool `json:"hidden" api:"optional,nullable"`
Desc string `json:"desc,omitempty" api:"optional,nullable"`
Calc *AVFieldCalc `json:"calc,omitempty" api:"optional,nullable"`
}
type AVLayoutGallery struct {
*AVBaseLayout
CoverFrom int `json:"coverFrom" api:"optional,nullable"`
CoverFromAssetKeyID string `json:"coverFromAssetKeyID,omitempty" api:"optional,nullable"`
CardAspectRatio int `json:"cardAspectRatio" api:"optional,nullable"`
CardAspectRatioValue float64 `json:"cardAspectRatioValue" api:"optional,nullable"`
CardSize int `json:"cardSize" api:"optional,nullable"`
CardWidth int `json:"cardWidth" api:"optional,nullable"`
CardLayout int `json:"cardLayout" api:"optional,nullable"`
FitImage bool `json:"fitImage" api:"optional,nullable"`
DisplayFieldName bool `json:"displayFieldName" api:"optional,nullable"`
DisplayEmptyFields bool `json:"displayEmptyFields" api:"optional,nullable"`
CardFields []*AVViewGalleryCardField `json:"fields" api:"optional,nullable"`
}
type AVViewGalleryCardField struct {
*AVBaseField
FullRow bool `json:"fullRow" api:"optional,nullable"`
}
type AVLayoutKanban struct {
*AVBaseLayout
CoverFrom int `json:"coverFrom" api:"optional,nullable"`
CoverFromAssetKeyID string `json:"coverFromAssetKeyID,omitempty" api:"optional,nullable"`
CardAspectRatio int `json:"cardAspectRatio" api:"optional,nullable"`
CardAspectRatioValue float64 `json:"cardAspectRatioValue" api:"optional,nullable"`
CardSize int `json:"cardSize" api:"optional,nullable"`
CardWidth int `json:"cardWidth" api:"optional,nullable"`
CardLayout int `json:"cardLayout" api:"optional,nullable"`
FitImage bool `json:"fitImage" api:"optional,nullable"`
DisplayFieldName bool `json:"displayFieldName" api:"optional,nullable"`
DisplayEmptyFields bool `json:"displayEmptyFields" api:"optional,nullable"`
FillColBackgroundColor bool `json:"fillColBackgroundColor" api:"optional,nullable"`
Fields []*AVViewKanbanField `json:"fields" api:"optional,nullable"`
}
type AVViewKanbanField struct {
*AVBaseField
FullRow bool `json:"fullRow" api:"optional,nullable"`
}
type AVAttributeViewFieldView struct {
ID string `json:"id" api:"optional,nullable"`
Icon string `json:"icon" api:"optional,nullable"`
Name string `json:"name" api:"optional,nullable"`
Type string `json:"type" api:"optional,nullable,enum=table|list|gallery|kanban|calendar"`
Hidden bool `json:"hidden" api:"optional,nullable"`
}
type AVAvSearchResult struct {
AvID string `json:"avID" api:"optional,nullable"`
AvName string `json:"avName" api:"optional,nullable"`
ViewName string `json:"viewName" api:"optional,nullable"`
ViewID string `json:"viewID" api:"optional,nullable"`
ViewLayout string `json:"viewLayout" api:"optional,nullable,enum=|table|list|gallery|kanban|calendar"`
BlockID string `json:"blockID" api:"optional,nullable"`
HPath string `json:"hPath" api:"optional,nullable"`
Matched bool `json:"matched,omitempty" api:"optional,nullable"`
Children []*AVAvSearchResult `json:"children,omitempty" api:"optional,nullable"`
}
type AVBlockAttributeViewKeys struct {
AvID string `json:"avID" api:"optional,nullable"`
AvName string `json:"avName" api:"optional,nullable"`
CustomColors []*AVAttributeViewCustomColor `json:"customColors" api:"optional,nullable"`
BlockIDs []string `json:"blockIDs" api:"optional,nullable"`
KeyValues []*AVKeyValues `json:"keyValues" api:"optional,nullable"`
ItemPositions []*AVAttributeViewItemPosition `json:"itemPositions" api:"optional,nullable"`
}
type AVAttributeViewItemPosition struct {
ViewID string `json:"viewID" api:"optional,nullable"`
PreviousID string `json:"previousID" api:"optional,nullable"`
Groups []*AVAttributeViewGroupItemPosition `json:"groups" api:"optional,nullable"`
}
type AVAttributeViewGroupItemPosition struct {
GroupID string `json:"groupID" api:"optional,nullable"`
PreviousID string `json:"previousID" api:"optional,nullable"`
}
type AVAttributeViewSearchTarget struct {
AvID string `json:"avID" api:"optional,nullable"`
DatabaseBlockID string `json:"databaseBlockID" api:"optional,nullable"`
NotebookID string `json:"notebookID" api:"optional,nullable"`
ViewID string `json:"viewID,omitempty" api:"optional,nullable"`
GroupID string `json:"groupID,omitempty" api:"optional,nullable"`
ItemID string `json:"itemID" api:"optional,nullable"`
ValueID string `json:"valueID" api:"optional,nullable"`
MatchedValueID string `json:"matchedValueID" api:"optional,nullable"`
MatchedKeyID string `json:"matchedKeyID" api:"optional,nullable"`
Title string `json:"title" api:"optional,nullable"`
BoundBlockID string `json:"boundBlockID" api:"optional,nullable"`
IsDetached bool `json:"isDetached" api:"optional,nullable"`
Keywords []string `json:"keywords" api:"optional,nullable"`
}
type AVAttributeViewBacklinks struct {
Total int `json:"total" api:"optional,nullable"`
Items []*AVAttributeViewBacklink `json:"items" api:"optional,nullable"`
}
type AVAttributeViewBacklink struct {
AvID string `json:"avID" api:"optional,nullable"`
AvName string `json:"avName" api:"optional,nullable"`
BlockIDs []string `json:"blockIDs" api:"optional,nullable"`
DatabaseBlockID string `json:"databaseBlockID" api:"optional,nullable"`
BoxID string `json:"boxID" api:"optional,nullable"`
DatabasePath string `json:"databasePath" api:"optional,nullable"`
ItemID string `json:"itemID" api:"optional,nullable"`
ValueID string `json:"valueID" api:"optional,nullable"`
Title string `json:"title" api:"optional,nullable"`
Icon string `json:"icon" api:"optional,nullable"`
BoundBlockID string `json:"boundBlockID" api:"optional,nullable"`
IsDetached bool `json:"isDetached" api:"optional,nullable"`
Relations []*AVAttributeViewBacklinkRelation `json:"relations" api:"optional,nullable"`
}
type AVAttributeViewBacklinkRelation struct {
KeyID string `json:"keyID" api:"optional,nullable"`
KeyName string `json:"keyName" api:"optional,nullable"`
TargetAvID string `json:"targetAvID" api:"optional,nullable"`
TargetItemID string `json:"targetItemID" api:"optional,nullable"`
}
type AVAttributeViewRenderTarget struct {
Status string `json:"status" api:"optional,nullable,enum=visible|filtered|itemNotFound|groupHidden"`
ItemID string `json:"itemID" api:"optional,nullable"`
GroupID string `json:"groupID,omitempty" api:"optional,nullable"`
Index int `json:"index" api:"optional,nullable"`
Offset int `json:"offset" api:"optional,nullable"`
PageSize int `json:"pageSize" api:"optional,nullable"`
}
type AVCreateAttributeViewItemResult struct {
ItemID string `json:"itemID" api:"optional,nullable"`
BlockID string `json:"blockID" api:"optional,nullable"`
Content string `json:"content" api:"optional,nullable"`
IsDetached bool `json:"isDetached" api:"optional,nullable"`
Warnings []string `json:"warnings,omitempty" api:"optional,nullable"`
// 返回实际使用模板的自动打开偏好;省略时交互客户端按仅日历条目自动打开处理。此字段不会触发服务端界面操作。
OpenAfterCreate *bool `json:"openAfterCreate,omitempty" api:"optional,nullable"`
}
type AVCreateAttributeViewItemDocsResult struct {
ItemIDs []string `json:"itemIDs" api:"optional,nullable"`
BlockIDs []string `json:"blockIDs" api:"optional,nullable"`
SkippedItemIDs []string `json:"skippedItemIDs,omitempty" api:"optional,nullable"`
Warnings []string `json:"warnings,omitempty" api:"optional,nullable"`
}