BigW Consortium Gitlab

snippets.md 2.08 KB
Newer Older
1 2
## List snippets

3 4 5 6 7 8 9 10
Get a list of project snippets.

```
GET /projects/:id/snippets
```

Parameters:

11
+ `id` (required) - The ID of a project
12 13 14 15 16 17 18 19 20 21 22

## Single snippet

Get a project snippet.

```
GET /projects/:id/snippets/:snippet_id
```

Parameters:

23
+ `id` (required) - The ID of a project
24 25 26 27 28 29 30 31 32
+ `snippet_id` (required) - The ID of a project's snippet

```json
{
  "id": 1,
  "title": "test",
  "file_name": "add.rb",
  "author": {
    "id": 1,
33
    "username": "john_smith",
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
    "email": "john@example.com",
    "name": "John Smith",
    "blocked": false,
    "created_at": "2012-05-23T08:00:58Z"
  },
  "expires_at": null,
  "updated_at": "2012-06-28T10:52:04Z",
  "created_at": "2012-06-28T10:52:04Z"
}
```

## Snippet content

Get a raw project snippet.

```
GET /projects/:id/snippets/:snippet_id/raw
```

Parameters:

55
+ `id` (required) - The ID of a project
56 57 58 59 60 61 62 63 64 65 66 67
+ `snippet_id` (required) - The ID of a project's snippet

## New snippet

Create a new project snippet.

```
POST /projects/:id/snippets
```

Parameters:

68
+ `id` (required) - The ID of a project
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
+ `title` (required) - The title of a snippet
+ `file_name` (required) - The name of a snippet file
+ `lifetime` (optional) - The expiration date of a snippet
+ `code` (required) - The content of a snippet

Will return created snippet with status `201 Created` on success, or `404 Not found` on fail.

## Edit snippet

Update an existing project snippet.

```
PUT /projects/:id/snippets/:snippet_id
```

Parameters:

86
+ `id` (required) - The ID of a project
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
+ `snippet_id` (required) - The ID of a project's snippet
+ `title` (optional) - The title of a snippet
+ `file_name` (optional) - The name of a snippet file
+ `lifetime` (optional) - The expiration date of a snippet
+ `code` (optional) - The content of a snippet

Will return updated snippet with status `200 OK` on success, or `404 Not found` on fail.

## Delete snippet

Delete existing project snippet.

```
DELETE /projects/:id/snippets/:snippet_id
```

Parameters:

105
+ `id` (required) - The ID of a project
106 107 108 109
+ `snippet_id` (required) - The ID of a project's snippet

Status code `200` will be returned on success.