Download as
Browse Code »

Commit a534c9b72d54729122a9ccfe4f43ce5bdaa9bed2

Authored by Sebastian Ziebell
1 parent bb24275f
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

A few fixes in documentation to notes, updates infos on status codes 

A few fixes in the notes URI pattern (`notes` instead of `:notes`), also updated
the information to status codes. If `body` attribute is missing from a POST request
a status code 400 (Bad request) is returned. This reflects the code changes from
the previous commit.
Showing 1 changed file with 5 additions and 5 deletions   Show diff stats
doc/api/notes.md
  Diff comments   View file @a534c9b
@@ -76,7 +76,7 @@ Parameters: @@ -76,7 +76,7 @@ Parameters:
76 Get an issue note. 76 Get an issue note.
77 77
78 ``` 78 ```
79 -GET /projects/:id/issues/:issue_id/:notes/:note_id 79 +GET /projects/:id/issues/:issue_id/notes/:note_id
80 ``` 80 ```
81 81
82 Parameters: 82 Parameters:
@@ -90,7 +90,7 @@ Parameters: @@ -90,7 +90,7 @@ Parameters:
90 Get a snippet note. 90 Get a snippet note.
91 91
92 ``` 92 ```
93 -GET /projects/:id/issues/:snippet_id/:notes/:note_id 93 +GET /projects/:id/issues/:snippet_id/notes/:note_id
94 ``` 94 ```
95 95
96 Parameters: 96 Parameters:
@@ -114,7 +114,7 @@ Parameters: @@ -114,7 +114,7 @@ Parameters:
114 + `id` (required) - The ID of a project 114 + `id` (required) - The ID of a project
115 + `body` (required) - The content of a note 115 + `body` (required) - The content of a note
116 116
117 -Will return created note with status `201 Created` on success, or `404 Not found` on fail. 117 +Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail.
118 118
119 119
120 ### New issue note 120 ### New issue note
@@ -131,7 +131,7 @@ Parameters: @@ -131,7 +131,7 @@ Parameters:
131 + `issue_id` (required) - The ID of an issue 131 + `issue_id` (required) - The ID of an issue
132 + `body` (required) - The content of a note 132 + `body` (required) - The content of a note
133 133
134 -Will return created note with status `201 Created` on success, or `404 Not found` on fail. 134 +Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail.
135 135
136 ### New snippet note 136 ### New snippet note
137 137
@@ -147,4 +147,4 @@ Parameters: @@ -147,4 +147,4 @@ Parameters:
147 + `snippet_id` (required) - The ID of an snippet 147 + `snippet_id` (required) - The ID of an snippet
148 + `body` (required) - The content of a note 148 + `body` (required) - The content of a note
149 149
150 -Will return created note with status `201 Created` on success, or `404 Not found` on fail. 150 +Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail.