summaryrefslogtreecommitdiff
path: root/doc/api/projects.md
diff options
context:
space:
mode:
authorJohannes Schleifenbaum <johannes@js-webcoding.de>2014-04-05 08:36:47 +0200
committerJohannes Schleifenbaum <johannes@js-webcoding.de>2014-04-05 08:37:42 +0200
commit49addad7b5f18776dbd593f628237736e638b28c (patch)
tree76f4b72c20dd8e92d596dd619791e81076d79fd0 /doc/api/projects.md
parent1f1cfc9eba6d9b60decb4fcd0645fcbfd288925f (diff)
downloadgitlab-ce-49addad7b5f18776dbd593f628237736e638b28c.tar.gz
Api-Doc JSON lint
Fixes: #5505
Diffstat (limited to 'doc/api/projects.md')
-rw-r--r--doc/api/projects.md150
1 files changed, 79 insertions, 71 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 54618d7c045..40bcc6e2cd4 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -54,7 +54,7 @@ GET /projects
"ssh_url_to_repo": "git@example.com:brightbox/puppet.git",
"http_url_to_repo": "http://example.com/brightbox/puppet.git",
"web_url": "http://example.com/brightbox/puppet",
- "owner": {
+ "owner": {
"id": 4,
"name": "Brightbox",
"created_at": "2013-09-30T13:46:02Z"
@@ -70,7 +70,7 @@ GET /projects
"snippets_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
- "namespace": {
+ "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 4,
@@ -147,7 +147,7 @@ Parameters:
"owner_id": 1,
"path": "diaspora",
"updated_at": "2013-09-30T13: 46: 02Z"
- }
+ },
"permissions": {
"project_access": {
"access_level": 10,
@@ -175,58 +175,63 @@ Parameters:
+ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
```json
-
-[{
- "title": null,
- "project_id": 15,
- "action_name": "closed",
- "target_id": 830,
- "target_type": "Issue",
- "author_id": 1,
- "data": null,
- "target_title": "Public project search field"
-}, {
- "title": null,
- "project_id": 15,
- "action_name": "opened",
- "target_id": null,
- "target_type": null,
- "author_id": 1,
- "data": {
- "before": "50d4420237a9de7be1304607147aec22e4a14af7",
- "after": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
- "ref": "refs/heads/master",
- "user_id": 1,
- "user_name": "Dmitriy Zaporozhets",
- "repository": {
- "name": "gitlabhq",
- "url": "git@dev.gitlab.org:gitlab/gitlabhq.git",
- "description": "GitLab: self hosted Git management software. \r\nDistributed under the MIT License.",
- "homepage": "https://dev.gitlab.org/gitlab/gitlabhq"
+[
+ {
+ "title": null,
+ "project_id": 15,
+ "action_name": "closed",
+ "target_id": 830,
+ "target_type": "Issue",
+ "author_id": 1,
+ "data": null,
+ "target_title": "Public project search field"
+ },
+ {
+ "title": null,
+ "project_id": 15,
+ "action_name": "opened",
+ "target_id": null,
+ "target_type": null,
+ "author_id": 1,
+ "data": {
+ "before": "50d4420237a9de7be1304607147aec22e4a14af7",
+ "after": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
+ "ref": "refs/heads/master",
+ "user_id": 1,
+ "user_name": "Dmitriy Zaporozhets",
+ "repository": {
+ "name": "gitlabhq",
+ "url": "git@dev.gitlab.org:gitlab/gitlabhq.git",
+ "description": "GitLab: self hosted Git management software. \r\nDistributed under the MIT License.",
+ "homepage": "https://dev.gitlab.org/gitlab/gitlabhq"
+ },
+ "commits": [
+ {
+ "id": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
+ "message": "Add simple search to projects in public area",
+ "timestamp": "2013-05-13T18:18:08+00:00",
+ "url": "https://dev.gitlab.org/gitlab/gitlabhq/commit/c5feabde2d8cd023215af4d2ceeb7a64839fc428",
+ "author": {
+ "name": "Dmitriy Zaporozhets",
+ "email": "dmitriy.zaporozhets@gmail.com"
+ }
+ }
+ ],
+ "total_commits_count": 1
},
- "commits": [{
- "id": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
- "message": "Add simple search to projects in public area",
- "timestamp": "2013-05-13T18:18:08+00:00",
- "url": "https://dev.gitlab.org/gitlab/gitlabhq/commit/c5feabde2d8cd023215af4d2ceeb7a64839fc428",
- "author": {
- "name": "Dmitriy Zaporozhets",
- "email": "dmitriy.zaporozhets@gmail.com"
- }
- }],
- "total_commits_count": 1
+ "target_title": null
},
- "target_title": null
-}, {
- "title": null,
- "project_id": 15,
- "action_name": "closed",
- "target_id": 840,
- "target_type": "Issue",
- "author_id": 1,
- "data": null,
- "target_title": "Finish & merge Code search PR"
-}]
+ {
+ "title": null,
+ "project_id": 15,
+ "action_name": "closed",
+ "target_id": 840,
+ "target_type": "Issue",
+ "author_id": 1,
+ "data": null,
+ "target_title": "Finish & merge Code search PR"
+ }
+]
```
@@ -493,34 +498,38 @@ Parameters:
```json
[
{
- "name":"async",
+ "name": "async",
"commit": {
- "id":"a2b702edecdf41f07b42653eb1abe30ce98b9fca",
- "parents": [{
- "id":"3f94fc7c85061973edc9906ae170cc269b07ca55"
- }],
+ "id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca",
+ "parents": [
+ {
+ "id": "3f94fc7c85061973edc9906ae170cc269b07ca55"
+ }
+ ],
"tree": "c68537c6534a02cc2b176ca1549f4ffa190b58ee",
- "message":"give caolan credit where it's due (up top)",
+ "message": "give caolan credit where it's due (up top)",
"author": {
- "name":"Jeremy Ashkenas",
- "email":"jashkenas@example.com"
+ "name": "Jeremy Ashkenas",
+ "email": "jashkenas@example.com"
},
"committer": {
- "name":"Jeremy Ashkenas",
- "email":"jashkenas@example.com"
+ "name": "Jeremy Ashkenas",
+ "email": "jashkenas@example.com"
},
- "authored_date":"2010-12-08T21:28:50+00:00",
- "committed_date":"2010-12-08T21:28:50+00:00"
+ "authored_date": "2010-12-08T21:28:50+00:00",
+ "committed_date": "2010-12-08T21:28:50+00:00"
},
- "protected":false
+ "protected": false
},
{
"name": "gh-pages",
"commit": {
"id": "101c10a60019fe870d21868835f65c25d64968fc",
- "parents": [{
- "id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa"
- }],
+ "parents": [
+ {
+ "id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa"
+ }
+ ],
"tree": "fb5cc9d45da3014b17a876ad539976a0fb9b352a",
"message": "Underscore.js 1.5.2",
"author": {
@@ -537,7 +546,6 @@ Parameters:
"protected": false
}
]
-
```
### List single branch
@@ -640,7 +648,7 @@ Parameters:
```json
[
{
- "name":"featute"
+ "name": "feature"
},
{
"name": "bug"