diff options
| author | Ciro Santilli <ciro.santilli@gmail.com> | 2014-04-25 02:48:22 +0400 |
|---|---|---|
| committer | Ciro Santilli <ciro.santilli@gmail.com> | 2014-06-04 01:16:31 +0400 |
| commit | fd348de76d651d49acc8eb742cc647dc777ef5fc (patch) | |
| tree | 26f42bef57c9a636eff0a548a29cb1e2e6d12c8c /doc/api/project_snippets.md | |
| parent | de1a7aa7eb523cf2fdad12f8eeda2ba4c5b51820 (diff) | |
Update docs to markdown style guide.
Diffstat (limited to 'doc/api/project_snippets.md')
| -rw-r--r-- | doc/api/project_snippets.md | 37 |
1 files changed, 16 insertions, 21 deletions
diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index 7a498272334..47c81b6446c 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -10,8 +10,7 @@ GET /projects/:id/snippets Parameters: -+ `id` (required) - The ID of a project - +- `id` (required) - The ID of a project ## Single snippet @@ -23,8 +22,8 @@ GET /projects/:id/snippets/:snippet_id Parameters: -+ `id` (required) - The ID of a project -+ `snippet_id` (required) - The ID of a project's snippet +- `id` (required) - The ID of a project +- `snippet_id` (required) - The ID of a project's snippet ```json { @@ -45,7 +44,6 @@ Parameters: } ``` - ## Create new snippet Creates a new project snippet. The user must have permission to create new snippets. @@ -56,11 +54,10 @@ POST /projects/:id/snippets Parameters: -+ `id` (required) - The ID of a project -+ `title` (required) - The title of a snippet -+ `file_name` (required) - The name of a snippet file -+ `code` (required) - The content of a snippet - +- `id` (required) - The ID of a project +- `title` (required) - The title of a snippet +- `file_name` (required) - The name of a snippet file +- `code` (required) - The content of a snippet ## Update snippet @@ -72,12 +69,11 @@ PUT /projects/:id/snippets/:snippet_id Parameters: -+ `id` (required) - The ID of a project -+ `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 -+ `code` (optional) - The content of a snippet - +- `id` (required) - The ID of a project +- `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 +- `code` (optional) - The content of a snippet ## Delete snippet @@ -90,9 +86,8 @@ DELETE /projects/:id/snippets/:snippet_id Parameters: -+ `id` (required) - The ID of a project -+ `snippet_id` (required) - The ID of a project's snippet - +- `id` (required) - The ID of a project +- `snippet_id` (required) - The ID of a project's snippet ## Snippet content @@ -104,5 +99,5 @@ 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 +- `id` (required) - The ID of a project +- `snippet_id` (required) - The ID of a project's snippet |