diff options
| author | Aral Balkan <aral@aralbalkan.com> | 2016-05-04 06:58:40 +0000 |
|---|---|---|
| committer | Aral Balkan <aral@aralbalkan.com> | 2016-05-04 06:58:40 +0000 |
| commit | 82b5bb91179438bb74f0b6ce31f6fd3cebac6645 (patch) | |
| tree | fad49ad7df4a597c26bca1e440352c0fadc7eb19 | |
| parent | 351df5a90c9f3d9fd57bca0a8220f7d72e82caef (diff) | |
| download | gitlab-ce-82b5bb91179438bb74f0b6ce31f6fd3cebac6645.tar.gz | |
Made it clearer that issue_id means iid, not id.
| -rw-r--r-- | doc/api/notes.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/api/notes.md b/doc/api/notes.md index 7aa1c2155bf..a6b5b1787fd 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -15,7 +15,7 @@ GET /projects/:id/issues/:issue_id/notes Parameters: - `id` (required) - The ID of a project -- `issue_id` (required) - The ID of an issue +- `issue_id` (required) - The IID of an issue (not ID) ```json [ @@ -73,7 +73,7 @@ GET /projects/:id/issues/:issue_id/notes/:note_id Parameters: - `id` (required) - The ID of a project -- `issue_id` (required) - The ID of a project issue +- `issue_id` (required) - The IID of a project issue (not ID) - `note_id` (required) - The ID of an issue note ### Create new issue note @@ -87,7 +87,7 @@ POST /projects/:id/issues/:issue_id/notes Parameters: - `id` (required) - The ID of a project -- `issue_id` (required) - The ID of an issue +- `issue_id` (required) - The IID of an issue (not ID) - `body` (required) - The content of a note - `created_at` (optional) - Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z @@ -102,7 +102,7 @@ PUT /projects/:id/issues/:issue_id/notes/:note_id Parameters: - `id` (required) - The ID of a project -- `issue_id` (required) - The ID of an issue +- `issue_id` (required) - The IID of an issue (not ID) - `note_id` (required) - The ID of a note - `body` (required) - The content of a note @@ -120,7 +120,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `id` | integer | yes | The ID of a project | -| `issue_id` | integer | yes | The ID of an issue | +| `issue_id` | integer | yes | The IID of an issue | | `note_id` | integer | yes | The ID of a note | ```bash |