Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
李少辉-开发者
gitlab-foss
提交
fd9cd5ae
G
gitlab-foss
项目概览
李少辉-开发者
/
gitlab-foss
通知
15
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
G
gitlab-foss
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
fd9cd5ae
编写于
6月 16, 2016
作者:
R
Robert Schilling
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add todos API documentation and changelog
上级
40c685c5
变更
4
显示空白变更内容
内联
并排
Showing
4 changed file
with
220 addition
and
3 deletion
+220
-3
CHANGELOG
CHANGELOG
+1
-0
doc/api/README.md
doc/api/README.md
+1
-0
doc/api/todos.md
doc/api/todos.md
+217
-0
lib/api/todos.rb
lib/api/todos.rb
+1
-3
未找到文件。
CHANGELOG
浏览文件 @
fd9cd5ae
...
...
@@ -19,6 +19,7 @@ v 8.10.0 (unreleased)
- Fix changing issue state columns in milestone view
- Add notification settings dropdown for groups
- Allow importing from Github using Personal Access Tokens. (Eric K Idema)
- API: Todos !3188 (Robert Schilling)
- Fix user creation with stronger minimum password requirements !4054 (nathan-pmt)
- PipelinesFinder uses git cache data
- Check for conflicts with existing Project's wiki path when creating a new project.
...
...
doc/api/README.md
浏览文件 @
fd9cd5ae
...
...
@@ -36,6 +36,7 @@ following locations:
-
[
System Hooks
](
system_hooks.md
)
-
[
Tags
](
tags.md
)
-
[
Users
](
users.md
)
-
[
Todos
](
todos.md
)
### Internal CI API
...
...
doc/api/todos.md
0 → 100644
浏览文件 @
fd9cd5ae
# Todos
**Note:**
This feature was
[
introduced
][
ce-3188
]
in GitLab 8.10
## Get a list of todos
Returns a list of todos. When no filter is applied, it returns all pending todos
for the current user. Different filters allow the user to
```
GET /todos
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
|
`action_id`
| integer | no | The ID of the action of the todo. See the table below for the ID mapping |
|
`author_id`
| integer | no | The ID of an author |
|
`project_id`
| integer | no | The ID of a project |
|
`state`
| string | no | The state of the todo. Can be either
`pending`
or
`done`
|
|
`type`
| string | no | The type of an todo. Can be either
`Issue`
or
`MergeRequest`
|
|
`action_id`
| Action |
| ----------- | ------ |
| 1 | Issuable assigned |
| 2 | Mentioned in issuable |
| 3 | Build failed |
| 4 | Todo marked for you |
```
bash
curl
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/todos
```
Example Response:
```
json
[
{
"id"
:
130
,
"project"
:
{
"id"
:
1
,
"name"
:
"Underscore"
,
"name_with_namespace"
:
"Documentcloud / Underscore"
,
"path"
:
"underscore"
,
"path_with_namespace"
:
"documentcloud/underscore"
},
"author"
:
{
"name"
:
"Juwan Abbott"
,
"username"
:
"halle"
,
"id"
:
8
,
"state"
:
"active"
,
"avatar_url"
:
"http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon"
,
"web_url"
:
"https://gitlab.example.com/u/halle"
},
"action_name"
:
"assigned"
,
"target_id"
:
71
,
"target_type"
:
"Issue"
,
"target_reference"
:
"#1"
,
"target_url"
:
"https://gitlab.example.com/documentcloud/underscore/issues/1"
,
"body"
:
"At voluptas qui nulla soluta qui et."
,
"state"
:
"pending"
,
"created_at"
:
"2016-05-20T20:52:00.626Z"
},
{
"id"
:
129
,
"project"
:
{
"id"
:
1
,
"name"
:
"Underscore"
,
"name_with_namespace"
:
"Documentcloud / Underscore"
,
"path"
:
"underscore"
,
"path_with_namespace"
:
"documentcloud/underscore"
},
"author"
:
{
"name"
:
"Juwan Abbott"
,
"username"
:
"halle"
,
"id"
:
8
,
"state"
:
"active"
,
"avatar_url"
:
"http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon"
,
"web_url"
:
"https://gitlab.example.com/u/halle"
},
"action_name"
:
"mentioned"
,
"target_id"
:
79
,
"target_type"
:
"Issue"
,
"target_reference"
:
"#9"
,
"target_url"
:
"https://gitlab.example.com/documentcloud/underscore/issues/9#note_959"
,
"body"
:
"@root Fix this shit"
,
"state"
:
"pending"
,
"created_at"
:
"2016-05-20T20:51:51.503Z"
}
]
```
## Mark a todo as done
Marks a single pending todo given by its ID for the current user as done. The to
marked as done is returned in the response.
```
DELETE /todos/:id
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of a todo |
```
bash
curl
-X
DELETE
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/todos/130
```
Example Response:
```
json
{
"id"
:
130
,
"project"
:
{
"id"
:
1
,
"name"
:
"Underscore"
,
"name_with_namespace"
:
"Documentcloud / Underscore"
,
"path"
:
"underscore"
,
"path_with_namespace"
:
"documentcloud/underscore"
},
"author"
:
{
"name"
:
"Juwan Abbott"
,
"username"
:
"halle"
,
"id"
:
8
,
"state"
:
"active"
,
"avatar_url"
:
"http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon"
,
"web_url"
:
"https://gitlab.example.com/u/halle"
},
"action_name"
:
"assigned"
,
"target_id"
:
71
,
"target_type"
:
"Issue"
,
"target_reference"
:
"#1"
,
"target_url"
:
"https://gitlab.example.com/documentcloud/underscore/issues/1"
,
"body"
:
"At voluptas qui nulla soluta qui et."
,
"state"
:
"done"
,
"created_at"
:
"2016-05-20T20:52:00.626Z"
}
```
## Mark all todos as done
Marks all pending todos for the current user as done. All todos marked as done
are returned in the response.
```
DELETE /todos
```
```
bash
curl
-X
DELETE
-H
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v3/todos
```
Example Response:
```
json
[
{
"id"
:
130
,
"project"
:
{
"id"
:
1
,
"name"
:
"Underscore"
,
"name_with_namespace"
:
"Documentcloud / Underscore"
,
"path"
:
"underscore"
,
"path_with_namespace"
:
"documentcloud/underscore"
},
"author"
:
{
"name"
:
"Juwan Abbott"
,
"username"
:
"halle"
,
"id"
:
8
,
"state"
:
"active"
,
"avatar_url"
:
"http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon"
,
"web_url"
:
"https://gitlab.example.com/u/halle"
},
"action_name"
:
"assigned"
,
"target_id"
:
71
,
"target_type"
:
"Issue"
,
"target_reference"
:
"#1"
,
"target_url"
:
"https://gitlab.example.com/documentcloud/underscore/issues/1"
,
"body"
:
"At voluptas qui nulla soluta qui et."
,
"state"
:
"done"
,
"created_at"
:
"2016-05-20T20:52:00.626Z"
},
{
"id"
:
129
,
"project"
:
{
"id"
:
1
,
"name"
:
"Underscore"
,
"name_with_namespace"
:
"Documentcloud / Underscore"
,
"path"
:
"underscore"
,
"path_with_namespace"
:
"documentcloud/underscore"
},
"author"
:
{
"name"
:
"Juwan Abbott"
,
"username"
:
"halle"
,
"id"
:
8
,
"state"
:
"active"
,
"avatar_url"
:
"http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon"
,
"web_url"
:
"https://gitlab.example.com/u/halle"
},
"action_name"
:
"mentioned"
,
"target_id"
:
79
,
"target_type"
:
"Issue"
,
"target_reference"
:
"#9"
,
"target_url"
:
"https://gitlab.example.com/documentcloud/underscore/issues/9#note_959"
,
"body"
:
"@root Fix this shit"
,
"state"
:
"done"
,
"created_at"
:
"2016-05-20T20:51:51.503Z"
}
]
```
[
ce-3188
]:
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3188
lib/api/todos.rb
浏览文件 @
fd9cd5ae
...
...
@@ -21,13 +21,12 @@ module API
present
paginate
(
todos
),
with:
Entities
::
Todo
end
# Mark todo as done
# Mark
a
todo as done
#
# Parameters:
# id: (required) - The ID of the todo being marked as done
#
# Example Request:
#
# DELETE /todos/:id
#
delete
':id'
do
...
...
@@ -40,7 +39,6 @@ module API
# Mark all todos as done
#
# Example Request:
#
# DELETE /todos
#
delete
do
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录