kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Update API docs for new namespace format

Browse source 
Follow-up to d05dd81b which changed the nested namespaces in projects
to use API::Entities::Namespace instead of exposing all fields.

Fixes #27730
This commit is contained in:
Markus Koller 2017-02-08 21:08:18 +01:00
parent 6d97120139
commit 09a04107c3
No known key found for this signature in database
GPG key ID: A2B74A05A7A2B7B7
3 changed files with 18 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
changelogs/unreleased/fixes-namespace-api-documentation.yml Normal file
View file

@ -0,0 +1,4 @@
---
title: Update API docs for new namespace format
merge_request: 9073
author: Markus Koller

50
doc/api/groups.md
View file

@ -105,15 +105,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,
@ -188,15 +180,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,
@ -235,15 +219,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,
@ -284,15 +260,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,
@ -412,15 +380,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,

45
doc/api/projects.md
View file

@ -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:
"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:
"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:
"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:
"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:
"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:
"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:
"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:
"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": {