diff options
| author | winniehell <git@winniehell.de> | 2016-07-25 00:58:34 +0200 |
|---|---|---|
| committer | winniehell <git@winniehell.de> | 2016-08-05 12:42:24 +0200 |
| commit | 3bf62c9d5ad26aabffe764b385b6acb7be5a9898 (patch) | |
| tree | b9beb9acb197e22a7bf60d174c5054c23954fe54 | |
| parent | e299504b798c053817f1c866649542ac0c779924 (diff) | |
| download | gitlab-ce-3bf62c9d5ad26aabffe764b385b6acb7be5a9898.tar.gz | |
Add examples to repository files API (!5465)
| -rw-r--r-- | doc/api/repository_files.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 623063f357b..1b8ee88b4ed 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -12,6 +12,10 @@ Allows you to receive information about file in repository like name, size, cont GET /projects/:id/repository/files ``` +```bash +curl -X GET -H 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/models/key.rb&ref=master' +``` + Example response: ```json @@ -39,6 +43,10 @@ Parameters: POST /projects/:id/repository/files ``` +```bash +curl -X POST -H 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&content=some%20content&commit_message=create%20a%20new%20file' +``` + Example response: ```json @@ -62,6 +70,10 @@ Parameters: PUT /projects/:id/repository/files ``` +```bash +curl -X PUT -H 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&content=some%20other%20content&commit_message=update%20file' +``` + Example response: ```json @@ -94,6 +106,10 @@ Currently gitlab-shell has a boolean return code, preventing GitLab from specify DELETE /projects/:id/repository/files ``` +```bash +curl -X PUT -H 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&commit_message=delete%20file' +``` + Example response: ```json |