summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordosire <sytses@gmail.com>2014-04-30 17:28:05 +0200
committerdosire <sytses@gmail.com>2014-04-30 17:28:05 +0200
commit5bf12bbb1d05e0f4fc2661ccd68e0c208499ba57 (patch)
treef24d7c5fbd39c8f1379e82205cc76c6af4f62c9d
parent901fc30049d38ee2b242b26237f71964fccd68c3 (diff)
downloadgitlab-ce-5bf12bbb1d05e0f4fc2661ccd68e0c208499ba57.tar.gz
Make clear that notes also serve as comments.
-rw-r--r--doc/api/README.md2
-rw-r--r--doc/api/issues.md4
-rw-r--r--doc/api/merge_requests.md4
-rw-r--r--doc/api/notes.md2
4 files changed, 11 insertions, 1 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index 09c52350f3f..4ef4c031bc2 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -13,7 +13,7 @@
+ [Merge Requests](merge_requests.md)
+ [Issues](issues.md)
+ [Milestones](milestones.md)
-+ [Notes](notes.md)
++ [Notes](notes.md) (comments)
+ [Deploy Keys](deploy_keys.md)
+ [System Hooks](system_hooks.md)
+ [Groups](groups.md)
diff --git a/doc/api/issues.md b/doc/api/issues.md
index 823b72f5b0c..d18506f9ce6 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -193,3 +193,7 @@ Parameters:
+ `id` (required) - The project ID
+ `issue_id` (required) - The ID of the issue
+
+## Comments on issues
+
+Comments are done via the notes resource.
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index 2996f609d43..d5b106729c9 100644
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@@ -258,3 +258,7 @@ Parameters:
}
]
```
+
+## Comments on issues
+
+Comments are done via the notes resource.
diff --git a/doc/api/notes.md b/doc/api/notes.md
index b15ebdd2bac..e9ad6e00c73 100644
--- a/doc/api/notes.md
+++ b/doc/api/notes.md
@@ -1,3 +1,5 @@
+Notes can be wall notes or comments on snippets, issues or merge requests.
+
## Wall
### List project wall notes