Snippets in GitSwarm can be either private, internal or public. You can set it with the visibility_level field in the snippet.
Constants for snippet visibility levels are:
| Visibility | visibility_level | Description |
|---|---|---|
| Private | 0 |
The snippet is visible only the snippet creator |
| Internal | 10 |
The snippet is visible for any logged in user |
| Public | 20 |
The snippet can be accessed without any authentication |
Get a list of project snippets.
GET /projects/:id/snippetsParameters:
id (required) - The ID of a projectGet a single project snippet.
GET /projects/:id/snippets/:snippet_idParameters:
id (required) - The ID of a projectsnippet_id (required) - The ID of a project's snippet{
"id": 1,
"title": "test",
"file_name": "add.rb",
"author": {
"id": 1,
"username": "john_smith",
"email": "[email protected]",
"name": "John Smith",
"state": "active",
"created_at": "2012-05-23T08:00:58Z"
},
"expires_at": null,
"updated_at": "2012-06-28T10:52:04Z",
"created_at": "2012-06-28T10:52:04Z"
}Creates a new project snippet. The user must have permission to create new snippets.
POST /projects/:id/snippetsParameters:
id (required) - The ID of a projecttitle (required) - The title of a snippetfile_name (required) - The name of a snippet filecode (required) - The content of a snippetvisibility_level (required) - The snippet's visibilityUpdates an existing project snippet. The user must have permission to change an existing snippet.
PUT /projects/:id/snippets/:snippet_idParameters:
id (required) - The ID of a projectsnippet_id (required) - The ID of a project's snippettitle (optional) - The title of a snippetfile_name (optional) - The name of a snippet filecode (optional) - The content of a snippetvisibility_level (optional) - The snippet's visibilityDeletes an existing project snippet. This is an idempotent function and deleting a non-existent snippet still returns a 200 OK status code.
DELETE /projects/:id/snippets/:snippet_idParameters:
id (required) - The ID of a projectsnippet_id (required) - The ID of a project's snippetReturns the raw project snippet as plain text.
GET /projects/:id/snippets/:snippet_id/rawParameters:
id (required) - The ID of a projectsnippet_id (required) - The ID of a project's snippet