Docs added
This commit is contained in:
parent
c23eb40829
commit
87d40fd276
4 changed files with 106 additions and 0 deletions
|
@ -34,3 +34,4 @@ When listing resources you can pass the following parameters:
|
||||||
+ [Snippets](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/snippets.md)
|
+ [Snippets](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/snippets.md)
|
||||||
+ [Issues](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md)
|
+ [Issues](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md)
|
||||||
+ [Milestones](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/milestones.md)
|
+ [Milestones](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/milestones.md)
|
||||||
|
+ [SSH Keys](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/keys.md)
|
||||||
|
|
79
doc/api/keys.md
Normal file
79
doc/api/keys.md
Normal file
|
@ -0,0 +1,79 @@
|
||||||
|
## List keys
|
||||||
|
|
||||||
|
Get a list of currently authenticated user's keys.
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /keys
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"id": 1,
|
||||||
|
"title" : "Public key"
|
||||||
|
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
|
||||||
|
596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
|
||||||
|
soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 3,
|
||||||
|
"title" : "Another Public key"
|
||||||
|
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
|
||||||
|
596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
|
||||||
|
soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Single key
|
||||||
|
|
||||||
|
Get a single key.
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /keys/:id
|
||||||
|
```
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
|
||||||
|
+ `id` (required) - The ID of a key
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": 1,
|
||||||
|
"title" : "Public key"
|
||||||
|
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
|
||||||
|
596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
|
||||||
|
soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
|
||||||
|
}
|
||||||
|
```
|
||||||
|
## Add key
|
||||||
|
|
||||||
|
Create new key owned by currently authenticated user
|
||||||
|
|
||||||
|
```
|
||||||
|
POST /keys
|
||||||
|
```
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
|
||||||
|
+ `title` (required) - new SSH Key
|
||||||
|
+ `key` (optional) - new SSH key's title
|
||||||
|
|
||||||
|
Will return created key with status `201 Created` on success, or `404 Not
|
||||||
|
found` on fail.
|
||||||
|
|
||||||
|
## Delete key
|
||||||
|
|
||||||
|
Delete key owned by currently authenticated user
|
||||||
|
|
||||||
|
```
|
||||||
|
DELETE /keys/:id
|
||||||
|
```
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
|
||||||
|
+ `id` (required) - key ID
|
||||||
|
|
||||||
|
Will return `200 OK` on success, or `404 Not Found` on fail.
|
||||||
|
|
||||||
|
|
|
@ -10,6 +10,14 @@ module Gitlab
|
||||||
get do
|
get do
|
||||||
present current_user.keys, with: Entities::Key
|
present current_user.keys, with: Entities::Key
|
||||||
end
|
end
|
||||||
|
# Get single key owned by currently authenticated user
|
||||||
|
#
|
||||||
|
# Example Request:
|
||||||
|
# GET /keys/:id
|
||||||
|
get "/:id" do
|
||||||
|
key = current_user.keys.find params[:id]
|
||||||
|
present key, with: Entities::Key
|
||||||
|
end
|
||||||
# Add new ssh key to currently authenticated user
|
# Add new ssh key to currently authenticated user
|
||||||
#
|
#
|
||||||
# Parameters:
|
# Parameters:
|
||||||
|
|
|
@ -28,6 +28,20 @@ describe Gitlab::Keys do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
describe "GET /keys/:id" do
|
||||||
|
it "should returm single key" do
|
||||||
|
user.keys << key
|
||||||
|
user.save
|
||||||
|
get api("/keys/#{key.id}", user)
|
||||||
|
response.status.should == 200
|
||||||
|
json_response["title"].should == key.title
|
||||||
|
end
|
||||||
|
it "should return 404 Not Found within invalid ID" do
|
||||||
|
get api("/keys/42", user)
|
||||||
|
response.status.should == 404
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
describe "POST /keys" do
|
describe "POST /keys" do
|
||||||
it "should not create invalid ssh key" do
|
it "should not create invalid ssh key" do
|
||||||
post api("/keys", user), { title: "invalid key" }
|
post api("/keys", user), { title: "invalid key" }
|
||||||
|
@ -49,6 +63,10 @@ describe Gitlab::Keys do
|
||||||
delete api("/keys/#{key.id}", user)
|
delete api("/keys/#{key.id}", user)
|
||||||
}.to change{user.keys.count}.by(-1)
|
}.to change{user.keys.count}.by(-1)
|
||||||
end
|
end
|
||||||
|
it "should return 404 Not Found within invalid ID" do
|
||||||
|
delete api("/keys/42", user)
|
||||||
|
response.status.should == 404
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
Loading…
Reference in a new issue