Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArtem V. Navrotskiy <navrotskiy@corp.mail.ru>2015-09-03 16:32:21 +0300
committerArtem V. Navrotskiy <navrotskiy@corp.mail.ru>2015-09-03 16:32:26 +0300
commit1be79e8e7cd20abaec7d2efcbbf7d7fe4e2a0760 (patch)
treeef46d881fa0d971d1aee62bb513cbdcff8ea0782 /doc
parent8ec59bd18bcacf13c012a34b3e37c2c9167bcc65 (diff)
Move get user by ID of an SSH key documentation to separate file
Diffstat (limited to 'doc')
-rw-r--r--doc/api/README.md1
-rw-r--r--doc/api/keys.md46
-rw-r--r--doc/api/users.md45
3 files changed, 47 insertions, 45 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index f369c3fd978..6b8528de50c 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -21,6 +21,7 @@
- [Groups](groups.md)
- [Namespaces](namespaces.md)
- [Settings](settings.md)
+- [Keys](keys.md)
## Clients
diff --git a/doc/api/keys.md b/doc/api/keys.md
new file mode 100644
index 00000000000..faa6f212b43
--- /dev/null
+++ b/doc/api/keys.md
@@ -0,0 +1,46 @@
+# Keys
+
+## Get SSH key with user by ID of an SSH key
+
+Get SSH key with user by ID of an SSH key. Note only administrators can lookup SSH key with user by ID of an SSH key.
+
+```
+GET /keys/:id
+```
+
+Parameters:
+
+- `id` (required) - The ID of an SSH key
+
+```json
+{
+ "id": 1,
+ "title": "Sample key 25",
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt1256k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
+ "created_at": "2015-09-03T07:24:44.627Z",
+ "user": {
+ "name": "John Smith",
+ "username": "john_smith",
+ "id": 25,
+ "state": "active",
+ "avatar_url": "http://www.gravatar.com/avatar/cfa35b8cd2ec278026357769582fa563?s=40\u0026d=identicon",
+ "web_url": "http://localhost:3000/u/john_smith",
+ "created_at": "2015-09-03T07:24:01.670Z",
+ "is_admin": false,
+ "bio": null,
+ "skype": "",
+ "linkedin": "",
+ "twitter": "",
+ "website_url": "",
+ "email": "john@example.com",
+ "theme_id": 2,
+ "color_scheme_id": 1,
+ "projects_limit": 10,
+ "current_sign_in_at": null,
+ "identities": [],
+ "can_create_group": true,
+ "can_create_project": true,
+ "two_factor_enabled": false
+ }
+}
+```
diff --git a/doc/api/users.md b/doc/api/users.md
index eb6726b60d3..7ba2db248ff 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -150,51 +150,6 @@ Parameters:
}
```
-### Get SSH key with user by ID of an SSH key
-
-Get SSH key with user by ID of an SSH key. Note only administrators can lookup SSH key with user by ID of an SSH key.
-
-```
-GET /keys/:id
-```
-
-Parameters:
-
-- `id` (required) - The ID of an SSH key
-
-```json
-{
- "id": 1,
- "title": "Sample key 25",
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt1256k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
- "created_at": "2015-09-03T07:24:44.627Z",
- "user": {
- "name": "John Smith",
- "username": "john_smith",
- "id": 25,
- "state": "active",
- "avatar_url": "http://www.gravatar.com/avatar/cfa35b8cd2ec278026357769582fa563?s=40\u0026d=identicon",
- "web_url": "http://localhost:3000/u/john_smith",
- "created_at": "2015-09-03T07:24:01.670Z",
- "is_admin": false,
- "bio": null,
- "skype": "",
- "linkedin": "",
- "twitter": "",
- "website_url": "",
- "email": "john@example.com",
- "theme_id": 2,
- "color_scheme_id": 1,
- "projects_limit": 10,
- "current_sign_in_at": null,
- "identities": [],
- "can_create_group": true,
- "can_create_project": true,
- "two_factor_enabled": false
- }
-}
-```
-
## User creation
Creates a new user. Note only administrators can create new users.