client/docs/cms/cms.swagger.json

576 lines
13 KiB
JSON

{
"swagger": "2.0",
"info": {
"title": "blocks.proto",
"version": "version not set"
},
"tags": [
{
"name": "Category"
},
{
"name": "Pages"
},
{
"name": "Post"
},
{
"name": "Tags"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {},
"definitions": {
"cmsAccessoryItem": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"title": "唯一标识"
},
"title": {
"type": "string",
"title": "附件标题"
},
"file_path": {
"type": "string",
"title": "附件文件路径"
},
"created_at": {
"type": "string",
"title": "创建时间"
}
},
"title": "附件"
},
"cmsCategoryItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "唯一标识"
},
"parent_id": {
"type": "string",
"format": "int64",
"title": "为空表示顶级分类"
},
"title": {
"type": "string",
"title": "标题"
},
"cover_path": {
"type": "string",
"title": "封面图片"
},
"intro": {
"type": "string",
"title": "简介"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"updated_at": {
"type": "string",
"title": "更新时间"
},
"child": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsCategoryItem"
},
"title": "子集"
},
"category_key": {
"type": "string",
"title": "分类标识"
}
},
"title": "分类"
},
"cmsCategoryListReply": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsCategoryItem"
},
"title": "数据"
},
"count": {
"type": "string",
"format": "int64",
"title": "总数"
}
},
"title": "分类列表"
},
"cmsCommentItem": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"title": "评论唯一标识"
},
"post_identity": {
"type": "string",
"title": "文章唯一标识"
},
"parent_id": {
"type": "string",
"format": "int64",
"title": "为空表示顶级评论"
},
"Cms": {
"type": "string",
"title": "评论内容"
},
"reply_identity": {
"type": "string",
"title": "回复者唯一 标识"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"updated_at": {
"type": "string",
"title": "更新时间"
},
"list": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsCommentItem"
},
"title": "回复列表"
},
"like_hits": {
"type": "string",
"format": "int64",
"title": "点赞量"
},
"unlike_hits": {
"type": "string",
"format": "int64",
"title": "点踩量"
},
"comment_hits": {
"type": "string",
"format": "int64",
"title": "评论量"
},
"owner_name": {
"type": "string",
"title": "作者名称"
},
"owner_identity": {
"type": "string",
"title": "作者标识"
},
"role": {
"type": "string",
"title": "角色"
}
},
"title": "评论"
},
"cmsCommentListResponse": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsCommentItem"
},
"title": "数据"
},
"count": {
"type": "string",
"format": "int64",
"title": "总数量"
}
},
"title": "评论列表回复"
},
"cmsPagesItem": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"title": "文章唯一标识"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"updated_at": {
"type": "string",
"title": "更新时间"
},
"post_type": {
"type": "integer",
"format": "int32",
"title": "用户自定义文章类型"
},
"rights": {
"type": "string",
"title": "权限"
},
"title": {
"type": "string",
"title": "\u003c必传\u003e,标题"
},
"key": {
"type": "string",
"title": "\u003c必传\u003e,文章key"
},
"description": {
"type": "string",
"title": "简介"
},
"cover_path": {
"type": "string",
"title": "封面"
},
"Cms": {
"type": "string",
"title": "\u003c必传\u003e,内容"
},
"has_accessory": {
"type": "boolean",
"title": "是否有附件,默认没有"
},
"accessory_identity_array": {
"type": "array",
"items": {
"type": "string"
},
"title": "附件Identity 列表"
},
"accessory_data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsAccessoryItem"
},
"title": "附件数据"
},
"tags_data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsTagsItem"
},
"title": "标签数据"
},
"tags_identity_array": {
"type": "array",
"items": {
"type": "string"
},
"title": "标签集Identity 列表"
},
"hits": {
"type": "string",
"format": "int64",
"title": "点击量"
}
},
"title": "文章"
},
"cmsPagesListReply": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsPagesItem"
},
"title": "数据"
},
"count": {
"type": "string",
"format": "int64",
"title": "总数量"
}
},
"title": "文章列表回复"
},
"cmsPostItem": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"title": "文章唯一标识"
},
"owner_id": {
"type": "string",
"format": "int64",
"title": "作者ID"
},
"owner_identity": {
"type": "string",
"title": "作者唯一标识"
},
"category_identity_array": {
"type": "array",
"items": {
"type": "string"
},
"title": "\u003c必传\u003e,所属分类Identity 列表"
},
"tags_identity_array": {
"type": "array",
"items": {
"type": "string"
},
"title": "标签集Identity 列表"
},
"title": {
"type": "string",
"title": "\u003c必传\u003e,标题"
},
"cover_path": {
"type": "string",
"title": "封面"
},
"author": {
"type": "string",
"title": "作者"
},
"author_identity": {
"type": "string"
},
"Cms": {
"type": "string",
"title": "\u003c必传\u003e,内容"
},
"target_url": {
"type": "string",
"title": "跳转目标地址"
},
"source_url": {
"type": "string",
"title": "文章来源地址"
},
"hits": {
"type": "string",
"format": "int64",
"title": "点击量"
},
"accessory_identity_array": {
"type": "array",
"items": {
"type": "string"
},
"title": "附件Identity 列表"
},
"has_accessory": {
"type": "boolean",
"title": "是否有附件,默认没有"
},
"created_at": {
"type": "string",
"title": "创建时间"
},
"updated_at": {
"type": "string",
"title": "更新时间"
},
"description": {
"type": "string",
"title": "简介"
},
"like_hits": {
"type": "string",
"format": "int64",
"title": "点赞量"
},
"unlike_hits": {
"type": "string",
"format": "int64",
"title": "点踩量"
},
"comment_hits": {
"type": "string",
"format": "int64",
"title": "评论量"
},
"post_type": {
"type": "integer",
"format": "int32",
"title": "用户自定义文章类型"
},
"rights": {
"type": "string",
"title": "权限"
},
"key": {
"type": "string",
"title": "\u003c必传\u003e,文章key"
},
"category_data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsCategoryItem"
},
"title": "分类数据"
},
"tags_data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsTagsItem"
},
"title": "标签数据"
},
"accessory_data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsAccessoryItem"
},
"title": "附件数据"
}
},
"title": "文章"
},
"cmsPostListReply": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsPostItem"
},
"title": "数据"
},
"count": {
"type": "string",
"format": "int64",
"title": "总数量"
}
},
"title": "文章列表回复"
},
"cmsStatusReply": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"title": "状态码"
},
"message": {
"type": "string",
"title": "状态说明"
},
"details": {
"type": "string",
"title": "数据"
},
"timeseq": {
"type": "string",
"format": "int64",
"title": "响应时间序列"
}
}
},
"cmsTagsItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "唯一标识"
},
"title": {
"type": "string",
"title": "标题"
},
"cover_path": {
"type": "string",
"title": "封面图片"
},
"intro": {
"type": "string",
"title": "简介"
},
"created_at": {
"type": "string",
"title": "创建时间"
}
},
"title": "标签"
},
"cmsTagsListReply": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/cmsTagsItem"
},
"title": "数据"
},
"count": {
"type": "string",
"format": "int64",
"title": "总数"
}
},
"title": "标签列表"
},
"protobufAny": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
},
"additionalProperties": {}
},
"rpcStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/protobufAny"
}
}
}
}
}
}