From d3b8952f8fb067afe89f08eadbae7733c0cc6824 Mon Sep 17 00:00:00 2001 From: Cyril Date: Mon, 10 Dec 2012 23:46:31 +0100 Subject: Add username to User and UserBasic entities in API and in examples in doc. --- doc/api/notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/api/notes.md') diff --git a/doc/api/notes.md b/doc/api/notes.md index 7b226dea44c..dddb55edb93 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -15,6 +15,7 @@ GET /projects/:id/notes "body": "The solution is rather tricky", "author": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, -- cgit v1.2.1 From 8f01190eb5ec0f40d6f8874a3f3c79637000a709 Mon Sep 17 00:00:00 2001 From: Riyad Preukschas Date: Fri, 21 Dec 2012 18:47:04 +0100 Subject: Remove all references tp the project code parameter from the API --- doc/api/notes.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'doc/api/notes.md') diff --git a/doc/api/notes.md b/doc/api/notes.md index dddb55edb93..bb33efb8c25 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -28,7 +28,7 @@ GET /projects/:id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ### List issue notes @@ -40,7 +40,7 @@ GET /projects/:id/issues/:issue_id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `issue_id` (required) - The ID of an issue ### List snippet notes @@ -53,7 +53,7 @@ GET /projects/:id/snippets/:snippet_id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of a snippet ## Single note @@ -68,7 +68,7 @@ GET /projects/:id/notes/:note_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `note_id` (required) - The ID of a wall note ### Single issue note @@ -81,7 +81,7 @@ GET /projects/:id/issues/:issue_id/:notes/:note_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `issue_id` (required) - The ID of a project issue + `note_id` (required) - The ID of an issue note @@ -95,7 +95,7 @@ GET /projects/:id/issues/:snippet_id/:notes/:note_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of a project snippet + `note_id` (required) - The ID of an snippet note @@ -111,7 +111,7 @@ POST /projects/:id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `body` (required) - The content of a note Will return created note with status `201 Created` on success, or `404 Not found` on fail. @@ -127,7 +127,7 @@ POST /projects/:id/issues/:issue_id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `issue_id` (required) - The ID of an issue + `body` (required) - The content of a note @@ -143,7 +143,7 @@ POST /projects/:id/snippets/:snippet_id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of an snippet + `body` (required) - The content of a note -- cgit v1.2.1