mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-27 20:26:09 +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
81 lines
2.8 KiB
Go
81 lines
2.8 KiB
Go
// Copyright 2016 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"
|
|
)
|
|
|
|
// Milestone milestone is a collection of issues on one repository
|
|
type Milestone struct {
|
|
ID int64 `json:"id"`
|
|
Title string `json:"title"`
|
|
Description string `json:"description"`
|
|
State StateType `json:"state"`
|
|
OpenIssues int `json:"open_issues"`
|
|
ClosedIssues int `json:"closed_issues"`
|
|
// swagger:strfmt date-time
|
|
Closed *time.Time `json:"closed_at"`
|
|
// swagger:strfmt date-time
|
|
Deadline *time.Time `json:"due_on"`
|
|
}
|
|
|
|
// ListRepoMilestones list all the milestones of one repository
|
|
func (c *Client) ListRepoMilestones(owner, repo string) ([]*Milestone, error) {
|
|
milestones := make([]*Milestone, 0, 10)
|
|
return milestones, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/milestones", owner, repo), nil, nil, &milestones)
|
|
}
|
|
|
|
// GetMilestone get one milestone by repo name and milestone id
|
|
func (c *Client) GetMilestone(owner, repo string, id int64) (*Milestone, error) {
|
|
milestone := new(Milestone)
|
|
return milestone, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/milestones/%d", owner, repo, id), nil, nil, milestone)
|
|
}
|
|
|
|
// CreateMilestoneOption options for creating a milestone
|
|
type CreateMilestoneOption struct {
|
|
Title string `json:"title"`
|
|
Description string `json:"description"`
|
|
// swagger:strfmt date-time
|
|
Deadline *time.Time `json:"due_on"`
|
|
}
|
|
|
|
// CreateMilestone create one milestone with options
|
|
func (c *Client) CreateMilestone(owner, repo string, opt CreateMilestoneOption) (*Milestone, error) {
|
|
body, err := json.Marshal(&opt)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
milestone := new(Milestone)
|
|
return milestone, c.getParsedResponse("POST", fmt.Sprintf("/repos/%s/%s/milestones", owner, repo), jsonHeader, bytes.NewReader(body), milestone)
|
|
}
|
|
|
|
// EditMilestoneOption options for editing a milestone
|
|
type EditMilestoneOption struct {
|
|
Title string `json:"title"`
|
|
Description *string `json:"description"`
|
|
State *string `json:"state"`
|
|
Deadline *time.Time `json:"due_on"`
|
|
}
|
|
|
|
// EditMilestone modify milestone with options
|
|
func (c *Client) EditMilestone(owner, repo string, id int64, opt EditMilestoneOption) (*Milestone, error) {
|
|
body, err := json.Marshal(&opt)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
milestone := new(Milestone)
|
|
return milestone, c.getParsedResponse("PATCH", fmt.Sprintf("/repos/%s/%s/milestones/%d", owner, repo, id), jsonHeader, bytes.NewReader(body), milestone)
|
|
}
|
|
|
|
// DeleteMilestone delete one milestone by milestone id
|
|
func (c *Client) DeleteMilestone(owner, repo string, id int64) error {
|
|
_, err := c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/milestones/%d", owner, repo, id), nil, nil)
|
|
return err
|
|
}
|