kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/api/notes.md

265 lines
4.7 KiB
Markdown
Raw Normal View History

API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
## Wall
add docs for notes API
2012-11-29 15:32:05 -05:00
### List project wall notes
Get a list of project wall notes.
```
GET /projects/:id/notes
```
Update issues, milestones, notes api docs.
2013-10-02 06:08:07 -04:00
Parameters:
+ `id` (required) - The ID of a project
add docs for notes API
2012-11-29 15:32:05 -05:00
```json
[
{
"id": 522,
"body": "The solution is rather tricky",
Update issues, milestones, notes api docs.
2013-10-02 06:08:07 -04:00
"attachment":null,
add docs for notes API
2012-11-29 15:32:05 -05:00
"author": {
"id": 1,
Add username to User and UserBasic entities in API and in examples in doc.
2012-12-10 17:46:31 -05:00
"username": "john_smith",
add docs for notes API
2012-11-29 15:32:05 -05:00
"email": "john@example.com",
"name": "John Smith",
Update issues, milestones, notes api docs.
2013-10-02 06:08:07 -04:00
"state": "active",
add docs for notes API
2012-11-29 15:32:05 -05:00
"created_at": "2012-05-23T08:00:58Z"
},
API: don't expose 'updated_at' for notes
2012-11-29 17:41:24 -05:00
"created_at": "2012-11-27T19:16:44Z"
add docs for notes API
2012-11-29 15:32:05 -05:00
}
]
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
### Get single wall note
Returns a single wall note.
missing doc for api
2013-01-31 01:46:59 -05:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
GET /projects/:id/notes/:note_id
missing doc for api
2013-01-31 01:46:59 -05:00
```
Parameters:
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
+ `note_id` (required) - The ID of a wall note
missing doc for api
2013-01-31 01:46:59 -05:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
### Create new wall note
Creates a new wall note.
```
POST /projects/:id/notes
```
Parameters:
+ `id` (required) - The ID of a project
+ `body` (required) - The content of a note
## Issues
### List project issue notes
Gets a list of all notes for a single issue.
add docs for notes API
2012-11-29 15:32:05 -05:00
```
GET /projects/:id/issues/:issue_id/notes
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 12:47:04 -05:00
+ `id` (required) - The ID of a project
add docs for notes API
2012-11-29 15:32:05 -05:00
+ `issue_id` (required) - The ID of an issue
Update issues, milestones, notes api docs.
2013-10-02 06:08:07 -04:00
```json
[
{
"id":302,
"body":"_Status changed to closed_",
"attachment":null,
"author":{
"id":1,
"username":"pipin",
"email":"admin@example.com",
"name":"Pip",
"state":"active",
"created_at":"2013-09-30T13:46:01Z"
},
"created_at":"2013-10-02T09:22:45Z"
},
{
"id":305,
"body":"Text of the comment\r\n",
"attachment":null,
"author":{
"id":1,
"username":"pipin",
"email":"admin@example.com",
"name":"Pip",
"state":"active",
"created_at":"2013-09-30T13:46:01Z"
},
"created_at":"2013-10-02T09:56:03Z"
}
]
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
### Get single issue note
Returns a single note for a specific project issue
add docs for notes API
2012-11-29 15:32:05 -05:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
GET /projects/:id/issues/:issue_id/notes/:note_id
add docs for notes API
2012-11-29 15:32:05 -05:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 12:47:04 -05:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
+ `issue_id` (required) - The ID of a project issue
+ `note_id` (required) - The ID of an issue note
add docs for notes API
2012-11-29 15:32:05 -05:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
### Create new issue note
API: get a single wall note
2012-12-01 05:20:45 -05:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
Creates a new note to a single project issue.
API: get a single wall note
2012-12-01 05:20:45 -05:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
POST /projects/:id/issues/:issue_id/notes
API: get a single wall note
2012-12-01 05:20:45 -05:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 12:47:04 -05:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
+ `issue_id` (required) - The ID of an issue
+ `body` (required) - The content of a note
## Snippets
### List all snippet notes
Gets a list of all notes for a single snippet. Snippet notes are comments users can post to a snippet.
add docs for notes API
2012-11-29 15:32:05 -05:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
GET /projects/:id/snippets/:snippet_id/notes
add docs for notes API
2012-11-29 15:32:05 -05:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 12:47:04 -05:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
+ `snippet_id` (required) - The ID of a project snippet
add docs for notes API
2012-11-29 15:32:05 -05:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
### Get single snippet note
add docs for notes API
2012-11-29 15:32:05 -05:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
Returns a single note for a given snippet.
add docs for notes API
2012-11-29 15:32:05 -05:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
GET /projects/:id/snippets/:snippet_id/notes/:note_id
add docs for notes API
2012-11-29 15:32:05 -05:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 12:47:04 -05:00
+ `id` (required) - The ID of a project
add docs for notes API
2012-11-29 15:32:05 -05:00
+ `snippet_id` (required) - The ID of a project snippet
+ `note_id` (required) - The ID of an snippet note
Update issues, milestones, notes api docs.
2013-10-02 06:08:07 -04:00
```json
{
"id":52,
"title":"Snippet",
"file_name":"snippet.rb",
"author":{
"id":1,
"username":"pipin",
"email":"admin@example.com",
"name":"Pip",
"state":"active",
"created_at":"2013-09-30T13:46:01Z"
},
"expires_at":null,
"updated_at":"2013-10-02T07:34:20Z",
"created_at":"2013-10-02T07:34:20Z"
}
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
### Create new snippet note
Creates a new note for a single snippet. Snippet notes are comments users can post to a snippet.
API: ability to create a wall note
2012-11-29 18:52:56 -05:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
POST /projects/:id/snippets/:snippet_id/notes
API: ability to create a wall note
2012-11-29 18:52:56 -05:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 12:47:04 -05:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
+ `snippet_id` (required) - The ID of an snippet
API: ability to create a wall note
2012-11-29 18:52:56 -05:00
+ `body` (required) - The content of a note
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
## Merge Requests
### List all merge request notes
Gets a list of all notes for a single merge request.
add docs for notes API
2012-11-29 15:32:05 -05:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
GET /projects/:id/merge_requests/:merge_request_id/notes
add docs for notes API
2012-11-29 15:32:05 -05:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 12:47:04 -05:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
+ `merge_request_id` (required) - The ID of a project merge request
add docs for notes API
2012-11-29 15:32:05 -05:00
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
### Get single merge request note
Returns a single note for a given merge request.
add docs for notes API
2012-11-29 15:32:05 -05:00
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
GET /projects/:id/merge_requests/:merge_request_id/notes/:note_id
add docs for notes API
2012-11-29 15:32:05 -05:00
```
Parameters:
Remove all references tp the project code parameter from the API
2012-12-21 12:47:04 -05:00
+ `id` (required) - The ID of a project
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
+ `merge_request_id` (required) - The ID of a project merge request
+ `note_id` (required) - The ID of a merge request note
Update issues, milestones, notes api docs.
2013-10-02 06:08:07 -04:00
```json
{
"id":301,
"body":"Comment for MR",
"attachment":null,
"author":{
"id":1,
"username":"pipin",
"email":"admin@example.com",
"name":"Pip",
"state":"active",
"created_at":"2013-09-30T13:46:01Z"
},
"created_at":"2013-10-02T08:57:14Z"
}
```
API: fixes return codes for notes, documentation updated The notes API documentation updated with return codes. API now returns `400 Bad Request` if required attributes are not present. Return codes are documented now, also tested in added tests. The documentation now reflects the current state of the API.
2013-02-20 16:17:05 -05:00
### Create new merge request note
Creates a new note for a single merge request.
```
POST /projects/:id/merge_requests/:merge_request_id/notes
```
Parameters:
+ `id` (required) - The ID of a project
+ `merge_request_id` (required) - The ID of a merge request
add docs for notes API
2012-11-29 15:32:05 -05:00
+ `body` (required) - The content of a note
Copy permalink