Skip to content

G
gitlab-ce
Commit 465c1fb1 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files
Options

Re-align CE and EE API docs 

There were some things missing in the EE port of
https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/14523/diffs.
This aligns all docs again, hopefully it's the last time.
parent 2e25587d
Hide whitespace changes
Inline Side-by-side
Showing with 39 additions and 51 deletions
doc/api/groups.md
View file @ 465c1fb1
......@@ -240,8 +240,6 @@ Example response:
"full_path": "twitter",
"file_template_project_id": 1,
"parent_id": null,
"shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133,
"projects": [
{
"id": 7,
......
doc/api/issues.md
View file @ 465c1fb1
......@@ -120,7 +120,6 @@ Example response:
"user_notes_count": 1,
"due_date": "2016-07-22",
"web_url": "http://example.com/example/example/issues/6",
"weight": null,
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
......@@ -270,7 +269,6 @@ Example response:
"user_notes_count": 1,
"due_date": null,
"web_url": "http://example.com/example/example/issues/1",
"weight": null,
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
......@@ -428,7 +426,6 @@ Example response:
"user_notes_count": 1,
"due_date": "2016-07-22",
"web_url": "http://example.com/example/example/issues/1",
"weight": null,
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
......@@ -554,7 +551,6 @@ Example response:
"human_total_time_spent": null
},
"confidential": false,
"weight": null,
"discussion_locked": false,
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
......@@ -603,7 +599,7 @@ POST /projects/:id/issues
| `assignee_ids` | Array[integer] | no | The ID of a user to assign issue |
| `milestone_id` | integer | no | The global ID of a milestone to assign issue |
| `labels` | string | no | Comma-separated label names for an issue |
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project/group owner rights) |
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project/group owner rights) |
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
| `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. When passing a description or title, these values will take precedence over the default values.|
| `discussion_to_resolve` | string | no | The ID of a discussion to resolve. This will fill in the issue with a default description and mark the discussion as resolved. Use in combination with `merge_request_to_resolve_discussions_of`. |
......@@ -655,7 +651,6 @@ Example response:
"human_total_time_spent": null
},
"confidential": false,
"weight": null,
"discussion_locked": false,
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
......@@ -764,7 +759,6 @@ Example response:
"human_total_time_spent": null
},
"confidential": false,
"weight": null,
"discussion_locked": false,
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
......@@ -887,7 +881,6 @@ Example response:
"human_total_time_spent": null
},
"confidential": false,
"weight": null,
"discussion_locked": false,
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
......@@ -989,7 +982,6 @@ Example response:
"human_total_time_spent": null
},
"confidential": false,
"weight": null,
"discussion_locked": false,
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
......
doc/api/namespaces.md
View file @ 465c1fb1
......@@ -37,11 +37,10 @@ Example response:
"id": 2,
"name": "group1",
"path": "group1",
"kind": "group"
"kind": "group",
"full_path": "group1",
"parent_id": null,
"members_count_with_descendants": 2,
"plan": "bronze"
"members_count_with_descendants": 2
},
{
"id": 3,
......
doc/api/notification_settings.md
View file @ 465c1fb1
......@@ -179,8 +179,7 @@ Example responses:
"reassign_merge_request": false,
"merge_merge_request": false,
"failed_pipeline": false,
"success_pipeline": false,
"new_epic": false
"success_pipeline": false
}
}
```
......
doc/api/projects.md
View file @ 465c1fb1
......@@ -150,7 +150,6 @@ When the user is authenticated and `simple` is not set this returns something li
"only_allow_merge_if_all_discussions_are_resolved": false,
"request_access_enabled": false,
"merge_method": "merge",
"approvals_before_merge": 0,
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
......@@ -235,7 +234,6 @@ When the user is authenticated and `simple` is not set this returns something li
"only_allow_merge_if_all_discussions_are_resolved": false,
"request_access_enabled": false,
"merge_method": "merge",
"approvals_before_merge": 0,
"statistics": {
"commit_count": 12,
"storage_size": 2066080,
......@@ -574,7 +572,6 @@ GET /projects/:id
"printing_merge_requests_link_enabled": true,
"request_access_enabled": false,
"merge_method": "merge",
"approvals_before_merge": 0,
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
......
doc/api/protected_branches.md
View file @ 465c1fb1
......@@ -38,17 +38,13 @@ Example response:
"push_access_levels": [
{
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "Maintainers"
}
],
"merge_access_levels": [
{
"access_level": null,
"user_id": null,
"group_id": 1234,
"access_level_description": "Example Merge Group"
"access_level": 40,
"access_level_description": "Maintainers"
}
]
},
......@@ -141,17 +137,13 @@ Example response:
"push_access_levels": [
{
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "Maintainers"
}
],
"merge_access_levels": [
{
"access_level": null,
"user_id": null,
"group_id": 1234,
"access_level_description": "Example Merge Group"
"access_level": 40,
"access_level_description": "Maintainers"
}
]
}
......@@ -243,16 +235,12 @@ Example response:
"push_access_levels": [
{
"access_level": 30,
"user_id": null,
"group_id": null,
"access_level_description": "Developers + Maintainers"
}
],
"merge_access_levels": [
{
"access_level": 30,
"user_id": null,
"group_id": null,
"access_level_description": "Developers + Maintainers"
],
"unprotect_access_levels": [
......
doc/api/settings.md
View file @ 465c1fb1
......@@ -63,9 +63,7 @@ Example response:
"performance_bar_allowed_group_id": 42,
"instance_statistics_visibility_private": false,
"user_show_add_ssh_key_message": true,
"file_template_project_id": 1,
"local_markdown_version": 0,
"geo_node_allowed_ips": "0.0.0.0/0, ::/0"
"local_markdown_version": 0
}
```
......@@ -121,10 +119,6 @@ Example response:
"plantuml_url": null,
"terminal_max_session_time": 0,
"polling_interval_multiplier": 1.0,
"external_authorization_service_enabled": true,
"external_authorization_service_url": "https://authorize.me",
"external_authorization_service_default_label": "default",
"external_authorization_service_timeout": 0.5,
"rsa_key_restriction": 0,
"dsa_key_restriction": 0,
"ecdsa_key_restriction": 0,
......
doc/api/users.md
View file @ 465c1fb1
......@@ -105,8 +105,7 @@ GET /users
"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}
{"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"}
],
"can_create_group": true,
"can_create_project": true,
......@@ -148,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:
```
......@@ -255,21 +272,19 @@ Example Responses:
"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}
{"provider": "google_oauth2", "extern_uid": "8776128412476123468721346"}
],
"can_create_group": true,
"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
{
......@@ -277,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}
],
...
}
```
......@@ -1287,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
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