project_snippets.md 2.11 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
## Single snippet

16
Get a single project snippet.
17 18 19 20 21 22 23

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

Parameters:

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

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


47
## Create new snippet
48

49
Creates a new project snippet. The user must have permission to create new snippets.
50 51 52 53 54 55 56

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

Parameters:

57
+ `id` (required) - The ID of a project
58 59 60 61 62 63
+ `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


64
## Update snippet
65

66
Updates an existing project snippet. The user must have permission to change an existing snippet.
67 68 69 70 71 72 73

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

Parameters:

74
+ `id` (required) - The ID of a project
75 76 77 78 79 80 81 82 83
+ `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


## Delete snippet

84 85
Deletes an existing project snippet. This is an idempotent function and deleting a non-existent
snippet still returns a `200 Ok` status code.
86 87 88 89 90 91 92

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

Parameters:

93
+ `id` (required) - The ID of a project
94 95
+ `snippet_id` (required) - The ID of a project's snippet

96 97 98

## Snippet content

99
Returns the raw project snippet as plain text.
100 101 102 103 104 105 106 107 108

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

Parameters:

+ `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a project's snippet