Skip to content

G
gitlab-ce
Commit 8b40c9ca authored by Rémy Coutable's avatar Rémy Coutable
Browse files
Options

Merge branch 'fixes/namespace-api-documentation' into 'master' 

Update API docs for new namespace format

Closes #27730

See merge request !9073
parents 4975f416 09a04107
Hide whitespace changes
Inline Side-by-side
Showing with 18 additions and 81 deletions
changelogs/unreleased/fixes-namespace-api-documentation.yml 0 → 100644
View file @ 8b40c9ca
---
title: Update API docs for new namespace format
merge_request: 9073
author: Markus Koller
doc/api/groups.md
View file @ 8b40c9ca
...@@ -106,15 +106,7 @@ Example response: ...@@ -106,15 +106,7 @@ Example response:
"id": 5, "id": 5,
"name": "Experimental", "name": "Experimental",
"path": "h5bp", "path": "h5bp",
"owner_id": null, "kind": "group"
"created_at": "2016-04-05T21:40:49.152Z",
"updated_at": "2016-04-07T08:07:48.466Z",
"description": "foo",
"avatar": {
"url": null
},
"share_with_group_lock": false,
"visibility_level": 10
}, },
"avatar_url": null, "avatar_url": null,
"star_count": 1, "star_count": 1,
...@@ -190,15 +182,7 @@ Example response: ...@@ -190,15 +182,7 @@ Example response:
"id": 4, "id": 4,
"name": "Twitter", "name": "Twitter",
"path": "twitter", "path": "twitter",
"owner_id": null, "kind": "group"
"created_at": "2016-06-17T07:47:24.216Z",
"updated_at": "2016-06-17T07:47:24.216Z",
"description": "Aliquid qui quis dignissimos distinctio ut commodi voluptas est.",
"avatar": {
"url": null
},
"share_with_group_lock": false,
"visibility_level": 20
}, },
"avatar_url": null, "avatar_url": null,
"star_count": 0, "star_count": 0,
...@@ -237,15 +221,7 @@ Example response: ...@@ -237,15 +221,7 @@ Example response:
"id": 4, "id": 4,
"name": "Twitter", "name": "Twitter",
"path": "twitter", "path": "twitter",
"owner_id": null, "kind": "group"
"created_at": "2016-06-17T07:47:24.216Z",
"updated_at": "2016-06-17T07:47:24.216Z",
"description": "Aliquid qui quis dignissimos distinctio ut commodi voluptas est.",
"avatar": {
"url": null
},
"share_with_group_lock": false,
"visibility_level": 20
}, },
"avatar_url": null, "avatar_url": null,
"star_count": 0, "star_count": 0,
...@@ -286,15 +262,7 @@ Example response: ...@@ -286,15 +262,7 @@ Example response:
"id": 5, "id": 5,
"name": "H5bp", "name": "H5bp",
"path": "h5bp", "path": "h5bp",
"owner_id": null, "kind": "group"
"created_at": "2016-06-17T07:47:26.621Z",
"updated_at": "2016-06-17T07:47:26.621Z",
"description": "Id consequatur rem vel qui doloremque saepe.",
"avatar": {
"url": null
},
"share_with_group_lock": false,
"visibility_level": 20
}, },
"avatar_url": null, "avatar_url": null,
"star_count": 0, "star_count": 0,
...@@ -416,15 +384,7 @@ Example response: ...@@ -416,15 +384,7 @@ Example response:
"id": 5, "id": 5,
"name": "Experimental", "name": "Experimental",
"path": "h5bp", "path": "h5bp",
"owner_id": null, "kind": "group"
"created_at": "2016-04-05T21:40:49.152Z",
"updated_at": "2016-04-07T08:07:48.466Z",
"description": "foo",
"avatar": {
"url": null
},
"share_with_group_lock": false,
"visibility_level": 10
}, },
"avatar_url": null, "avatar_url": null,
"star_count": 1, "star_count": 1,
......
doc/api/projects.md
View file @ 8b40c9ca
...@@ -72,13 +72,10 @@ Parameters: ...@@ -72,13 +72,10 @@ Parameters:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 3, "id": 3,
"name": "Diaspora", "name": "Diaspora",
"owner_id": 1,
"path": "diaspora", "path": "diaspora",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"archived": false, "archived": false,
"avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png", "avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
...@@ -125,13 +122,10 @@ Parameters: ...@@ -125,13 +122,10 @@ Parameters:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 4, "id": 4,
"name": "Brightbox", "name": "Brightbox",
"owner_id": 1,
"path": "brightbox", "path": "brightbox",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"permissions": { "permissions": {
"project_access": { "project_access": {
...@@ -210,13 +204,10 @@ Parameters: ...@@ -210,13 +204,10 @@ Parameters:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 3, "id": 3,
"name": "Diaspora", "name": "Diaspora",
"owner_id": 1,
"path": "diaspora", "path": "diaspora",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"archived": false, "archived": false,
"avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png", "avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
...@@ -260,13 +251,10 @@ Parameters: ...@@ -260,13 +251,10 @@ Parameters:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 4, "id": 4,
"name": "Brightbox", "name": "Brightbox",
"owner_id": 1,
"path": "brightbox", "path": "brightbox",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"permissions": { "permissions": {
"project_access": { "project_access": {
...@@ -398,13 +386,10 @@ Parameters: ...@@ -398,13 +386,10 @@ Parameters:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 3, "id": 3,
"name": "Diaspora", "name": "Diaspora",
"owner_id": 1,
"path": "diaspora", "path": "diaspora",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"permissions": { "permissions": {
"project_access": { "project_access": {
...@@ -779,13 +764,10 @@ Example response: ...@@ -779,13 +764,10 @@ Example response:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 3, "id": 3,
"name": "Diaspora", "name": "Diaspora",
"owner_id": 1,
"path": "diaspora", "path": "diaspora",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"archived": true, "archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png", "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
...@@ -847,13 +829,10 @@ Example response: ...@@ -847,13 +829,10 @@ Example response:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 3, "id": 3,
"name": "Diaspora", "name": "Diaspora",
"owner_id": 1,
"path": "diaspora", "path": "diaspora",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"archived": true, "archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png", "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
...@@ -921,13 +900,10 @@ Example response: ...@@ -921,13 +900,10 @@ Example response:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 3, "id": 3,
"name": "Diaspora", "name": "Diaspora",
"owner_id": 1,
"path": "diaspora", "path": "diaspora",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"permissions": { "permissions": {
"project_access": { "project_access": {
...@@ -1006,13 +982,10 @@ Example response: ...@@ -1006,13 +982,10 @@ Example response:
"last_activity_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3, "creator_id": 3,
"namespace": { "namespace": {
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 3, "id": 3,
"name": "Diaspora", "name": "Diaspora",
"owner_id": 1,
"path": "diaspora", "path": "diaspora",
"updated_at": "2013-09-30T13:46:02Z" "kind": "group"
}, },
"permissions": { "permissions": {
"project_access": { "project_access": {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7