mirror of
https://github.com/go-gitea/gitea.git
synced 2025-11-03 20:36:07 +01:00
f26f4a7e01
* Update swagger documentation Add docs for missing endpoints Add documentation for request parameters Make parameter naming consistent Fix response documentation * Restore delete comments
66 lines
1.9 KiB
Go
66 lines
1.9 KiB
Go
// Copyright 2015 The Gogs Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package gitea
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"fmt"
|
|
"time"
|
|
)
|
|
|
|
// DeployKey a deploy key
|
|
type DeployKey struct {
|
|
ID int64 `json:"id"`
|
|
Key string `json:"key"`
|
|
URL string `json:"url"`
|
|
Title string `json:"title"`
|
|
// swagger:strfmt date-time
|
|
Created time.Time `json:"created_at"`
|
|
ReadOnly bool `json:"read_only"`
|
|
}
|
|
|
|
// ListDeployKeys list all the deploy keys of one repository
|
|
func (c *Client) ListDeployKeys(user, repo string) ([]*DeployKey, error) {
|
|
keys := make([]*DeployKey, 0, 10)
|
|
return keys, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/keys", user, repo), nil, nil, &keys)
|
|
}
|
|
|
|
// GetDeployKey get one deploy key with key id
|
|
func (c *Client) GetDeployKey(user, repo string, keyID int64) (*DeployKey, error) {
|
|
key := new(DeployKey)
|
|
return key, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/keys/%d", user, repo, keyID), nil, nil, &key)
|
|
}
|
|
|
|
// CreateKeyOption options when creating a key
|
|
type CreateKeyOption struct {
|
|
// Title of the key to add
|
|
//
|
|
// required: true
|
|
// unique: true
|
|
Title string `json:"title" binding:"Required"`
|
|
// An armored SSH key to add
|
|
//
|
|
// required: true
|
|
// unique: true
|
|
Key string `json:"key" binding:"Required"`
|
|
}
|
|
|
|
// CreateDeployKey options when create one deploy key
|
|
func (c *Client) CreateDeployKey(user, repo string, opt CreateKeyOption) (*DeployKey, error) {
|
|
body, err := json.Marshal(&opt)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
key := new(DeployKey)
|
|
return key, c.getParsedResponse("POST", fmt.Sprintf("/repos/%s/%s/keys", user, repo), jsonHeader, bytes.NewReader(body), key)
|
|
}
|
|
|
|
// DeleteDeployKey delete deploy key with key id
|
|
func (c *Client) DeleteDeployKey(owner, repo string, keyID int64) error {
|
|
_, err := c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/keys/%d", owner, repo, keyID), nil, nil)
|
|
return err
|
|
}
|