Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!--
💡 提示:这部分是注释,只在编辑时可见,提交后会被 GitHub 隐藏。
感谢你提交 PR!请在提交前花一分钟阅读并填写以下内容。
-->

## 📌 关联的 Issue

<!--
请输入该 PR 关联的 Issue 编号(例如 Closes #123)。
这样当 PR 被合并时,对应的 Issue 会自动关闭。
-->

Closes #

---

## 📝 更改类型

<!-- 请在符合的选项 `[ ]` 中,把空格改成 `x` 变为 `[x]` 来进行勾选 -->

- [ ] 格式化
- [ ] 新增 API
- [ ] 修正错误
- [ ] 更改依赖
- [ ] 更改工作流
- [ ] 其他(请在更改描述里面填写类型)

---

## 📖 更改描述

<!-- 请简要描述这个 PR 解决了什么问题,以及具体的修改思路和核心改动 -->

---

## 🧪 测试与验证说明

<!-- 请说明你是如何测试这些更改的,方便 Reviewer 验证 -->

- [ ] 我确认文档能够正常构建

---

## 🏁 自查清单

<!-- 在提交 PR 前,请确认你已经完成了以下事项 -->

- [ ] 我提交的内容符合本项目的[内容规范](https://yh-api.yyyyt.top/contribution_guide.html#内容规范)
- [ ] 我已经对提交内容进行了初步的审查
55 changes: 30 additions & 25 deletions src/.vuepress/navbar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,36 @@ import { navbar } from "vuepress-theme-hope";
export default navbar([
"/",
{
text: "API文档",
icon: "book",
prefix: "/api/",
children: [
{
text: "v1",
link: "v1/"
},
{
text: "wss",
link: "wss/"
},
{
text: "web",
link: "web/"
},
{
text: "bot",
link: "bot/"
},
]
text: "API文档",
icon: "book",
prefix: "/api/",
children: [
{
text: "v1",
link: "v1/",
},
{
text: "wss",
link: "wss/",
},
{
text: "web",
link: "web/",
},
{
text: "bot",
link: "bot/",
},
],
},
{
text: "API吐槽",
icon: "comment",
link: "/云湖API吐槽/",
text: "API吐槽",
icon: "comment",
link: "/云湖API吐槽/",
},
])
{
text: "贡献指南",
icon: "book",
link: "/contribution_guide",
},
]);
30 changes: 17 additions & 13 deletions src/api/url_scheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ yunhu://chat-add

参数:

| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| id | 是 | 要添加的目标对象ID |
| type | 是 | 要添加的目标对象类别,用户-user,群聊-group,机器人-bot |
| 名称 | 必须 | 备注 |
| ---- | ---- | ------------------------------------------------------- |
| id | 是 | 要添加的目标对象ID |
| type | 是 | 要添加的目标对象类别,用户-user,群聊-group,机器人-bot |

实例(添加ID为123的用户):

```text
yunhu://chat-add?id=123&type=user
```
Expand All @@ -24,11 +25,12 @@ yunhu://post-detail

参数:

| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| id | 是 | 要跳转的目标文章ID |
| 名称 | 必须 | 备注 |
| ---- | ---- | ------------------ |
| id | 是 | 要跳转的目标文章ID |

实例(跳转到ID为111的文章):

```text
yunhu://post-detail?id=111
```
Expand All @@ -39,11 +41,12 @@ yunhu://alley-detail

参数:

| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| id | 是 | 要跳转的目标文章分区ID |
| 名称 | 必须 | 备注 |
| ---- | ---- | ---------------------- |
| id | 是 | 要跳转的目标文章分区ID |

实例(跳转到ID为41的文章分区):

```text
yunhu://post-detail?id=41
```
Expand All @@ -54,11 +57,12 @@ yunhu://ad

参数:

| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| id | 是 | 要观看的广告ID |
| 名称 | 必须 | 备注 |
| ---- | ---- | -------------- |
| id | 是 | 要观看的广告ID |

实例(观看广告ID为123的广告):

```text
yunhu://ad?id=123
```
32 changes: 16 additions & 16 deletions src/api/v1/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ POST /v1/group/remove-member
### 请求头

| 名称 | 必须 | 备注 |
| ----- | ---- |-------------------------|
| ----- | ---- | ----------------------- |
| token | 是 | 必须为群主或管理员token |

### 请求体
Expand Down Expand Up @@ -414,7 +414,7 @@ POST /v1/group/gag-member
### 请求头

| 名称 | 必须 | 备注 |
| ----- | ---- |-------------------------|
| ----- | ---- | ----------------------- |
| token | 是 | 必须为群主或管理员token |

### 请求体
Expand Down Expand Up @@ -1086,9 +1086,9 @@ POST /v1/group/create-group

### 请求头

| 名称 | 必须 | 备注 |
| ----- | ---- |--------------|
| token | 是 | 无 |
| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| token | 是 | 无 |

### 请求体

Expand Down Expand Up @@ -1140,8 +1140,8 @@ POST /v1/group/dismiss-group

### 请求头

| 名称 | 必须 | 备注 |
| ----- | ---- |--------------|
| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| token | 是 | 群主 |

### 请求体
Expand Down Expand Up @@ -1232,9 +1232,9 @@ POST /v1/group/agree-invite

请求头:

| 名称 | 必须 | 备注 |
| ----- | ---- |--------------|
| token | 是 | 无 |
| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| token | 是 | 无 |

请求体:

Expand Down Expand Up @@ -1262,9 +1262,9 @@ POST /v1/group/member-is-removed

请求头:

| 名称 | 必须 | 备注 |
| ----- | ---- |--------------|
| token | 是 | 无 |
| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| token | 是 | 无 |

请求体:

Expand Down Expand Up @@ -1292,9 +1292,9 @@ POST /v1/group/switch

请求头:

| 名称 | 必须 | 备注 |
| ----- | ---- |--------------|
| token | 是 | 无 |
| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| token | 是 | 无 |

请求体:

Expand Down
2 changes: 1 addition & 1 deletion src/api/v1/instruction.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,4 +234,4 @@ message instruction_list {
}
```

:::
:::
6 changes: 3 additions & 3 deletions src/api/v1/live.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@ POST /v1/live/stream-info

请求头:

| 名称 | 必须 | 备注 |
| ----- | ---- | ------- |
| 名称 | 必须 | 备注 |
| ----- | ---- | -------- |
| token | 是 | VIP 用户 |

请求体:
Expand Down Expand Up @@ -255,4 +255,4 @@ POST /v1/live/stream-info
{ "code":-1, "msg":"功能仅限VIP用户使用" }
```

:::
:::
8 changes: 4 additions & 4 deletions src/api/v1/mount-setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ POST /v1/mount-setting/create

请求头:

| 名称 | 必须 | 备注 |
| ----- | ---- | ----------------- |
| 名称 | 必须 | 备注 |
| ----- | ---- | ---------------------------------------- |
| token | 是 | 普通用户的 token 也可(若后续改了欢迎 PR) |

请求体:
Expand Down Expand Up @@ -43,8 +43,8 @@ POST /v1/mount-setting/delete

请求头:

| 名称 | 必须 | 备注 |
| ----- | ---- | ----------------- |
| 名称 | 必须 | 备注 |
| ----- | ---- | ---------------------------------------- |
| token | 是 | 普通用户的 token 也可(若后续改了欢迎 PR) |

请求体:
Expand Down
10 changes: 5 additions & 5 deletions src/api/v1/msg.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ message send_message_send {

### 任何消息

下面说的各种消息是需要额外注意/填写部分,填写内容建议看 proto 的注释.
下面说的各种消息是需要额外注意/填写部分,填写内容建议看 proto 的注释.

必填:

Expand All @@ -115,7 +115,7 @@ message send_message_send {
此处文本类消息指 `普通文本`,`html 消息`,`markdown 消息`.
必填:

- `data.text`
- `data.text`

@tab 图片消息

Expand Down Expand Up @@ -1071,9 +1071,9 @@ POST /v1/msg/delete

请求头:

| 名称 | 必须 | 备注 |
| ----- | ---- |--------------|
| token | 是 | 无 |
| 名称 | 必须 | 备注 |
| ----- | ---- | ---- |
| token | 是 | 无 |

请求体:

Expand Down
6 changes: 3 additions & 3 deletions src/api/v1/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -732,7 +732,7 @@ POST /v1/user/gold-coin-increase-decrease-record

POST /v1/user/bing-phone

!!不要问为什么是 bing,我也不知道.!!
!!不要问为什么是 bing,我也不知道.!!

请求头:

Expand Down Expand Up @@ -762,7 +762,7 @@ POST /v1/user/bing-phone

POST /v1/user/bing-email

!!不要问为什么是 bing,我也不知道.!!
!!不要问为什么是 bing,我也不知道.!!

请求头:

Expand Down Expand Up @@ -993,7 +993,7 @@ POST /v1/user/save-user-remarks

POST /v1/user/cancel-user

!!谁 TMD 想出来的这种命名?!!
!!谁 TMD 想出来的这种命名?!!

请求头:

Expand Down
Loading