gitea: code.gitea.io/gitea/modules/structs Index | Files

package structs

import "code.gitea.io/gitea/modules/structs"

Index

Package Files

admin_user.go attachment.go doc.go fork.go git_blob.go git_hook.go hook.go issue.go issue_comment.go issue_label.go issue_milestone.go issue_tracked_time.go lfs_lock.go miscellaneous.go org.go org_member.go org_team.go org_type.go pull.go release.go repo.go repo_branch.go repo_collaborator.go repo_commit.go repo_file.go repo_key.go repo_refs.go repo_tag.go repo_topic.go repo_tree.go repo_watch.go status.go task.go user.go user_app.go user_email.go user_gpgkey.go user_key.go utils.go

Variables

var (
    // ErrInvalidReceiveHook FIXME
    ErrInvalidReceiveHook = errors.New("Invalid JSON payload received over webhook")
)
var (
    // SupportedFullGitService represents all git services supported to migrate issues/labels/prs and etc.
    // TODO: add to this list after new git service added
    SupportedFullGitService = []GitServiceType{
        GithubService,
    }
)
var VisibilityModes = map[string]VisibleType{
    "public":  VisibleTypePublic,
    "limited": VisibleTypeLimited,
    "private": VisibleTypePrivate,
}

VisibilityModes is a map of org Visibility types

func BasicAuthEncode Uses

func BasicAuthEncode(user, pass string) string

BasicAuthEncode generate base64 of basic auth head

func Bool Uses

func Bool(v bool) *bool

Bool return address of bool value

func ExtractKeysFromMapString Uses

func ExtractKeysFromMapString(in map[string]VisibleType) (keys []string)

ExtractKeysFromMapString provides a slice of keys from map

func Int64 Uses

func Int64(v int64) *int64

Int64 return address of int64 value

func String Uses

func String(v string) *string

String return address of string value

type APIError Uses

type APIError struct {
    Message string `json:"message"`
    URL     string `json:"url"`
}

APIError is an api error with a message

type AccessToken Uses

type AccessToken struct {
    ID             int64  `json:"id"`
    Name           string `json:"name"`
    Token          string `json:"sha1"`
    TokenLastEight string `json:"token_last_eight"`
}

AccessToken represents an API access token. swagger:response AccessToken

type AccessTokenList Uses

type AccessTokenList []*AccessToken

AccessTokenList represents a list of API access token. swagger:response AccessTokenList

type AddCollaboratorOption Uses

type AddCollaboratorOption struct {
    Permission *string `json:"permission"`
}

AddCollaboratorOption options when adding a user as a collaborator of a repository

type AddOrgMembershipOption Uses

type AddOrgMembershipOption struct {
    Role string `json:"role" binding:"Required"`
}

AddOrgMembershipOption add user to organization options

type AddTimeOption Uses

type AddTimeOption struct {
    // time in seconds
    // required: true
    Time int64 `json:"time" binding:"Required"`
}

AddTimeOption options for adding time to an issue

type AnnotatedTag Uses

type AnnotatedTag struct {
    Tag          string                     `json:"tag"`
    SHA          string                     `json:"sha"`
    URL          string                     `json:"url"`
    Message      string                     `json:"message"`
    Tagger       *CommitUser                `json:"tagger"`
    Object       *AnnotatedTagObject        `json:"object"`
    Verification *PayloadCommitVerification `json:"verification"`
}

AnnotatedTag represents an annotated tag

type AnnotatedTagObject Uses

type AnnotatedTagObject struct {
    Type string `json:"type"`
    URL  string `json:"url"`
    SHA  string `json:"sha"`
}

AnnotatedTagObject contains meta information of the tag object

type Attachment Uses

type Attachment struct {
    ID            int64  `json:"id"`
    Name          string `json:"name"`
    Size          int64  `json:"size"`
    DownloadCount int64  `json:"download_count"`
    // swagger:strfmt date-time
    Created     time.Time `json:"created_at"`
    UUID        string    `json:"uuid"`
    DownloadURL string    `json:"browser_download_url"`
}

Attachment a generic attachment swagger:model

type Branch Uses

type Branch struct {
    Name                string         `json:"name"`
    Commit              *PayloadCommit `json:"commit"`
    Protected           bool           `json:"protected"`
    RequiredApprovals   int64          `json:"required_approvals"`
    EnableStatusCheck   bool           `json:"enable_status_check"`
    StatusCheckContexts []string       `json:"status_check_contexts"`
    UserCanPush         bool           `json:"user_can_push"`
    UserCanMerge        bool           `json:"user_can_merge"`
}

Branch represents a repository branch

type ChangesFromPayload Uses

type ChangesFromPayload struct {
    From string `json:"from"`
}

ChangesFromPayload FIXME

type ChangesPayload Uses

type ChangesPayload struct {
    Title *ChangesFromPayload `json:"title,omitempty"`
    Body  *ChangesFromPayload `json:"body,omitempty"`
}

ChangesPayload FIXME

type CombinedStatus Uses

type CombinedStatus struct {
    State      StatusState `json:"state"`
    SHA        string      `json:"sha"`
    TotalCount int         `json:"total_count"`
    Statuses   []*Status   `json:"statuses"`
    Repository *Repository `json:"repository"`
    CommitURL  string      `json:"commit_url"`
    URL        string      `json:"url"`
}

CombinedStatus holds the combined state of several statuses for a single commit

type Comment Uses

type Comment struct {
    ID               int64  `json:"id"`
    HTMLURL          string `json:"html_url"`
    PRURL            string `json:"pull_request_url"`
    IssueURL         string `json:"issue_url"`
    Poster           *User  `json:"user"`
    OriginalAuthor   string `json:"original_author"`
    OriginalAuthorID int64  `json:"original_author_id"`
    Body             string `json:"body"`
    // swagger:strfmt date-time
    Created time.Time `json:"created_at"`
    // swagger:strfmt date-time
    Updated time.Time `json:"updated_at"`
}

Comment represents a comment on a commit or issue

type Commit Uses

type Commit struct {
    *CommitMeta
    HTMLURL    string        `json:"html_url"`
    RepoCommit *RepoCommit   `json:"commit"`
    Author     *User         `json:"author"`
    Committer  *User         `json:"committer"`
    Parents    []*CommitMeta `json:"parents"`
}

Commit contains information generated from a Git commit.

type CommitMeta Uses

type CommitMeta struct {
    URL string `json:"url"`
    SHA string `json:"sha"`
}

CommitMeta contains meta information of a commit in terms of API.

type CommitUser Uses

type CommitUser struct {
    Identity
    Date string `json:"date"`
}

CommitUser contains information of a user in the context of a commit.

type ContentsResponse Uses

type ContentsResponse struct {
    Name string `json:"name"`
    Path string `json:"path"`
    SHA  string `json:"sha"`
    // `type` will be `file`, `dir`, `symlink`, or `submodule`
    Type string `json:"type"`
    Size int64  `json:"size"`
    // `encoding` is populated when `type` is `file`, otherwise null
    Encoding *string `json:"encoding"`
    // `content` is populated when `type` is `file`, otherwise null
    Content *string `json:"content"`
    // `target` is populated when `type` is `symlink`, otherwise null
    Target      *string `json:"target"`
    URL         *string `json:"url"`
    HTMLURL     *string `json:"html_url"`
    GitURL      *string `json:"git_url"`
    DownloadURL *string `json:"download_url"`
    // `submodule_git_url` is populated when `type` is `submodule`, otherwise null
    SubmoduleGitURL *string            `json:"submodule_git_url"`
    Links           *FileLinksResponse `json:"_links"`
}

ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content

type CreateAccessTokenOption Uses

type CreateAccessTokenOption struct {
    Name string `json:"name" binding:"Required"`
}

CreateAccessTokenOption options when create access token swagger:parameters userCreateToken

type CreateEmailOption Uses

type CreateEmailOption struct {
    // email addresses to add
    Emails []string `json:"emails"`
}

CreateEmailOption options when creating email addresses

type CreateFileOptions Uses

type CreateFileOptions struct {
    FileOptions
    // content must be base64 encoded
    // required: true
    Content string `json:"content"`
}

CreateFileOptions options for creating files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

type CreateForkOption Uses

type CreateForkOption struct {
    // organization name, if forking into an organization
    Organization *string `json:"organization"`
}

CreateForkOption options for creating a fork

type CreateGPGKeyOption Uses

type CreateGPGKeyOption struct {
    // An armored GPG key to add
    //
    // required: true
    // unique: true
    ArmoredKey string `json:"armored_public_key" binding:"Required"`
}

CreateGPGKeyOption options create user GPG key

type CreateHookOption Uses

type CreateHookOption struct {
    // required: true
    // enum: gitea,gogs,slack,discord
    Type string `json:"type" binding:"Required"`
    // required: true
    Config       map[string]string `json:"config" binding:"Required"`
    Events       []string          `json:"events"`
    BranchFilter string            `json:"branch_filter" binding:"GlobPattern"`
    // default: false
    Active bool `json:"active"`
}

CreateHookOption options when create a hook

type CreateIssueCommentOption Uses

type CreateIssueCommentOption struct {
    // required:true
    Body string `json:"body" binding:"Required"`
}

CreateIssueCommentOption options for creating a comment on an issue

type CreateIssueOption Uses

type CreateIssueOption struct {
    // required:true
    Title string `json:"title" binding:"Required"`
    Body  string `json:"body"`
    // username of assignee
    Assignee  string   `json:"assignee"`
    Assignees []string `json:"assignees"`
    // swagger:strfmt date-time
    Deadline *time.Time `json:"due_date"`
    // milestone id
    Milestone int64 `json:"milestone"`
    // list of label ids
    Labels []int64 `json:"labels"`
    Closed bool    `json:"closed"`
}

CreateIssueOption options to create one issue

type CreateKeyOption Uses

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"`
    // Describe if the key has only read access or read/write
    //
    // required: false
    ReadOnly bool `json:"read_only"`
}

CreateKeyOption options when creating a key

type CreateLabelOption Uses

type CreateLabelOption struct {
    // required:true
    Name string `json:"name" binding:"Required"`
    // required:true
    // example: #00aabb
    Color       string `json:"color" binding:"Required;Size(7)"`
    Description string `json:"description"`
}

CreateLabelOption options for creating a label

type CreateMilestoneOption Uses

type CreateMilestoneOption struct {
    Title       string `json:"title"`
    Description string `json:"description"`
    // swagger:strfmt date-time
    Deadline *time.Time `json:"due_on"`
}

CreateMilestoneOption options for creating a milestone

type CreateOrgOption Uses

type CreateOrgOption struct {
    // required: true
    UserName    string `json:"username" binding:"Required"`
    FullName    string `json:"full_name"`
    Description string `json:"description"`
    Website     string `json:"website"`
    Location    string `json:"location"`
    // possible values are `public` (default), `limited` or `private`
    // enum: public,limited,private
    Visibility                string `json:"visibility" binding:"In(,public,limited,private)"`
    RepoAdminChangeTeamAccess bool   `json:"repo_admin_change_team_access"`
}

CreateOrgOption options for creating an organization

type CreatePayload Uses

type CreatePayload struct {
    Secret  string      `json:"secret"`
    Sha     string      `json:"sha"`
    Ref     string      `json:"ref"`
    RefType string      `json:"ref_type"`
    Repo    *Repository `json:"repository"`
    Sender  *User       `json:"sender"`
}

CreatePayload FIXME

func ParseCreateHook Uses

func ParseCreateHook(raw []byte) (*CreatePayload, error)

ParseCreateHook parses create event hook content.

func (*CreatePayload) JSONPayload Uses

func (p *CreatePayload) JSONPayload() ([]byte, error)

JSONPayload return payload information

func (*CreatePayload) SetSecret Uses

func (p *CreatePayload) SetSecret(secret string)

SetSecret modifies the secret of the CreatePayload

type CreatePullRequestOption Uses

type CreatePullRequestOption struct {
    Head      string   `json:"head" binding:"Required"`
    Base      string   `json:"base" binding:"Required"`
    Title     string   `json:"title" binding:"Required"`
    Body      string   `json:"body"`
    Assignee  string   `json:"assignee"`
    Assignees []string `json:"assignees"`
    Milestone int64    `json:"milestone"`
    Labels    []int64  `json:"labels"`
    // swagger:strfmt date-time
    Deadline *time.Time `json:"due_date"`
}

CreatePullRequestOption options when creating a pull request

type CreateReleaseOption Uses

type CreateReleaseOption struct {
    // required: true
    TagName      string `json:"tag_name" binding:"Required"`
    Target       string `json:"target_commitish"`
    Title        string `json:"name"`
    Note         string `json:"body"`
    IsDraft      bool   `json:"draft"`
    IsPrerelease bool   `json:"prerelease"`
}

CreateReleaseOption options when creating a release

type CreateRepoOption Uses

type CreateRepoOption struct {
    // Name of the repository to create
    //
    // required: true
    // unique: true
    Name string `json:"name" binding:"Required;AlphaDashDot;MaxSize(100)"`
    // Description of the repository to create
    Description string `json:"description" binding:"MaxSize(255)"`
    // Whether the repository is private
    Private bool `json:"private"`
    // Issue Label set to use
    IssueLabels string `json:"issue_labels"`
    // Whether the repository should be auto-intialized?
    AutoInit bool `json:"auto_init"`
    // Gitignores to use
    Gitignores string `json:"gitignores"`
    // License to use
    License string `json:"license"`
    // Readme of the repository to create
    Readme string `json:"readme"`
}

CreateRepoOption options when creating repository swagger:model

type CreateStatusOption Uses

type CreateStatusOption struct {
    State       StatusState `json:"state"`
    TargetURL   string      `json:"target_url"`
    Description string      `json:"description"`
    Context     string      `json:"context"`
}

CreateStatusOption holds the information needed to create a new Status for a Commit

type CreateTeamOption Uses

type CreateTeamOption struct {
    // required: true
    Name                    string `json:"name" binding:"Required;AlphaDashDot;MaxSize(30)"`
    Description             string `json:"description" binding:"MaxSize(255)"`
    IncludesAllRepositories bool   `json:"includes_all_repositories"`
    // enum: read,write,admin
    Permission string `json:"permission"`
    // example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"]
    Units []string `json:"units"`
}

CreateTeamOption options for creating a team

type CreateUserOption Uses

type CreateUserOption struct {
    SourceID  int64  `json:"source_id"`
    LoginName string `json:"login_name"`
    // required: true
    Username string `json:"username" binding:"Required;AlphaDashDot;MaxSize(40)"`
    FullName string `json:"full_name" binding:"MaxSize(100)"`
    // required: true
    // swagger:strfmt email
    Email string `json:"email" binding:"Required;Email;MaxSize(254)"`
    // required: true
    Password           string `json:"password" binding:"Required;MaxSize(255)"`
    MustChangePassword *bool  `json:"must_change_password"`
    SendNotify         bool   `json:"send_notify"`
}

CreateUserOption create user options

type DeleteEmailOption Uses

type DeleteEmailOption struct {
    // email addresses to delete
    Emails []string `json:"emails"`
}

DeleteEmailOption options when deleting email addresses

type DeleteFileOptions Uses

type DeleteFileOptions struct {
    FileOptions
    // sha is the SHA for the file that already exists
    // required: true
    SHA string `json:"sha" binding:"Required"`
}

DeleteFileOptions options for deleting files (used for other File structs below) Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

type DeletePayload Uses

type DeletePayload struct {
    Secret     string      `json:"secret"`
    Ref        string      `json:"ref"`
    RefType    string      `json:"ref_type"`
    PusherType PusherType  `json:"pusher_type"`
    Repo       *Repository `json:"repository"`
    Sender     *User       `json:"sender"`
}

DeletePayload represents delete payload

func (*DeletePayload) JSONPayload Uses

func (p *DeletePayload) JSONPayload() ([]byte, error)

JSONPayload implements Payload

func (*DeletePayload) SetSecret Uses

func (p *DeletePayload) SetSecret(secret string)

SetSecret modifies the secret of the DeletePayload

type DeployKey Uses

type DeployKey struct {
    ID          int64  `json:"id"`
    KeyID       int64  `json:"key_id"`
    Key         string `json:"key"`
    URL         string `json:"url"`
    Title       string `json:"title"`
    Fingerprint string `json:"fingerprint"`
    // swagger:strfmt date-time
    Created    time.Time   `json:"created_at"`
    ReadOnly   bool        `json:"read_only"`
    Repository *Repository `json:"repository,omitempty"`
}

DeployKey a deploy key

type EditAttachmentOptions Uses

type EditAttachmentOptions struct {
    Name string `json:"name"`
}

EditAttachmentOptions options for editing attachments swagger:model

type EditDeadlineOption Uses

type EditDeadlineOption struct {
    // required:true
    // swagger:strfmt date-time
    Deadline *time.Time `json:"due_date"`
}

EditDeadlineOption options for creating a deadline

type EditGitHookOption Uses

type EditGitHookOption struct {
    Content string `json:"content"`
}

EditGitHookOption options when modifying one Git hook

type EditHookOption Uses

type EditHookOption struct {
    Config       map[string]string `json:"config"`
    Events       []string          `json:"events"`
    BranchFilter string            `json:"branch_filter" binding:"GlobPattern"`
    Active       *bool             `json:"active"`
}

EditHookOption options when modify one hook

type EditIssueCommentOption Uses

type EditIssueCommentOption struct {
    // required: true
    Body string `json:"body" binding:"Required"`
}

EditIssueCommentOption options for editing a comment

type EditIssueOption Uses

type EditIssueOption struct {
    Title     string   `json:"title"`
    Body      *string  `json:"body"`
    Assignee  *string  `json:"assignee"`
    Assignees []string `json:"assignees"`
    Milestone *int64   `json:"milestone"`
    State     *string  `json:"state"`
    // swagger:strfmt date-time
    Deadline       *time.Time `json:"due_date"`
    RemoveDeadline *bool      `json:"unset_due_date"`
}

EditIssueOption options for editing an issue

type EditLabelOption Uses

type EditLabelOption struct {
    Name        *string `json:"name"`
    Color       *string `json:"color"`
    Description *string `json:"description"`
}

EditLabelOption options for editing a label

type EditMilestoneOption Uses

type EditMilestoneOption struct {
    Title       string     `json:"title"`
    Description *string    `json:"description"`
    State       *string    `json:"state"`
    Deadline    *time.Time `json:"due_on"`
}

EditMilestoneOption options for editing a milestone

type EditOrgOption Uses

type EditOrgOption struct {
    FullName    string `json:"full_name"`
    Description string `json:"description"`
    Website     string `json:"website"`
    Location    string `json:"location"`
    // possible values are `public`, `limited` or `private`
    // enum: public,limited,private
    Visibility                string `json:"visibility" binding:"In(,public,limited,private)"`
    RepoAdminChangeTeamAccess bool   `json:"repo_admin_change_team_access"`
}

EditOrgOption options for editing an organization

type EditPriorityOption Uses

type EditPriorityOption struct {
    // required:true
    Priority int `json:"priority"`
}

EditPriorityOption options for updating priority

type EditPullRequestOption Uses

type EditPullRequestOption struct {
    Title     string   `json:"title"`
    Body      string   `json:"body"`
    Assignee  string   `json:"assignee"`
    Assignees []string `json:"assignees"`
    Milestone int64    `json:"milestone"`
    Labels    []int64  `json:"labels"`
    State     *string  `json:"state"`
    // swagger:strfmt date-time
    Deadline       *time.Time `json:"due_date"`
    RemoveDeadline *bool      `json:"unset_due_date"`
}

EditPullRequestOption options when modify pull request

type EditReleaseOption Uses

type EditReleaseOption struct {
    TagName      string `json:"tag_name"`
    Target       string `json:"target_commitish"`
    Title        string `json:"name"`
    Note         string `json:"body"`
    IsDraft      *bool  `json:"draft"`
    IsPrerelease *bool  `json:"prerelease"`
}

EditReleaseOption options when editing a release

type EditRepoOption Uses

type EditRepoOption struct {
    // name of the repository
    // unique: true
    Name *string `json:"name,omitempty" binding:"OmitEmpty;AlphaDashDot;MaxSize(100);"`
    // a short description of the repository.
    Description *string `json:"description,omitempty" binding:"MaxSize(255)"`
    // a URL with more information about the repository.
    Website *string `json:"website,omitempty" binding:"MaxSize(255)"`
    // either `true` to make the repository private or `false` to make it public.
    // 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 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`.
    AllowMerge *bool `json:"allow_merge_commits,omitempty"`
    // either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.
    AllowRebase *bool `json:"allow_rebase,omitempty"`
    // either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.
    AllowRebaseMerge *bool `json:"allow_rebase_explicit,omitempty"`
    // either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.
    AllowSquash *bool `json:"allow_squash_merge,omitempty"`
    // set to `true` to archive this repository.
    Archived *bool `json:"archived,omitempty"`
}

EditRepoOption options when editing a repository's properties swagger:model

type EditTeamOption Uses

type EditTeamOption struct {
    // required: true
    Name                    string `json:"name" binding:"Required;AlphaDashDot;MaxSize(30)"`
    Description             string `json:"description" binding:"MaxSize(255)"`
    IncludesAllRepositories bool   `json:"includes_all_repositories"`
    // enum: read,write,admin
    Permission string `json:"permission"`
    // example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"]
    Units []string `json:"units"`
}

EditTeamOption options for editing a team

type EditUserOption Uses

type EditUserOption struct {
    SourceID  int64  `json:"source_id"`
    LoginName string `json:"login_name"`
    FullName  string `json:"full_name" binding:"MaxSize(100)"`
    // required: true
    // swagger:strfmt email
    Email                   string `json:"email" binding:"Required;Email;MaxSize(254)"`
    Password                string `json:"password" binding:"MaxSize(255)"`
    MustChangePassword      *bool  `json:"must_change_password"`
    Website                 string `json:"website" binding:"MaxSize(50)"`
    Location                string `json:"location" binding:"MaxSize(50)"`
    Active                  *bool  `json:"active"`
    Admin                   *bool  `json:"admin"`
    AllowGitHook            *bool  `json:"allow_git_hook"`
    AllowImportLocal        *bool  `json:"allow_import_local"`
    MaxRepoCreation         *int   `json:"max_repo_creation"`
    ProhibitLogin           *bool  `json:"prohibit_login"`
    AllowCreateOrganization *bool  `json:"allow_create_organization"`
}

EditUserOption edit user options

type Email Uses

type Email struct {
    // swagger:strfmt email
    Email    string `json:"email"`
    Verified bool   `json:"verified"`
    Primary  bool   `json:"primary"`
}

Email an email address belonging to a user

type ExternalTracker Uses

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"`
}

ExternalTracker represents settings for external tracker swagger:model

type ExternalWiki Uses

type ExternalWiki struct {
    // URL of external wiki.
    ExternalWikiURL string `json:"external_wiki_url"`
}

ExternalWiki represents setting for external wiki swagger:model

type FileCommitResponse Uses

type FileCommitResponse struct {
    CommitMeta
    HTMLURL   string        `json:"html_url"`
    Author    *CommitUser   `json:"author"`
    Committer *CommitUser   `json:"committer"`
    Parents   []*CommitMeta `json:"parents"`
    Message   string        `json:"message"`
    Tree      *CommitMeta   `json:"tree"`
}

FileCommitResponse contains information generated from a Git commit for a repo's file.

type FileDeleteResponse Uses

type FileDeleteResponse struct {
    Content      interface{}                `json:"content"` // to be set to nil
    Commit       *FileCommitResponse        `json:"commit"`
    Verification *PayloadCommitVerification `json:"verification"`
}

FileDeleteResponse contains information about a repo's file that was deleted

type FileLinksResponse Uses

type FileLinksResponse struct {
    Self    *string `json:"self"`
    GitURL  *string `json:"git"`
    HTMLURL *string `json:"html"`
}

FileLinksResponse contains the links for a repo's file

type FileOptions Uses

type FileOptions struct {
    // message (optional) for the commit of this file. if not supplied, a default message will be used
    Message string `json:"message"`
    // branch (optional) to base this file from. if not given, the default branch is used
    BranchName string `json:"branch" binding:"GitRefName;MaxSize(100)"`
    // new_branch (optional) will make a new branch from `branch` before creating the file
    NewBranchName string `json:"new_branch" binding:"GitRefName;MaxSize(100)"`
    // `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)
    Author    Identity `json:"author"`
    Committer Identity `json:"committer"`
}

FileOptions options for all file APIs

type FileResponse Uses

type FileResponse struct {
    Content      *ContentsResponse          `json:"content"`
    Commit       *FileCommitResponse        `json:"commit"`
    Verification *PayloadCommitVerification `json:"verification"`
}

FileResponse contains information about a repo's file

type ForkPayload Uses

type ForkPayload struct {
    Secret string      `json:"secret"`
    Forkee *Repository `json:"forkee"`
    Repo   *Repository `json:"repository"`
    Sender *User       `json:"sender"`
}

ForkPayload represents fork payload

func (*ForkPayload) JSONPayload Uses

func (p *ForkPayload) JSONPayload() ([]byte, error)

JSONPayload implements Payload

func (*ForkPayload) SetSecret Uses

func (p *ForkPayload) SetSecret(secret string)

SetSecret modifies the secret of the ForkPayload

type GPGKey Uses

type GPGKey struct {
    ID                int64          `json:"id"`
    PrimaryKeyID      string         `json:"primary_key_id"`
    KeyID             string         `json:"key_id"`
    PublicKey         string         `json:"public_key"`
    Emails            []*GPGKeyEmail `json:"emails"`
    SubsKey           []*GPGKey      `json:"subkeys"`
    CanSign           bool           `json:"can_sign"`
    CanEncryptComms   bool           `json:"can_encrypt_comms"`
    CanEncryptStorage bool           `json:"can_encrypt_storage"`
    CanCertify        bool           `json:"can_certify"`
    // swagger:strfmt date-time
    Created time.Time `json:"created_at,omitempty"`
    // swagger:strfmt date-time
    Expires time.Time `json:"expires_at,omitempty"`
}

GPGKey a user GPG key to sign commit and tag in repository

type GPGKeyEmail Uses

type GPGKeyEmail struct {
    Email    string `json:"email"`
    Verified bool   `json:"verified"`
}

GPGKeyEmail an email attached to a GPGKey swagger:model GPGKeyEmail

type GitBlobResponse Uses

type GitBlobResponse struct {
    Content  string `json:"content"`
    Encoding string `json:"encoding"`
    URL      string `json:"url"`
    SHA      string `json:"sha"`
    Size     int64  `json:"size"`
}

GitBlobResponse represents a git blob

type GitEntry Uses

type GitEntry struct {
    Path string `json:"path"`
    Mode string `json:"mode"`
    Type string `json:"type"`
    Size int64  `json:"size"`
    SHA  string `json:"sha"`
    URL  string `json:"url"`
}

GitEntry represents a git tree

type GitHook Uses

type GitHook struct {
    Name     string `json:"name"`
    IsActive bool   `json:"is_active"`
    Content  string `json:"content,omitempty"`
}

GitHook represents a Git repository hook

type GitHookList Uses

type GitHookList []*GitHook

GitHookList represents a list of Git hooks

type GitObject Uses

type GitObject struct {
    Type string `json:"type"`
    SHA  string `json:"sha"`
    URL  string `json:"url"`
}

GitObject represents a Git object.

type GitServiceType Uses

type GitServiceType int

GitServiceType represents a git service

const (
    NotMigrated     GitServiceType = iota // 0 not migrated from external sites
    PlainGitService                       // 1 plain git service
    GithubService                         // 2 github.com
    GiteaService                          // 3 gitea service
    GitlabService                         // 4 gitlab service
    GogsService                           // 5 gogs service
)

enumerate all GitServiceType

func (GitServiceType) Name Uses

func (gt GitServiceType) Name() string

Name represents the service type's name WARNNING: the name have to be equal to that on goth's library

type GitTreeResponse Uses

type GitTreeResponse struct {
    SHA        string     `json:"sha"`
    URL        string     `json:"url"`
    Entries    []GitEntry `json:"tree"`
    Truncated  bool       `json:"truncated"`
    Page       int        `json:"page"`
    TotalCount int        `json:"total_count"`
}

GitTreeResponse returns a git tree

type Hook Uses

type Hook struct {
    ID     int64             `json:"id"`
    Type   string            `json:"type"`
    URL    string            `json:"-"`
    Config map[string]string `json:"config"`
    Events []string          `json:"events"`
    Active bool              `json:"active"`
    // swagger:strfmt date-time
    Updated time.Time `json:"updated_at"`
    // swagger:strfmt date-time
    Created time.Time `json:"created_at"`
}

Hook a hook is a web hook when one repository changed

type HookIssueAction Uses

type HookIssueAction string

HookIssueAction FIXME

const (
    // HookIssueOpened opened
    HookIssueOpened HookIssueAction = "opened"
    // HookIssueClosed closed
    HookIssueClosed HookIssueAction = "closed"
    // HookIssueReOpened reopened
    HookIssueReOpened HookIssueAction = "reopened"
    // HookIssueEdited edited
    HookIssueEdited HookIssueAction = "edited"
    // HookIssueAssigned assigned
    HookIssueAssigned HookIssueAction = "assigned"
    // HookIssueUnassigned unassigned
    HookIssueUnassigned HookIssueAction = "unassigned"
    // HookIssueLabelUpdated label_updated
    HookIssueLabelUpdated HookIssueAction = "label_updated"
    // HookIssueLabelCleared label_cleared
    HookIssueLabelCleared HookIssueAction = "label_cleared"
    // HookIssueSynchronized synchronized
    HookIssueSynchronized HookIssueAction = "synchronized"
    // HookIssueMilestoned is an issue action for when a milestone is set on an issue.
    HookIssueMilestoned HookIssueAction = "milestoned"
    // HookIssueDemilestoned is an issue action for when a milestone is cleared on an issue.
    HookIssueDemilestoned HookIssueAction = "demilestoned"
)

type HookIssueCommentAction Uses

type HookIssueCommentAction string

HookIssueCommentAction defines hook issue comment action

const (
    HookIssueCommentCreated HookIssueCommentAction = "created"
    HookIssueCommentEdited  HookIssueCommentAction = "edited"
    HookIssueCommentDeleted HookIssueCommentAction = "deleted"
)

all issue comment actions

type HookList Uses

type HookList []*Hook

HookList represents a list of API hook.

type HookReleaseAction Uses

type HookReleaseAction string

HookReleaseAction defines hook release action type

const (
    HookReleasePublished HookReleaseAction = "published"
    HookReleaseUpdated   HookReleaseAction = "updated"
    HookReleaseDeleted   HookReleaseAction = "deleted"
)

all release actions

type HookRepoAction Uses

type HookRepoAction string

HookRepoAction an action that happens to a repo

const (
    // HookRepoCreated created
    HookRepoCreated HookRepoAction = "created"
    // HookRepoDeleted deleted
    HookRepoDeleted HookRepoAction = "deleted"
)

type Identity Uses

type Identity struct {
    Name string `json:"name" binding:"MaxSize(100)"`
    // swagger:strfmt email
    Email string `json:"email" binding:"MaxSize(254)"`
}

Identity for a person's identity like an author or committer

type InternalTracker Uses

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"`
}

InternalTracker represents settings for internal tracker swagger:model

type Issue Uses

type Issue struct {
    ID               int64      `json:"id"`
    URL              string     `json:"url"`
    Index            int64      `json:"number"`
    Poster           *User      `json:"user"`
    OriginalAuthor   string     `json:"original_author"`
    OriginalAuthorID int64      `json:"original_author_id"`
    Title            string     `json:"title"`
    Body             string     `json:"body"`
    Labels           []*Label   `json:"labels"`
    Milestone        *Milestone `json:"milestone"`
    Assignee         *User      `json:"assignee"`
    Assignees        []*User    `json:"assignees"`
    // Whether the issue is open or closed
    //
    // type: string
    // enum: open,closed
    State    StateType `json:"state"`
    Comments int       `json:"comments"`
    // swagger:strfmt date-time
    Created time.Time `json:"created_at"`
    // swagger:strfmt date-time
    Updated time.Time `json:"updated_at"`
    // swagger:strfmt date-time
    Closed *time.Time `json:"closed_at"`
    // swagger:strfmt date-time
    Deadline *time.Time `json:"due_date"`

    PullRequest *PullRequestMeta `json:"pull_request"`
    Repo        *RepositoryMeta  `json:"repository"`
}

Issue represents an issue in a repository swagger:model

type IssueCommentPayload Uses

type IssueCommentPayload struct {
    Secret     string                 `json:"secret"`
    Action     HookIssueCommentAction `json:"action"`
    Issue      *Issue                 `json:"issue"`
    Comment    *Comment               `json:"comment"`
    Changes    *ChangesPayload        `json:"changes,omitempty"`
    Repository *Repository            `json:"repository"`
    Sender     *User                  `json:"sender"`
    IsPull     bool                   `json:"is_pull"`
}

IssueCommentPayload represents a payload information of issue comment event.

func (*IssueCommentPayload) JSONPayload Uses

func (p *IssueCommentPayload) JSONPayload() ([]byte, error)

JSONPayload implements Payload

func (*IssueCommentPayload) SetSecret Uses

func (p *IssueCommentPayload) SetSecret(secret string)

SetSecret modifies the secret of the IssueCommentPayload

type IssueDeadline Uses

type IssueDeadline struct {
    // swagger:strfmt date-time
    Deadline *time.Time `json:"due_date"`
}

IssueDeadline represents an issue deadline swagger:model

type IssueLabelsOption Uses

type IssueLabelsOption struct {
    // list of label IDs
    Labels []int64 `json:"labels"`
}

IssueLabelsOption a collection of labels

type IssuePayload Uses

type IssuePayload struct {
    Secret     string          `json:"secret"`
    Action     HookIssueAction `json:"action"`
    Index      int64           `json:"number"`
    Changes    *ChangesPayload `json:"changes,omitempty"`
    Issue      *Issue          `json:"issue"`
    Repository *Repository     `json:"repository"`
    Sender     *User           `json:"sender"`
}

IssuePayload represents the payload information that is sent along with an issue event.

func (*IssuePayload) JSONPayload Uses

func (p *IssuePayload) JSONPayload() ([]byte, error)

JSONPayload encodes the IssuePayload to JSON, with an indentation of two spaces.

func (*IssuePayload) SetSecret Uses

func (p *IssuePayload) SetSecret(secret string)

SetSecret modifies the secret of the IssuePayload.

type LFSLock Uses

type LFSLock struct {
    ID       string        `json:"id"`
    Path     string        `json:"path"`
    LockedAt time.Time     `json:"locked_at"`
    Owner    *LFSLockOwner `json:"owner"`
}

LFSLock represent a lock for use with the locks API.

type LFSLockDeleteRequest Uses

type LFSLockDeleteRequest struct {
    Force bool `json:"force"`
}

LFSLockDeleteRequest contains params of a delete request https://github.com/git-lfs/git-lfs/blob/master/docs/api/locking.md#delete-lock

type LFSLockError Uses

type LFSLockError struct {
    Message       string   `json:"message"`
    Lock          *LFSLock `json:"lock,omitempty"`
    Documentation string   `json:"documentation_url,omitempty"`
    RequestID     string   `json:"request_id,omitempty"`
}

LFSLockError contains information on the error that occurs

type LFSLockList Uses

type LFSLockList struct {
    Locks []*LFSLock `json:"locks"`
    Next  string     `json:"next_cursor,omitempty"`
}

LFSLockList represent a list of lock requested https://github.com/git-lfs/git-lfs/blob/master/docs/api/locking.md#list-locks

type LFSLockListVerify Uses

type LFSLockListVerify struct {
    Ours   []*LFSLock `json:"ours"`
    Theirs []*LFSLock `json:"theirs"`
    Next   string     `json:"next_cursor,omitempty"`
}

LFSLockListVerify represent a list of lock verification requested https://github.com/git-lfs/git-lfs/blob/master/docs/api/locking.md#list-locks-for-verification

type LFSLockOwner Uses

type LFSLockOwner struct {
    Name string `json:"name"`
}

LFSLockOwner represent a lock owner for use with the locks API.

type LFSLockRequest Uses

type LFSLockRequest struct {
    Path string `json:"path"`
}

LFSLockRequest contains the path of the lock to create https://github.com/git-lfs/git-lfs/blob/master/docs/api/locking.md#create-lock

type LFSLockResponse Uses

type LFSLockResponse struct {
    Lock *LFSLock `json:"lock"`
}

LFSLockResponse represent a lock created https://github.com/git-lfs/git-lfs/blob/master/docs/api/locking.md#create-lock

type Label Uses

type Label struct {
    ID   int64  `json:"id"`
    Name string `json:"name"`
    // example: 00aabb
    Color       string `json:"color"`
    Description string `json:"description"`
    URL         string `json:"url"`
}

Label a label to an issue or a pr swagger:model

type ListIssueOption Uses

type ListIssueOption struct {
    Page  int
    State string
}

ListIssueOption list issue options

type ListPullRequestsOptions Uses

type ListPullRequestsOptions struct {
    Page  int    `json:"page"`
    State string `json:"state"`
}

ListPullRequestsOptions options for listing pull requests

type ListStatusesOption Uses

type ListStatusesOption struct {
    Page int
}

ListStatusesOption holds pagination information

type MarkdownOption Uses

type MarkdownOption struct {
    // Text markdown to render
    //
    // in: body
    Text string
    // Mode to render
    //
    // in: body
    Mode string
    // Context to render
    //
    // in: body
    Context string
    // Is it a wiki page ?
    //
    // in: body
    Wiki bool
}

MarkdownOption markdown options

type MarkdownRender Uses

type MarkdownRender string

MarkdownRender is a rendered markdown document swagger:response MarkdownRender

type MigrateRepoOption Uses

type MigrateRepoOption struct {
    // required: true
    CloneAddr    string `json:"clone_addr" binding:"Required"`
    AuthUsername string `json:"auth_username"`
    AuthPassword string `json:"auth_password"`
    // required: true
    UID int `json:"uid" binding:"Required"`
    // required: true
    RepoName        string `json:"repo_name" binding:"Required"`
    Mirror          bool   `json:"mirror"`
    Private         bool   `json:"private"`
    Description     string `json:"description"`
    OriginalURL     string
    GitServiceType  GitServiceType
    Wiki            bool
    Issues          bool
    Milestones      bool
    Labels          bool
    Releases        bool
    Comments        bool
    PullRequests    bool
    MigrateToRepoID int64
}

MigrateRepoOption options for migrating a repository from an external service

type Milestone Uses

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"`
}

Milestone milestone is a collection of issues on one repository

type Organization Uses

type Organization struct {
    ID                        int64  `json:"id"`
    UserName                  string `json:"username"`
    FullName                  string `json:"full_name"`
    AvatarURL                 string `json:"avatar_url"`
    Description               string `json:"description"`
    Website                   string `json:"website"`
    Location                  string `json:"location"`
    Visibility                string `json:"visibility"`
    RepoAdminChangeTeamAccess bool   `json:"repo_admin_change_team_access"`
}

Organization represents an organization

type PRBranchInfo Uses

type PRBranchInfo struct {
    Name       string      `json:"label"`
    Ref        string      `json:"ref"`
    Sha        string      `json:"sha"`
    RepoID     int64       `json:"repo_id"`
    Repository *Repository `json:"repo"`
}

PRBranchInfo information about a branch

type PayloadCommit Uses

type PayloadCommit struct {
    // sha1 hash of the commit
    ID           string                     `json:"id"`
    Message      string                     `json:"message"`
    URL          string                     `json:"url"`
    Author       *PayloadUser               `json:"author"`
    Committer    *PayloadUser               `json:"committer"`
    Verification *PayloadCommitVerification `json:"verification"`
    // swagger:strfmt date-time
    Timestamp time.Time `json:"timestamp"`
    Added     []string  `json:"added"`
    Removed   []string  `json:"removed"`
    Modified  []string  `json:"modified"`
}

PayloadCommit represents a commit

type PayloadCommitVerification Uses

type PayloadCommitVerification struct {
    Verified  bool         `json:"verified"`
    Reason    string       `json:"reason"`
    Signature string       `json:"signature"`
    Signer    *PayloadUser `json:"signer"`
    Payload   string       `json:"payload"`
}

PayloadCommitVerification represents the GPG verification of a commit

type PayloadUser Uses

type PayloadUser struct {
    // Full name of the commit author
    Name string `json:"name"`
    // swagger:strfmt email
    Email    string `json:"email"`
    UserName string `json:"username"`
}

PayloadUser represents the author or committer of a commit

type Payloader Uses

type Payloader interface {
    SetSecret(string)
    JSONPayload() ([]byte, error)
}

Payloader payload is some part of one hook

type Permission Uses

type Permission struct {
    Admin bool `json:"admin"`
    Push  bool `json:"push"`
    Pull  bool `json:"pull"`
}

Permission represents a set of permissions

type PublicKey Uses

type PublicKey struct {
    ID          int64  `json:"id"`
    Key         string `json:"key"`
    URL         string `json:"url,omitempty"`
    Title       string `json:"title,omitempty"`
    Fingerprint string `json:"fingerprint,omitempty"`
    // swagger:strfmt date-time
    Created  time.Time `json:"created_at,omitempty"`
    Owner    *User     `json:"user,omitempty"`
    ReadOnly bool      `json:"read_only,omitempty"`
    KeyType  string    `json:"key_type,omitempty"`
}

PublicKey publickey is a user key to push code to repository

type PullRequest Uses

type PullRequest struct {
    ID        int64      `json:"id"`
    URL       string     `json:"url"`
    Index     int64      `json:"number"`
    Poster    *User      `json:"user"`
    Title     string     `json:"title"`
    Body      string     `json:"body"`
    Labels    []*Label   `json:"labels"`
    Milestone *Milestone `json:"milestone"`
    Assignee  *User      `json:"assignee"`
    Assignees []*User    `json:"assignees"`
    State     StateType  `json:"state"`
    Comments  int        `json:"comments"`

    HTMLURL  string `json:"html_url"`
    DiffURL  string `json:"diff_url"`
    PatchURL string `json:"patch_url"`

    Mergeable bool `json:"mergeable"`
    HasMerged bool `json:"merged"`
    // swagger:strfmt date-time
    Merged         *time.Time `json:"merged_at"`
    MergedCommitID *string    `json:"merge_commit_sha"`
    MergedBy       *User      `json:"merged_by"`

    Base      *PRBranchInfo `json:"base"`
    Head      *PRBranchInfo `json:"head"`
    MergeBase string        `json:"merge_base"`

    // swagger:strfmt date-time
    Deadline *time.Time `json:"due_date"`

    // swagger:strfmt date-time
    Created *time.Time `json:"created_at"`
    // swagger:strfmt date-time
    Updated *time.Time `json:"updated_at"`
    // swagger:strfmt date-time
    Closed *time.Time `json:"closed_at"`
}

PullRequest represents a pull request

type PullRequestMeta Uses

type PullRequestMeta struct {
    HasMerged bool       `json:"merged"`
    Merged    *time.Time `json:"merged_at"`
}

PullRequestMeta PR info if an issue is a PR

type PullRequestPayload Uses

type PullRequestPayload struct {
    Secret      string          `json:"secret"`
    Action      HookIssueAction `json:"action"`
    Index       int64           `json:"number"`
    Changes     *ChangesPayload `json:"changes,omitempty"`
    PullRequest *PullRequest    `json:"pull_request"`
    Repository  *Repository     `json:"repository"`
    Sender      *User           `json:"sender"`
    Review      *ReviewPayload  `json:"review"`
}

PullRequestPayload represents a payload information of pull request event.

func (*PullRequestPayload) JSONPayload Uses

func (p *PullRequestPayload) JSONPayload() ([]byte, error)

JSONPayload FIXME

func (*PullRequestPayload) SetSecret Uses

func (p *PullRequestPayload) SetSecret(secret string)

SetSecret modifies the secret of the PullRequestPayload.

type PushPayload Uses

type PushPayload struct {
    Secret     string           `json:"secret"`
    Ref        string           `json:"ref"`
    Before     string           `json:"before"`
    After      string           `json:"after"`
    CompareURL string           `json:"compare_url"`
    Commits    []*PayloadCommit `json:"commits"`
    HeadCommit *PayloadCommit   `json:"head_commit"`
    Repo       *Repository      `json:"repository"`
    Pusher     *User            `json:"pusher"`
    Sender     *User            `json:"sender"`
}

PushPayload represents a payload information of push event.

func ParsePushHook Uses

func ParsePushHook(raw []byte) (*PushPayload, error)

ParsePushHook parses push event hook content.

func (*PushPayload) Branch Uses

func (p *PushPayload) Branch() string

Branch returns branch name from a payload

func (*PushPayload) JSONPayload Uses

func (p *PushPayload) JSONPayload() ([]byte, error)

JSONPayload FIXME

func (*PushPayload) SetSecret Uses

func (p *PushPayload) SetSecret(secret string)

SetSecret modifies the secret of the PushPayload

type PusherType Uses

type PusherType string

PusherType define the type to push

const (
    PusherTypeUser PusherType = "user"
)

describe all the PusherTypes

type Reference Uses

type Reference struct {
    Ref    string     `json:"ref"`
    URL    string     `json:"url"`
    Object *GitObject `json:"object"`
}

Reference represents a Git reference.

type Release Uses

type Release struct {
    ID           int64  `json:"id"`
    TagName      string `json:"tag_name"`
    Target       string `json:"target_commitish"`
    Title        string `json:"name"`
    Note         string `json:"body"`
    URL          string `json:"url"`
    TarURL       string `json:"tarball_url"`
    ZipURL       string `json:"zipball_url"`
    IsDraft      bool   `json:"draft"`
    IsPrerelease bool   `json:"prerelease"`
    // swagger:strfmt date-time
    CreatedAt time.Time `json:"created_at"`
    // swagger:strfmt date-time
    PublishedAt time.Time     `json:"published_at"`
    Publisher   *User         `json:"author"`
    Attachments []*Attachment `json:"assets"`
}

Release represents a repository release

type ReleasePayload Uses

type ReleasePayload struct {
    Secret     string            `json:"secret"`
    Action     HookReleaseAction `json:"action"`
    Release    *Release          `json:"release"`
    Repository *Repository       `json:"repository"`
    Sender     *User             `json:"sender"`
}

ReleasePayload represents a payload information of release event.

func (*ReleasePayload) JSONPayload Uses

func (p *ReleasePayload) JSONPayload() ([]byte, error)

JSONPayload implements Payload

func (*ReleasePayload) SetSecret Uses

func (p *ReleasePayload) SetSecret(secret string)

SetSecret modifies the secret of the ReleasePayload

type RepoCommit Uses

type RepoCommit struct {
    URL       string      `json:"url"`
    Author    *CommitUser `json:"author"`
    Committer *CommitUser `json:"committer"`
    Message   string      `json:"message"`
    Tree      *CommitMeta `json:"tree"`
}

RepoCommit contains information of a commit in the context of a repository.

type RepoTopicOptions Uses

type RepoTopicOptions struct {
    // list of topic names
    Topics []string `json:"topics"`
}

RepoTopicOptions a collection of repo topic names

type Repository Uses

type Repository struct {
    ID            int64       `json:"id"`
    Owner         *User       `json:"owner"`
    Name          string      `json:"name"`
    FullName      string      `json:"full_name"`
    Description   string      `json:"description"`
    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"`
    HTMLURL       string      `json:"html_url"`
    SSHURL        string      `json:"ssh_url"`
    CloneURL      string      `json:"clone_url"`
    OriginalURL   string      `json:"original_url"`
    Website       string      `json:"website"`
    Stars         int         `json:"stars_count"`
    Forks         int         `json:"forks_count"`
    Watchers      int         `json:"watchers_count"`
    OpenIssues    int         `json:"open_issues_count"`
    DefaultBranch string      `json:"default_branch"`
    Archived      bool        `json:"archived"`
    // swagger:strfmt date-time
    Created time.Time `json:"created_at"`
    // swagger:strfmt date-time
    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"`
    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"`
}

Repository represents a repository

type RepositoryMeta Uses

type RepositoryMeta struct {
    ID       int64  `json:"id"`
    Name     string `json:"name"`
    FullName string `json:"full_name"`
}

RepositoryMeta basic repository information

type RepositoryPayload Uses

type RepositoryPayload struct {
    Secret       string         `json:"secret"`
    Action       HookRepoAction `json:"action"`
    Repository   *Repository    `json:"repository"`
    Organization *User          `json:"organization"`
    Sender       *User          `json:"sender"`
}

RepositoryPayload payload for repository webhooks

func (*RepositoryPayload) JSONPayload Uses

func (p *RepositoryPayload) JSONPayload() ([]byte, error)

JSONPayload JSON representation of the payload

func (*RepositoryPayload) SetSecret Uses

func (p *RepositoryPayload) SetSecret(secret string)

SetSecret modifies the secret of the RepositoryPayload

type ReviewPayload Uses

type ReviewPayload struct {
    Type    string `json:"type"`
    Content string `json:"content"`
}

ReviewPayload FIXME

type SearchError Uses

type SearchError struct {
    OK    bool   `json:"ok"`
    Error string `json:"error"`
}

SearchError error of a failed search

type SearchResults Uses

type SearchResults struct {
    OK   bool          `json:"ok"`
    Data []*Repository `json:"data"`
}

SearchResults results of a successful search

type ServerVersion Uses

type ServerVersion struct {
    Version string `json:"version"`
}

ServerVersion wraps the version of the server

type StateType Uses

type StateType string

StateType issue state type

const (
    // StateOpen pr is opend
    StateOpen StateType = "open"
    // StateClosed pr is closed
    StateClosed StateType = "closed"
    // StateAll is all
    StateAll StateType = "all"
)

type Status Uses

type Status struct {
    ID          int64       `json:"id"`
    State       StatusState `json:"status"`
    TargetURL   string      `json:"target_url"`
    Description string      `json:"description"`
    URL         string      `json:"url"`
    Context     string      `json:"context"`
    Creator     *User       `json:"creator"`
    // swagger:strfmt date-time
    Created time.Time `json:"created_at"`
    // swagger:strfmt date-time
    Updated time.Time `json:"updated_at"`
}

Status holds a single Status of a single Commit

type StatusState Uses

type StatusState string

StatusState holds the state of a Status It can be "pending", "success", "error", "failure", and "warning"

const (
    // StatusPending is for when the Status is Pending
    StatusPending StatusState = "pending"
    // StatusSuccess is for when the Status is Success
    StatusSuccess StatusState = "success"
    // StatusError is for when the Status is Error
    StatusError StatusState = "error"
    // StatusFailure is for when the Status is Failure
    StatusFailure StatusState = "failure"
    // StatusWarning is for when the Status is Warning
    StatusWarning StatusState = "warning"
)

type Tag Uses

type Tag struct {
    Name       string      `json:"name"`
    ID         string      `json:"id"`
    Commit     *CommitMeta `json:"commit"`
    ZipballURL string      `json:"zipball_url"`
    TarballURL string      `json:"tarball_url"`
}

Tag represents a repository tag

type TaskStatus Uses

type TaskStatus int

TaskStatus defines task status

const (
    TaskStatusQueue    TaskStatus = iota // 0 task is queue
    TaskStatusRunning                    // 1 task is running
    TaskStatusStopped                    // 2 task is stopped
    TaskStatusFailed                     // 3 task is failed
    TaskStatusFinished                   // 4 task is finished
)

enumerate all the kinds of task status

type TaskType Uses

type TaskType int

TaskType defines task type

const (
    TaskTypeMigrateRepo TaskType = iota // migrate repository from external or local disk
)

all kinds of task types

func (TaskType) Name Uses

func (taskType TaskType) Name() string

Name returns the task type name

type Team Uses

type Team struct {
    ID                      int64         `json:"id"`
    Name                    string        `json:"name"`
    Description             string        `json:"description"`
    Organization            *Organization `json:"organization"`
    IncludesAllRepositories bool          `json:"includes_all_repositories"`
    // enum: none,read,write,admin,owner
    Permission string `json:"permission"`
    // example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"]
    Units []string `json:"units"`
}

Team represents a team in an organization

type TopicName Uses

type TopicName struct {
    TopicNames []string `json:"topics"`
}

TopicName a list of repo topic names

type TopicResponse Uses

type TopicResponse struct {
    ID        int64     `json:"id"`
    Name      string    `json:"topic_name"`
    RepoCount int       `json:"repo_count"`
    Created   time.Time `json:"created"`
    Updated   time.Time `json:"updated"`
}

TopicResponse for returning topics

type TrackedTime Uses

type TrackedTime struct {
    ID  int64 `json:"id"`
    // swagger:strfmt date-time
    Created time.Time `json:"created"`
    // Time in seconds
    Time    int64 `json:"time"`
    UserID  int64 `json:"user_id"`
    IssueID int64 `json:"issue_id"`
}

TrackedTime worked time for an issue / pr

type TrackedTimes Uses

type TrackedTimes []*TrackedTime

TrackedTimes represent a list of tracked times

type UpdateFileOptions Uses

type UpdateFileOptions struct {
    DeleteFileOptions
    // content must be base64 encoded
    // required: true
    Content string `json:"content"`
    // from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL
    FromPath string `json:"from_path" binding:"MaxSize(500)"`
}

UpdateFileOptions options for updating files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

type User Uses

type User struct {
    // the user's id
    ID  int64 `json:"id"`
    // the user's username
    UserName string `json:"login"`
    // the user's full name
    FullName string `json:"full_name"`
    // swagger:strfmt email
    Email string `json:"email"`
    // URL to the user's avatar
    AvatarURL string `json:"avatar_url"`
    // User locale
    Language string `json:"language"`
    // Is the user an administrator
    IsAdmin bool `json:"is_admin"`
    // swagger:strfmt date-time
    LastLogin time.Time `json:"last_login,omitempty"`
    // swagger:strfmt date-time
    Created time.Time `json:"created,omitempty"`
}

User represents a user swagger:model

func (User) MarshalJSON Uses

func (u User) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for User, adding field(s) for backward compatibility

type VisibleType Uses

type VisibleType int

VisibleType defines the visibility (Organization only)

const (
    // VisibleTypePublic Visible for everyone
    VisibleTypePublic VisibleType = iota

    // VisibleTypeLimited Visible for every connected user
    VisibleTypeLimited

    // VisibleTypePrivate Visible only for organization's members
    VisibleTypePrivate
)

func (VisibleType) IsLimited Uses

func (vt VisibleType) IsLimited() bool

IsLimited returns true if VisibleType is limited

func (VisibleType) IsPrivate Uses

func (vt VisibleType) IsPrivate() bool

IsPrivate returns true if VisibleType is private

func (VisibleType) IsPublic Uses

func (vt VisibleType) IsPublic() bool

IsPublic returns true if VisibleType is public

func (VisibleType) String Uses

func (vt VisibleType) String() string

VisibilityString provides the mode string of the visibility type (public, limited, private)

type WatchInfo Uses

type WatchInfo struct {
    Subscribed    bool        `json:"subscribed"`
    Ignored       bool        `json:"ignored"`
    Reason        interface{} `json:"reason"`
    CreatedAt     time.Time   `json:"created_at"`
    URL           string      `json:"url"`
    RepositoryURL string      `json:"repository_url"`
}

WatchInfo represents an API watch status of one repository

Package structs imports 5 packages (graph) and is imported by 48 packages. Updated 2019-11-17. Refresh now. Tools for package owners.