diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2014-08-04 22:32:41 +0200 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2014-08-07 10:27:54 +0200 |
| commit | abdc4426486c6e6458c12ba49dd641d4c5ab257a (patch) | |
| tree | b458a06a7513284a29b3e1f193431160512e6aa6 /doc/api/README.md | |
| parent | d4f5af820f2fdb442404804859c84d2ef21794d9 (diff) | |
| download | gitlab-ce-abdc4426486c6e6458c12ba49dd641d4c5ab257a.tar.gz | |
Fix spelling errors in doc, closes #7437
Further changes
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index e91d3af59d7..a0a9ba6f4b6 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -132,14 +132,14 @@ When listing resources you can pass the following parameters: ## id vs iid -When you work with API you may notice two similar fields in api entites: id and iid. The main difference between them is scope. Example: +When you work with API you may notice two similar fields in api entities: id and iid. The main difference between them is scope. Example: Issue: id: 46 iid: 5 -- id - is uniq across all Issues table. It used for any api calls. -- iid - is uniq only in scope of single project. When you browse issues or merge requests with Web UI - you see iid. +- id - is unique across all issues. It's used for any api call. +- iid - is unique only in scope of a single project. When you browse issues or merge requests with Web UI, you see iid. So if you want to get issue with api you use `http://host/api/v3/.../issues/:id.json`. But when you want to create a link to web page - use `http:://host/project/issues/:iid.json` |