Add examples to repository files API (!5465)
This commit is contained in:
parent
e299504b79
commit
3bf62c9d5a
|
@ -12,6 +12,10 @@ Allows you to receive information about file in repository like name, size, cont
|
||||||
GET /projects/:id/repository/files
|
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:
|
Example response:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
@ -39,6 +43,10 @@ Parameters:
|
||||||
POST /projects/:id/repository/files
|
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:
|
Example response:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
@ -62,6 +70,10 @@ Parameters:
|
||||||
PUT /projects/:id/repository/files
|
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:
|
Example response:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
@ -94,6 +106,10 @@ Currently gitlab-shell has a boolean return code, preventing GitLab from specify
|
||||||
DELETE /projects/:id/repository/files
|
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:
|
Example response:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
|
Loading…
Reference in New Issue