Update Structs (#486)

* FileOptions: add Signoff
* Commit: add CommitAffectedFiles
* BranchProtection, CreateBranchProtectionOption, EditBranchProtectionOption: add BlockOnOfficialReviewRequests
* MigrateRepoOption: add MirrorInterval & enable gogs as source option
* EditRepoOption: Add new fields
* Repository: Add new fields & related structs
* PullReview: Add fields
* StopWatch: Add new fields
* EditIssueOption: Add option to delete Deadline
* EditUserOption: lot of options got optional

close #479

Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/486
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: Andrew Thornton <art27@cantab.net>
Co-authored-by: 6543 <6543@obermui.de>
Co-committed-by: 6543 <6543@obermui.de>

docs/migrate-v0.13-to-v0.14.md

@@ -6,8 +6,9 @@ feel free to create an issue.
 
 <!-- toc -->
 
--   [Removed Functions (#467)](#Removed-Functions)
+-   [Removed Functions (#467)](#removed-functions)
--   [Renamed Functions (#467)](#Renamed-Functions)
+-   [Renamed Functions (#467)](#renamed-functions)
+-   [New Optional Fields (#486)](#new-optional-fields)
 
 <!-- tocstop -->
 
@@ -25,3 +26,15 @@ Pulls:
 
 Pulls:
 -   [#467 Remove & Rename TrackedTimes list functions](https://gitea.com/gitea/go-sdk/pulls/467)
+
+
+## New Optional Fields
+
+The `EditUserOption` struct has gained several new Optional fields.
+For example Email type changed from `string` to `*string`.
+
+The easiest migration path is, to wrap your options with:
+**OptionalString()**, **OptionalBool()** and **OptionalInt64()**
+
+Pulls:
+-   [#486 Update Structs](https://gitea.com/gitea/go-sdk/pulls/486)

gitea/admin_user.go

@@ -65,12 +65,12 @@ func (c *Client) AdminCreateUser(opt CreateUserOption) (*User, *Response, error)
 type EditUserOption struct {
 	SourceID                int64   `json:"source_id"`
 	LoginName               string  `json:"login_name"`
-	FullName                string `json:"full_name"`
+	Email                   *string `json:"email"`
-	Email                   string `json:"email"`
+	FullName                *string `json:"full_name"`
 	Password                string  `json:"password"`
 	MustChangePassword      *bool   `json:"must_change_password"`
-	Website                 string `json:"website"`
+	Website                 *string `json:"website"`
-	Location                string `json:"location"`
+	Location                *string `json:"location"`
 	Active                  *bool   `json:"active"`
 	Admin                   *bool   `json:"admin"`
 	AllowGitHook            *bool   `json:"allow_git_hook"`

gitea/issue.go

@@ -223,6 +223,7 @@ type EditIssueOption struct {
 	Milestone      *int64     `json:"milestone"`
 	State          *StateType `json:"state"`
 	Deadline       *time.Time `json:"due_date"`
+	RemoveDeadline *bool      `json:"unset_due_date"`
 }
 
 // Validate the EditIssueOption struct

gitea/issue_stopwatch.go

@@ -12,7 +12,12 @@ import (
 // StopWatch represents a running stopwatch of an issue / pr
 type StopWatch struct {
 	Created       time.Time `json:"created"`
+	Seconds       int64     `json:"seconds"`
+	Duration      string    `json:"duration"`
 	IssueIndex    int64     `json:"issue_index"`
+	IssueTitle    string    `json:"issue_title"`
+	RepoOwnerName string    `json:"repo_owner_name"`
+	RepoName      string    `json:"repo_name"`
 }
 
 // GetMyStopwatches list all stopwatches

gitea/pull_review.go

@@ -35,6 +35,7 @@ const (
 type PullReview struct {
 	ID           int64           `json:"id"`
 	Reviewer     *User           `json:"user"`
+	ReviewerTeam *Team           `json:"team"`
 	State        ReviewStateType `json:"state"`
 	Body         string          `json:"body"`
 	CommitID     string          `json:"commit_id"`
@@ -42,6 +43,7 @@ type PullReview struct {
 	Stale bool `json:"stale"`
 	// Official indicates if the review counts towards the required approval limit, if PR base is a protected branch
 	Official          bool      `json:"official"`
+	Dismissed         bool      `json:"dismissed"`
 	CodeCommentsCount int       `json:"comments_count"`
 	Submitted         time.Time `json:"submitted_at"`
 

gitea/repo.go

@@ -22,6 +22,32 @@ type Permission struct {
 	Pull  bool `json:"pull"`
 }
 
+// InternalTracker represents settings for internal tracker
+type InternalTracker struct {
+	// Enable time tracking (Built-in issue tracker)
+	EnableTimeTracker bool `json:"enable_time_tracker"`
+	// Let only contributors track time (Built-in issue tracker)
+	AllowOnlyContributorsToTrackTime bool `json:"allow_only_contributors_to_track_time"`
+	// Enable dependencies for issues and pull requests (Built-in issue tracker)
+	EnableIssueDependencies bool `json:"enable_issue_dependencies"`
+}
+
+// ExternalTracker represents settings for external tracker
+type ExternalTracker struct {
+	// URL of external issue tracker.
+	ExternalTrackerURL string `json:"external_tracker_url"`
+	// External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.
+	ExternalTrackerFormat string `json:"external_tracker_format"`
+	// External Issue Tracker Number Format, either `numeric` or `alphanumeric`
+	ExternalTrackerStyle string `json:"external_tracker_style"`
+}
+
+// ExternalWiki represents setting for external wiki
+type ExternalWiki struct {
+	// URL of external wiki.
+	ExternalWikiURL string `json:"external_wiki_url"`
+}
+
 // Repository represents a repository
 type Repository struct {
 	ID                        int64            `json:"id"`
@@ -32,6 +58,7 @@ type Repository struct {
 	Empty                     bool             `json:"empty"`
 	Private                   bool             `json:"private"`
 	Fork                      bool             `json:"fork"`
+	Template                  bool             `json:"template"`
 	Parent                    *Repository      `json:"parent"`
 	Mirror                    bool             `json:"mirror"`
 	Size                      int              `json:"size"`
@@ -44,20 +71,28 @@ type Repository struct {
 	Forks                     int              `json:"forks_count"`
 	Watchers                  int              `json:"watchers_count"`
 	OpenIssues                int              `json:"open_issues_count"`
+	OpenPulls                 int              `json:"open_pr_counter"`
+	Releases                  int              `json:"release_counter"`
 	DefaultBranch             string           `json:"default_branch"`
 	Archived                  bool             `json:"archived"`
 	Created                   time.Time        `json:"created_at"`
 	Updated                   time.Time        `json:"updated_at"`
 	Permissions               *Permission      `json:"permissions,omitempty"`
 	HasIssues                 bool             `json:"has_issues"`
+	InternalTracker           *InternalTracker `json:"internal_tracker,omitempty"`
+	ExternalTracker           *ExternalTracker `json:"external_tracker,omitempty"`
 	HasWiki                   bool             `json:"has_wiki"`
+	ExternalWiki              *ExternalWiki    `json:"external_wiki,omitempty"`
 	HasPullRequests           bool             `json:"has_pull_requests"`
+	HasProjects               bool             `json:"has_projects"`
 	IgnoreWhitespaceConflicts bool             `json:"ignore_whitespace_conflicts"`
 	AllowMerge                bool             `json:"allow_merge_commits"`
 	AllowRebase               bool             `json:"allow_rebase"`
 	AllowRebaseMerge          bool             `json:"allow_rebase_explicit"`
 	AllowSquash               bool             `json:"allow_squash_merge"`
 	AvatarURL                 string           `json:"avatar_url"`
+	Internal                  bool             `json:"internal"`
+	MirrorInterval            string           `json:"mirror_interval"`
 }
 
 // RepoType represent repo type
@@ -347,14 +382,24 @@ type EditRepoOption struct {
 	// Note: you will get a 422 error if the organization restricts changing repository visibility to organization
 	// owners and a non-owner tries to change the value of private.
 	Private *bool `json:"private,omitempty"`
+	// either `true` to make this repository a template or `false` to make it a normal repository
+	Template *bool `json:"template,omitempty"`
 	// either `true` to enable issues for this repository or `false` to disable them.
 	HasIssues *bool `json:"has_issues,omitempty"`
+	// set this structure to configure internal issue tracker (requires has_issues)
+	InternalTracker *InternalTracker `json:"internal_tracker,omitempty"`
+	// set this structure to use external issue tracker (requires has_issues)
+	ExternalTracker *ExternalTracker `json:"external_tracker,omitempty"`
 	// either `true` to enable the wiki for this repository or `false` to disable it.
 	HasWiki *bool `json:"has_wiki,omitempty"`
+	// set this structure to use external wiki instead of internal (requires has_wiki)
+	ExternalWiki *ExternalWiki `json:"external_wiki,omitempty"`
 	// sets the default branch for this repository.
 	DefaultBranch *string `json:"default_branch,omitempty"`
 	// either `true` to allow pull requests, or `false` to prevent pull request.
 	HasPullRequests *bool `json:"has_pull_requests,omitempty"`
+	// either `true` to enable project unit, or `false` to disable them.
+	HasProjects *bool `json:"has_projects,omitempty"`
 	// either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.
 	IgnoreWhitespaceConflicts *bool `json:"ignore_whitespace_conflicts,omitempty"`
 	// either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.
@@ -367,6 +412,8 @@ type EditRepoOption struct {
 	AllowSquash *bool `json:"allow_squash_merge,omitempty"`
 	// set to `true` to archive this repository.
 	Archived *bool `json:"archived,omitempty"`
+	// set to a string like `8h30m0s` to set the mirror interval time
+	MirrorInterval *string `json:"mirror_interval,omitempty"`
 }
 
 // EditRepo edit the properties of a repository

gitea/repo_branch_protection.go

@@ -30,6 +30,7 @@ type BranchProtection struct {
 	ApprovalsWhitelistUsernames   []string  `json:"approvals_whitelist_username"`
 	ApprovalsWhitelistTeams       []string  `json:"approvals_whitelist_teams"`
 	BlockOnRejectedReviews        bool      `json:"block_on_rejected_reviews"`
+	BlockOnOfficialReviewRequests bool      `json:"block_on_official_review_requests"`
 	BlockOnOutdatedBranch         bool      `json:"block_on_outdated_branch"`
 	DismissStaleApprovals         bool      `json:"dismiss_stale_approvals"`
 	RequireSignedCommits          bool      `json:"require_signed_commits"`
@@ -56,6 +57,7 @@ type CreateBranchProtectionOption struct {
 	ApprovalsWhitelistUsernames   []string `json:"approvals_whitelist_username"`
 	ApprovalsWhitelistTeams       []string `json:"approvals_whitelist_teams"`
 	BlockOnRejectedReviews        bool     `json:"block_on_rejected_reviews"`
+	BlockOnOfficialReviewRequests bool     `json:"block_on_official_review_requests"`
 	BlockOnOutdatedBranch         bool     `json:"block_on_outdated_branch"`
 	DismissStaleApprovals         bool     `json:"dismiss_stale_approvals"`
 	RequireSignedCommits          bool     `json:"require_signed_commits"`
@@ -79,6 +81,7 @@ type EditBranchProtectionOption struct {
 	ApprovalsWhitelistUsernames   []string `json:"approvals_whitelist_username"`
 	ApprovalsWhitelistTeams       []string `json:"approvals_whitelist_teams"`
 	BlockOnRejectedReviews        *bool    `json:"block_on_rejected_reviews"`
+	BlockOnOfficialReviewRequests *bool    `json:"block_on_official_review_requests"`
 	BlockOnOutdatedBranch         *bool    `json:"block_on_outdated_branch"`
 	DismissStaleApprovals         *bool    `json:"dismiss_stale_approvals"`
 	RequireSignedCommits          *bool    `json:"require_signed_commits"`

gitea/repo_commit.go

@@ -47,6 +47,7 @@ type Commit struct {
 	Author     *User                  `json:"author"`
 	Committer  *User                  `json:"committer"`
 	Parents    []*CommitMeta          `json:"parents"`
+	Files      []*CommitAffectedFiles `json:"files"`
 }
 
 // CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE
@@ -55,6 +56,11 @@ type CommitDateOptions struct {
 	Committer time.Time `json:"committer"`
 }
 
+// CommitAffectedFiles store information about files affected by the commit
+type CommitAffectedFiles struct {
+	Filename string `json:"filename"`
+}
+
 // GetSingleCommit returns a single commit
 func (c *Client) GetSingleCommit(user, repo, commitID string) (*Commit, *Response, error) {
 	commit := new(Commit)

gitea/repo_file.go

@@ -23,6 +23,8 @@ type FileOptions struct {
 	Author    Identity          `json:"author"`
 	Committer Identity          `json:"committer"`
 	Dates     CommitDateOptions `json:"dates"`
+	// Add a Signed-off-by trailer by the committer at the end of the commit log message.
+	Signoff bool `json:"signoff"`
 }
 
 // CreateFileOptions options for creating files

gitea/repo_migrate.go

@@ -22,10 +22,8 @@ const (
 	GitServiceGitlab GitServiceType = "gitlab"
 	// GitServiceGitea represents a gitea service
 	GitServiceGitea GitServiceType = "gitea"
-
+	// GitServiceGogs represents a gogs service
-	// Not supported jet
+	GitServiceGogs GitServiceType = "gogs"
-	// // GitServiceGogs represents a gogs service
-	// GitServiceGogs GitServiceType = "gogs"
 )
 
 // MigrateRepoOption options for migrating a repository from an external service
@@ -48,6 +46,7 @@ type MigrateRepoOption struct {
 	Issues         bool           `json:"issues"`
 	PullRequests   bool           `json:"pull_requests"`
 	Releases       bool           `json:"releases"`
+	MirrorInterval string         `json:"mirror_interval"`
 }
 
 // Validate the MigrateRepoOption struct
@@ -67,17 +66,24 @@ func (opt *MigrateRepoOption) Validate(c *Client) error {
 	switch opt.Service {
 	case GitServiceGithub:
 		if len(opt.AuthToken) == 0 {
-			return fmt.Errorf("github require token authentication")
+			return fmt.Errorf("github requires token authentication")
 		}
 	case GitServiceGitlab, GitServiceGitea:
 		if len(opt.AuthToken) == 0 {
-			return fmt.Errorf("%s require token authentication", opt.Service)
+			return fmt.Errorf("%s requires token authentication", opt.Service)
 		}
 		// Gitlab is supported since 1.12.0 but api cant handle it until 1.13.0
 		// https://github.com/go-gitea/gitea/pull/12672
 		if c.checkServerVersionGreaterThanOrEqual(version1_13_0) != nil {
 			return fmt.Errorf("migrate from service %s need gitea >= 1.13.0", opt.Service)
 		}
+	case GitServiceGogs:
+		if len(opt.AuthToken) == 0 {
+			return fmt.Errorf("gogs requires token authentication")
+		}
+		if c.checkServerVersionGreaterThanOrEqual(version1_14_0) != nil {
+			return fmt.Errorf("migrate from service gogs need gitea >= 1.14.0")
+		}
 	}
 	return nil
 }

gitea/settings.go

@@ -6,6 +6,7 @@ package gitea
 
 // GlobalUISettings represent the global ui settings of a gitea instance witch is exposed by API
 type GlobalUISettings struct {
+	DefaultTheme     string   `json:"default_theme"`
 	AllowedReactions []string `json:"allowed_reactions"`
 }
 
@@ -13,6 +14,7 @@ type GlobalUISettings struct {
 type GlobalRepoSettings struct {
 	MirrorsDisabled    bool `json:"mirrors_disabled"`
 	HTTPGitDisabled    bool `json:"http_git_disabled"`
+	MigrationsDisabled bool `json:"migrations_disabled"`
 }
 
 // GlobalAPISettings contains global api settings exposed by it