diff options
| author | Felipe Artur <felipefac@gmail.com> | 2017-03-07 21:14:33 -0300 |
|---|---|---|
| committer | Felipe Artur <felipefac@gmail.com> | 2017-03-07 22:20:38 -0300 |
| commit | a61bb7cda3f31e2b32b53a26187079a6d6302845 (patch) | |
| tree | 18cc3407c2252cc1578d29a0c898a1033120ea61 /doc/api | |
| parent | 9053d78e7451d5358b0ec66788916a488ce66a00 (diff) | |
| download | gitlab-ce-issue_16834.tar.gz | |
Remove unecessary endpoint from repository, add compatibility endpoints for v3 and several improvementsissue_16834
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/repositories.md | 8 | ||||
| -rw-r--r-- | doc/api/v3_to_v4.md | 7 |
2 files changed, 8 insertions, 7 deletions
diff --git a/doc/api/repositories.md b/doc/api/repositories.md index 1471be7fc1c..b1bf9ca07cc 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -15,7 +15,7 @@ Parameters: - `id` (required) - The ID of a project - `path` (optional) - The path inside repository. Used to get contend of subdirectories -- `ref_name` (optional) - The name of a repository branch or tag or if not given the default branch +- `ref` (optional) - The name of a repository branch or tag or if not given the default branch - `recursive` (optional) - Boolean value used to get a recursive tree (false by default) ```json @@ -72,10 +72,10 @@ Parameters: ] ``` -## Get file from repository +## Get a blob from repository -Allows you to receive information about file in repository like size and -content. Note that file content is Base64 encoded. This endpoint can be accessed +Allows you to receive information about blob in repository like size and +content. Note that blob content is Base64 encoded. This endpoint can be accessed without authentication if the repository is publicly accessible. ``` diff --git a/doc/api/v3_to_v4.md b/doc/api/v3_to_v4.md index 715c6ae645c..87bf3bff154 100644 --- a/doc/api/v3_to_v4.md +++ b/doc/api/v3_to_v4.md @@ -72,6 +72,7 @@ changes are in V4: - API uses merge request `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the merge requests, award emoji, todos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9530) - API uses issue `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the issues, award emoji, todos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9530) - Update endpoints for repository files [!9637](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9637) - - Moved `/projects/:id/repository/files` to `/projects/:id/repository/files/:filepath` (`:filepath` should be URL-encoded) - - Moved `/projects/:id/repository/blobs/:sha` to `/projects/:id/repository/files/:filepath/raw` - - Moved `/projects/:id/repository/raw_blobs/:sha` to `/projects/:id/repository/blobs/:sha/raw` + - Moved `/projects/:id/repository/files?file_path=:file_path` to `/projects/:id/repository/files/:file_path` (`:file_path` should be URL-encoded) + - `/projects/:id/repository/blobs/:sha` now returns JSON attributes for the blob identified by `:sha`, instead of finding the commit identified by `:sha` and returning the raw content of the blob in that commit identified by the required `?filepath=:filepath` + - Moved `/projects/:id/repository/commits/:sha/blob?file_path=:file_path` and `/projects/:id/repository/blobs/:sha?file_path=:file_path` to `/projects/:id/repository/files/:file_path/raw?ref=:sha` + - `/projects/:id/repository/tree` parameter `ref_name` has been renamed to `ref` for consistency |