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 | |
| parent | d4f5af820f2fdb442404804859c84d2ef21794d9 (diff) | |
| download | gitlab-ce-abdc4426486c6e6458c12ba49dd641d4c5ab257a.tar.gz | |
Fix spelling errors in doc, closes #7437
Further changes
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/README.md | 6 | ||||
| -rw-r--r-- | doc/api/branches.md | 2 | ||||
| -rw-r--r-- | doc/api/repositories.md | 16 |
3 files changed, 12 insertions, 12 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` diff --git a/doc/api/branches.md b/doc/api/branches.md index f695b48fe2f..090287133ce 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -174,7 +174,7 @@ Parameters: - `id` (required) - The ID of a project - `branch_name` (required) - The name of the branch -- `ref` (required) - Create branch from commit sha or existing branch +- `ref` (required) - Create branch from commit SHA or existing branch ```json { diff --git a/doc/api/repositories.md b/doc/api/repositories.md index 2539e3edbf9..7d6164a0819 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -49,7 +49,7 @@ Parameters: + `id` (required) - The ID of a project + `tag_name` (required) - The name of a tag -+ `ref` (required) - Create tag using commit sha, another tag name, or branch name. ++ `ref` (required) - Create tag using commit SHA, another tag name, or branch name. ```json [ @@ -129,7 +129,7 @@ Parameters: ## Raw file content -Get the raw file contents for a file by commit sha and path. +Get the raw file contents for a file by commit SHA and path. ``` GET /projects/:id/repository/blobs/:sha @@ -144,7 +144,7 @@ Parameters: ## Raw blob content -Get the raw file contents for a blob by blob sha. +Get the raw file contents for a blob by blob SHA. ``` GET /projects/:id/repository/raw_blobs/:sha @@ -153,7 +153,7 @@ GET /projects/:id/repository/raw_blobs/:sha Parameters: + `id` (required) - The ID of a project -+ `sha` (required) - The blob sha ++ `sha` (required) - The blob SHA ## Get file archive @@ -166,7 +166,7 @@ GET /projects/:id/repository/archive Parameters: + `id` (required) - The ID of a project -+ `sha` (optional) - The commit sha to download defaults to the tip of the default branch ++ `sha` (optional) - The commit SHA to download defaults to the tip of the default branch ## Compare branches, tags or commits @@ -177,15 +177,15 @@ GET /projects/:id/repository/compare Parameters: + `id` (required) - The ID of a project -+ `from` (required) - the commit sha or branch name -+ `to` (required) - the commit sha or branch name ++ `from` (required) - the commit SHA or branch name ++ `to` (required) - the commit SHA or branch name ``` GET /projects/:id/repository/compare?from=master&to=feature ``` -Response: +Response: ```json |