docs: refine the field descriptions of the theme VO (#133)
完善主题开发文档关于 VO 字段的描述。 /kind documentation Fixes https://github.com/halo-dev/docs/issues/122 ```release-note None ```JohnNiang-patch-1
Ryan Wang
2 years ago
committed by
GitHub
parent
2ed9998d8a
commit
36a4db6796
@ -0,0 +1,31 @@
|
||||
```json title="CategoryVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T13:06:38.512Z", // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"displayName": "string", // 显示名称
|
||||
"slug": "string", // 别名，通常用于生成 status.permalink
|
||||
"description": "string", // 描述
|
||||
"cover": "string", // 封面图
|
||||
"template": "string", // 自定义渲染模板名称
|
||||
"priority": 0, // 排序字段
|
||||
"children": [ // 下级分类，分类的 metadata.name 集合
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"status": {
|
||||
"permalink": "string", // 固定链接
|
||||
"postCount": 0, // 文章数
|
||||
"visiblePostCount": 0 // 已发布文章数
|
||||
},
|
||||
"postCount": 0
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,53 @@
|
||||
```json title="CommentVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T12:16:19.788Z" // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"raw": "string", // 原始文本，一般用于给编辑器使用
|
||||
"content": "string", // 最终渲染的文本
|
||||
"owner": { // 创建者关联
|
||||
"kind": "string",
|
||||
"name": "string",
|
||||
"displayName": "string",
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
}
|
||||
},
|
||||
"userAgent": "string", // 评论者 UserAgent 信息
|
||||
"ipAddress": "string", // 评论者 IP 地址
|
||||
"priority": 0, // 排序字段
|
||||
"top": false, // 是否置顶
|
||||
"allowNotification": true, // 是否允许通知
|
||||
"approved": false,
|
||||
"hidden": false,
|
||||
"subjectRef": { // 引用关联，比如文章、自定义页面
|
||||
"group": "string",
|
||||
"version": "string",
|
||||
"kind": "string",
|
||||
"name": "string"
|
||||
},
|
||||
"lastReadTime": "2022-11-20T12:16:19.788Z"
|
||||
},
|
||||
"status": {
|
||||
"lastReplyTime": "2022-11-20T12:16:19.788Z",
|
||||
"replyCount": 0, // 回复数量
|
||||
"unreadReplyCount": 0,
|
||||
"hasNewReply": true // 是否有新回复
|
||||
},
|
||||
"owner": { // 创建者信息
|
||||
"kind": "string",
|
||||
"name": "string",
|
||||
"displayName": "string",
|
||||
"avatar": "string",
|
||||
"email": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,6 @@
|
||||
```json title="ContentVo"
|
||||
{
|
||||
"raw": "string", // 原始文本，一般用于给编辑器使用
|
||||
"content": "string" // 最终渲染的文本
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,8 @@
|
||||
```json title="Contributor"
|
||||
{
|
||||
"name": "string", // 用户名
|
||||
"displayName": "string", // 显示名称
|
||||
"avatar": "string", // 头像
|
||||
"bio": "string" // 描述
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,21 @@
|
||||
```json title="MenuVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T14:44:58.984Z", // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"displayName": "string", // 显示名称
|
||||
"menuItems": [ // 菜单的菜单项名称集合，即 MenuItem 的 metadata.name 的集合
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"menuItems": "List<#MenuItemVo>" // 菜单项的集合
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,42 @@
|
||||
```json title="ReplyVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T12:25:32.357Z" // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"raw": "string", // 原始文本，一般用于给编辑器使用
|
||||
"content": "string", // 最终渲染的文本
|
||||
"owner": { // 创建者关联
|
||||
"kind": "string",
|
||||
"name": "string",
|
||||
"displayName": "string",
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
}
|
||||
},
|
||||
"userAgent": "string", // 评论者 UserAgent 信息
|
||||
"ipAddress": "string", // 评论者 IP 地址
|
||||
"priority": 0, // 排序字段
|
||||
"top": false, // 是否置顶
|
||||
"allowNotification": true, // 是否允许通知
|
||||
"approved": false,
|
||||
"hidden": false,
|
||||
"commentName": "string", // 被回复的评论名称，即 Comment 的 metadata.name
|
||||
"quoteReply": "string" // 被回复的回复名称，即 Reply 的 metadata.name
|
||||
},
|
||||
"owner": { // 创建者信息
|
||||
"kind": "string",
|
||||
"name": "string",
|
||||
"displayName": "string",
|
||||
"avatar": "string",
|
||||
"email": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,26 @@
|
||||
```json title="TagVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T13:06:38.512Z", // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"displayName": "string", // 显示名称
|
||||
"slug": "string", // 别名，通常用于生成 status.permalink
|
||||
"color": "#F9fEB1", // 背景颜色
|
||||
"cover": "string" // 封面图
|
||||
},
|
||||
"status": {
|
||||
"permalink": "string", // 固定链接
|
||||
"visiblePostCount": 0, // 已发布文章数
|
||||
"postCount": 0 // 文章数
|
||||
},
|
||||
"postCount": 0
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,31 @@
|
||||
```json title="CategoryVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T13:06:38.512Z", // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"displayName": "string", // 显示名称
|
||||
"slug": "string", // 别名，通常用于生成 status.permalink
|
||||
"description": "string", // 描述
|
||||
"cover": "string", // 封面图
|
||||
"template": "string", // 自定义渲染模板名称
|
||||
"priority": 0, // 排序字段
|
||||
"children": [ // 下级分类，分类的 metadata.name 集合
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"status": {
|
||||
"permalink": "string", // 固定链接
|
||||
"postCount": 0, // 文章数
|
||||
"visiblePostCount": 0 // 已发布文章数
|
||||
},
|
||||
"postCount": 0
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,53 @@
|
||||
```json title="CommentVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T12:16:19.788Z" // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"raw": "string", // 原始文本，一般用于给编辑器使用
|
||||
"content": "string", // 最终渲染的文本
|
||||
"owner": { // 创建者关联
|
||||
"kind": "string",
|
||||
"name": "string",
|
||||
"displayName": "string",
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
}
|
||||
},
|
||||
"userAgent": "string", // 评论者 UserAgent 信息
|
||||
"ipAddress": "string", // 评论者 IP 地址
|
||||
"priority": 0, // 排序字段
|
||||
"top": false, // 是否置顶
|
||||
"allowNotification": true, // 是否允许通知
|
||||
"approved": false,
|
||||
"hidden": false,
|
||||
"subjectRef": { // 引用关联，比如文章、自定义页面
|
||||
"group": "string",
|
||||
"version": "string",
|
||||
"kind": "string",
|
||||
"name": "string"
|
||||
},
|
||||
"lastReadTime": "2022-11-20T12:16:19.788Z"
|
||||
},
|
||||
"status": {
|
||||
"lastReplyTime": "2022-11-20T12:16:19.788Z",
|
||||
"replyCount": 0, // 回复数量
|
||||
"unreadReplyCount": 0,
|
||||
"hasNewReply": true // 是否有新回复
|
||||
},
|
||||
"owner": { // 创建者信息
|
||||
"kind": "string",
|
||||
"name": "string",
|
||||
"displayName": "string",
|
||||
"avatar": "string",
|
||||
"email": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,6 @@
|
||||
```json title="ContentVo"
|
||||
{
|
||||
"raw": "string", // 原始文本，一般用于给编辑器使用
|
||||
"content": "string" // 最终渲染的文本
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,8 @@
|
||||
```json title="Contributor"
|
||||
{
|
||||
"name": "string", // 用户名
|
||||
"displayName": "string", // 显示名称
|
||||
"avatar": "string", // 头像
|
||||
"bio": "string" // 描述
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,21 @@
|
||||
```json title="MenuVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T14:44:58.984Z", // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"displayName": "string", // 显示名称
|
||||
"menuItems": [ // 菜单的菜单项名称集合，即 MenuItem 的 metadata.name 的集合
|
||||
"string"
|
||||
]
|
||||
},
|
||||
"menuItems": "List<#MenuItemVo>" // 菜单项的集合
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,42 @@
|
||||
```json title="ReplyVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T12:25:32.357Z" // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"raw": "string", // 原始文本，一般用于给编辑器使用
|
||||
"content": "string", // 最终渲染的文本
|
||||
"owner": { // 创建者关联
|
||||
"kind": "string",
|
||||
"name": "string",
|
||||
"displayName": "string",
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
}
|
||||
},
|
||||
"userAgent": "string", // 评论者 UserAgent 信息
|
||||
"ipAddress": "string", // 评论者 IP 地址
|
||||
"priority": 0, // 排序字段
|
||||
"top": false, // 是否置顶
|
||||
"allowNotification": true, // 是否允许通知
|
||||
"approved": false,
|
||||
"hidden": false,
|
||||
"commentName": "string", // 被回复的评论名称，即 Comment 的 metadata.name
|
||||
"quoteReply": "string" // 被回复的回复名称，即 Reply 的 metadata.name
|
||||
},
|
||||
"owner": { // 创建者信息
|
||||
"kind": "string",
|
||||
"name": "string",
|
||||
"displayName": "string",
|
||||
"avatar": "string",
|
||||
"email": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -0,0 +1,26 @@
|
||||
```json title="TagVo"
|
||||
{
|
||||
"metadata": {
|
||||
"name": "string", // 唯一标识
|
||||
"labels": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"annotations": {
|
||||
"additionalProp1": "string"
|
||||
},
|
||||
"creationTimestamp": "2022-11-20T13:06:38.512Z", // 创建时间
|
||||
},
|
||||
"spec": {
|
||||
"displayName": "string", // 显示名称
|
||||
"slug": "string", // 别名，通常用于生成 status.permalink
|
||||
"color": "#F9fEB1", // 背景颜色
|
||||
"cover": "string" // 封面图
|
||||
},
|
||||
"status": {
|
||||
"permalink": "string", // 固定链接
|
||||
"visiblePostCount": 0, // 已发布文章数
|
||||
"postCount": 0 // 文章数
|
||||
},
|
||||
"postCount": 0
|
||||
}
|
||||
```
|
||||
Loading…
Reference in new issue