39114d259c
All the info to return codes from the API functions are available in the `README.md` file as suggested.
2 KiB
2 KiB
List snippets
Get a list of project snippets.
GET /projects/:id/snippets
Parameters:
id(required) - The ID of a project
Single snippet
Get a single project snippet.
GET /projects/:id/snippets/:snippet_id
Parameters:
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": "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"
}
Create new snippet
Creates a new project snippet.
POST /projects/:id/snippets
Parameters:
id(required) - The ID of a projecttitle(required) - The title of a snippetfile_name(required) - The name of a snippet filelifetime(optional) - The expiration date of a snippetcode(required) - The content of a snippet
Edit snippet
Updates an existing project snippet.
PUT /projects/:id/snippets/:snippet_id
Parameters:
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 filelifetime(optional) - The expiration date of a snippetcode(optional) - The content of a snippet
Delete snippet
Deletes 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_id
Parameters:
id(required) - The ID of a projectsnippet_id(required) - The ID of a project's snippet
Snippet content
Get a raw project snippet.
GET /projects/:id/snippets/:snippet_id/raw
Parameters:
id(required) - The ID of a projectsnippet_id(required) - The ID of a project's snippet