diff options
author | Marcia Ramos <marcia@gitlab.com> | 2019-07-03 15:39:45 +0000 |
---|---|---|
committer | Marcia Ramos <marcia@gitlab.com> | 2019-07-03 15:39:45 +0000 |
commit | 03ee977a0aabb69abbd0a966597c3114402c808f (patch) | |
tree | b3ef67dbe31fd6148fe6720b623756976daccb00 | |
parent | 80bb04ebbd27d08dfd263ba00f8e0612a3e486af (diff) | |
parent | 9671ca19de430e49b6cb2a51d2405c640dfddd16 (diff) | |
download | gitlab-ce-03ee977a0aabb69abbd0a966597c3114402c808f.tar.gz |
Merge branch 'docs/api-single-codebase' into 'master'
Re-align CE and EE API docs
See merge request gitlab-org/gitlab-ce!30294
-rw-r--r-- | doc/api/group_boards.md | 22 | ||||
-rw-r--r-- | doc/api/users.md | 33 |
2 files changed, 48 insertions, 7 deletions
diff --git a/doc/api/group_boards.md b/doc/api/group_boards.md index 4bee05a128a..a677a9c9a33 100644 --- a/doc/api/group_boards.md +++ b/doc/api/group_boards.md @@ -27,7 +27,16 @@ Example response: [ { "id": 1, - "group_id": 5, + "name:": "group issue board", + "group": { + "id": 5, + "name": "Documentcloud", + "web_url": "http://example.com/groups/documentcloud" + }, + "milestone": { + "id": 12 + "title": "10.0" + }, "lists" : [ { "id" : 1, @@ -136,7 +145,16 @@ Example response: ```json { "id": 1, - "group_id": 5, + "name:": "group issue board", + "group": { + "id": 5, + "name": "Documentcloud", + "web_url": "http://example.com/groups/documentcloud" + }, + "milestone": { + "id": 12 + "title": "10.0" + }, "lists" : [ { "id" : 1, diff --git a/doc/api/users.md b/doc/api/users.md index 5615dcdd307..6be097e6364 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -147,6 +147,24 @@ GET /users ] ``` +Users on GitLab [Silver or higher](https://about.gitlab.com/pricing/) will also see +the `group_saml` provider option: + +```json +[ + { + "id": 1, + ... + "identities": [ + {"provider": "github", "extern_uid": "2435223452345"}, + {"provider": "bitbucket", "extern_uid": "john.smith"}, + {"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"}, + {"provider": "group_saml", "extern_uid": "123789", "saml_provider_id": 10} + ], + ... + } +] + You can lookup users by external UID and provider: ``` @@ -260,14 +278,13 @@ Example Responses: "can_create_project": true, "two_factor_enabled": true, "external": false, - "private_profile": false, - "shared_runners_minutes_limit": 133 - "extra_shared_runners_minutes_limit": 133 + "private_profile": false } ``` Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see -the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` parameters: **[STARTER]** +the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` parameters. +Users on GitLab Silver will also see the `group_saml` option: ```json { @@ -275,6 +292,12 @@ the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` para "username": "john_smith", "shared_runners_minutes_limit": 133, "extra_shared_runners_minutes_limit": 133 + "identities": [ + {"provider": "github", "extern_uid": "2435223452345"}, + {"provider": "bitbucket", "extern_uid": "john.smith"}, + {"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"}, + {"provider": "group_saml", "extern_uid": "123789", "saml_provider_id": 10} + ], ... } ``` @@ -1285,4 +1308,4 @@ Example response: Please note that `last_activity_at` is deprecated, please use `last_activity_on`. -[gemojione-index]: https://github.com/jonathanwiesel/gemojione/blob/master/config/index.json
\ No newline at end of file +[gemojione-index]: https://github.com/jonathanwiesel/gemojione/blob/master/config/index.json |