sourcegraph

type AnyToken string

type AugmentedDefAuthor struct {
	Person *Person
	*DefAuthor
}

type AugmentedDefClient struct {
	Person *Person
	*DefClient
}

type AugmentedDefDependent struct {
	Repo *Repo
	*DefDependent
}

type AugmentedPersonUsageByClient struct {
	Author *Person
	*PersonUsageByClient
}

type AugmentedPersonUsageOfAuthor struct {
	Client *Person
	*PersonUsageOfAuthor
}

type AugmentedRepoAuthor struct {
	Person *Person
	*RepoAuthor
}

type AugmentedRepoClient struct {
	Person *Person
	*RepoClient
}

type AugmentedRepoContribution struct {
	Repo *Repo
	*RepoContribution
}

type AugmentedRepoDependency struct {
	Repo *Repo
	*RepoDependency
}

type AugmentedRepoDependent struct {
	Repo *Repo
	*RepoDependent
}

type AugmentedRepoUsageByClient struct {
	DefRepo            *Repo
	*RepoUsageByClient `json:"RepoUsageByClient"`
}

type AugmentedRepoUsageOfAuthor struct {
	Repo               *Repo
	*RepoUsageOfAuthor `json:"RepoUsageOfAuthor"`
}

type AuthorStats struct {
	AuthorshipInfo

	// DefCount is the number of defs that this author contributed (where
	// "contributed" means "committed any hunk of code to source code files").
	DefCount int `db:"def_count"`

	DefsProportion float64 `db:"defs_proportion"`

	// ExportedDefCount is the number of exported defs that this author
	// contributed (where "contributed to" means "committed any hunk of code to
	// source code files").
	ExportedDefCount int `db:"exported_def_count"`

	ExportedDefsProportion float64 `db:"exported_defs_proportion"`
}

type AuthorshipInfo struct {
	AuthorEmail    string    `db:"author_email"`
	LastCommitDate time.Time `db:"last_commit_date"`

	// LastCommitID is the commit ID of the last commit that this author made to
	// the thing that this info describes.
	LastCommitID string `db:"last_commit_id"`
}

type Badge struct {
	Name              string
	Description       string
	ImageURL          string
	UncountedImageURL string
	Markdown          string
}

type Build struct {
	BID  int64 `json:",omitempty"`
	Repo int

	// CommitID is the full resolved commit ID to build.
	CommitID string `db:"commit_id"`

	CreatedAt   time.Time          `db:"created_at"`
	StartedAt   db_common.NullTime `db:"started_at"`
	EndedAt     db_common.NullTime `db:"ended_at"`
	HeartbeatAt db_common.NullTime `db:"heartbeat_at"`
	Success     bool               `json:",omitempty"`
	Failure     bool               `json:",omitempty"`

	// Killed is true if this build's worker didn't exit on its own
	// accord. It is generally set when no heartbeat has been received
	// within a certain interval. If Killed is true, then Failure must
	// also always be set to true. Unqueued builds are never killed
	// for lack of a heartbeat.
	Killed bool `json:",omitempty"`

	// Host is the hostname of the machine that is working on this build.
	Host string `json:",omitempty"`

	Purged bool // whether the build's data (defs/refs/etc.) has been purged

	BuildConfig

	BuildMeta

	// RepoURI is populated (as a convenience) in results by Get and List but
	// should not be set when creating builds (it will be ignored).
	RepoURI *string `db:"repo_uri" json:",omitempty"`
}

type BuildConfig struct {
	// Import is whether to import the build data into the database when the
	// build is complete. The data must be imported for Sourcegraph's web app or
	// API to use it, except that unimported build data is available through the
	// BuildData service. (TODO(sqs): BuildData isn't yet implemented.)
	Import bool

	// Queue is whether this build should be enqueued. If enqueued, any worker
	// may begin running this build. If not enqueued, it is up to the client to
	// run the build and update it accordingly.
	Queue bool

	// UseCache is whether to use cached build data files. If false, the
	// .sourcegraph-data directory will be wiped out before the build begins.
	//
	// Regardless of the value of UseCache, the build data files will be
	// uploaded to the central cache after the build ends.
	UseCache bool `db:"use_cache"`

	// Priority of the build in the queue (higher numbers mean the build is
	// dequeued sooner).
	Priority int
}

type BuildCreateOptions struct {
	BuildConfig
	BuildMeta

	// Force creation of build. If false, the build will not be
	// created if a build for the same repository and with the same
	// BuildConfig exists. In all cases, the BuildMeta information is
	// merged with the data that is already persisted.
	//
	// TODO(bliu): test this
	Force bool
}

type BuildDataFileSpec struct {
	RepoRev RepoRevSpec
	Path    string
}

type BuildDataService interface {
	// FileSystem returns a virtual filesystem interface to the build
	// data for a repo at a specific commit.
	FileSystem(repo RepoRevSpec) (rwvfs.FileSystem, error)
}

type BuildGetLogOptions struct {
	// MinID indicates that only log entries whose monotonically increasing ID
	// is greater than MinID should be returned.
	//
	// To "tail -f" or watch a log for updates, set each subsequent request's
	// MinID to the MaxID of the previous request.
	MinID string
}

type BuildGetOptions struct{}

type BuildListOptions struct {
	Queued    bool `url:",omitempty"`
	Active    bool `url:",omitempty"`
	Ended     bool `url:",omitempty"`
	Succeeded bool `url:",omitempty"`
	Failed    bool `url:",omitempty"`

	Purged bool `url:",omitempty"`

	Repo     string `url:",omitempty"`
	CommitID string `url:",omitempty"`

	Sort      string `url:",omitempty"`
	Direction string `url:",omitempty"`

	ListOptions
}

type BuildMeta struct {
	// PullRepo is the RID of the repo associated with the pull
	// request that caused this build to be created. If this build was
	// not created due to a pull request, it is 0. If this build is
	// for the head commit of a PR against a different base repo,
	// PullRepo is the RID of that base repo (and PullRepo != the
	// build's Repo).
	//
	// If PullRepo is set, PullNumber must also be set.
	//
	// TODO(sqs): This assumes that a given commit is only the head
	// commit for a single PR, which is not true in general.
	PullRepo int `db:"pull_repo" json:",omitempty"`

	// PullNumber is the pull number (e.g., #123) of the pull request
	// (on PullRepo) that caused this build to be created. If this
	// build was not created due to a pull request, it is 0.
	//
	// If PullNumber is set, PullRepo must also be set.
	//
	// TODO(sqs): This assumes that a given commit is only the head
	// commit for a single PR, which is not true in general.
	PullNumber int `db:"pull_number" json:",omitempty"`
}

type BuildSpec struct {
	BID int64
}

type BuildTask struct {
	// TaskID is the unique ID of this task. It is unique over all
	// tasks, not just tasks in the same build.
	TaskID int64 `json:",omitempty"`

	// BID is the build that this task is a part of.
	BID int64

	// UnitType is the srclib source unit type of the source unit that
	// this task is associated with.
	UnitType string `db:"unit_type" json:",omitempty"`

	// Unit is the srclib source unit name of the source unit that
	// this task is associated with.
	Unit string `json:",omitempty"`

	// Op is the srclib toolchain operation (graph, depresolve, etc.) that this
	// task performs.
	Op string `json:",omitempty"`

	// Order is the order in which this task is performed, relative to other
	// tasks in the same build. Lower-number-ordered tasks are built first.
	// Multiple tasks may have the same order.
	Order int `json:",omitempty"`

	// CreatedAt is when this task was initially created.
	CreatedAt db_common.NullTime `db:"created_at"`

	// StartedAt is when this task's execution began.
	StartedAt db_common.NullTime `db:"started_at" json:",omitempty"`

	// EndedAt is when this task's execution ended (whether because it
	// succeeded or failed).
	EndedAt db_common.NullTime `db:"ended_at" json:",omitempty"`

	// Queue is whether this task should be performed by queue task
	// remote workers on the central server. If true, then it will be
	// performed remotely. If false, it should be performed locally by
	// the process that created this task.
	//
	// For example, import tasks are queued because they are performed
	// by the remote server, not the local "src" process running on
	// the builders.
	//
	// See the documentation for Build for more discussion about
	// queued builds and tasks (and how they relate).
	Queue bool

	// Success is whether this task's execution succeeded.
	Success bool `json:",omitempty"`

	// Failure is whether this task's execution failed.
	Failure bool `json:",omitempty"`
}

type BuildTaskListOptions struct{ ListOptions }

type BuildUpdate struct {
	StartedAt   *time.Time
	EndedAt     *time.Time
	HeartbeatAt *time.Time
	Host        *string
	Success     *bool
	Purged      *bool
	Failure     *bool
	Killed      *bool
	Priority    *int
}

type BuildsService interface {
	// Get fetches a build.
	Get(build BuildSpec, opt *BuildGetOptions) (*Build, Response, error)

	// List builds.
	List(opt *BuildListOptions) ([]*Build, Response, error)

	// Create a new build. The build will run asynchronously (Create does not
	// wait for it to return. To monitor the build's status, use Get.)
	Create(repoRev RepoRevSpec, opt *BuildCreateOptions) (*Build, Response, error)

	// Update updates information about a build and returns the build
	// after the update has been applied.
	Update(build BuildSpec, info BuildUpdate) (*Build, Response, error)

	// ListBuildTasks lists the tasks associated with a build.
	ListBuildTasks(build BuildSpec, opt *BuildTaskListOptions) ([]*BuildTask, Response, error)

	// CreateTasks creates tasks associated with a build and returns
	// them with their TID fields set.
	CreateTasks(build BuildSpec, tasks []*BuildTask) ([]*BuildTask, Response, error)

	// UpdateTask updates a task associated with a build.
	UpdateTask(task TaskSpec, info TaskUpdate) (*BuildTask, Response, error)

	// GetLog gets log entries associated with a build.
	GetLog(build BuildSpec, opt *BuildGetLogOptions) (*LogEntries, Response, error)

	// GetTaskLog gets log entries associated with a task.
	GetTaskLog(task TaskSpec, opt *BuildGetLogOptions) (*LogEntries, Response, error)

	// DequeueNext returns the next queued build and marks it as
	// having started (atomically). It is not considered an error if
	// there are no builds in the queue; in that case, a nil build and
	// error are returned.
	//
	// The HTTP response may contain tickets that grant the necessary
	// permissions to build and upload build data for the build's
	// repository. Call auth.SignedTicketStrings on the response's
	// HTTP response field to obtain the tickets.
	DequeueNext() (*Build, Response, error)
}

type Checklist struct {
	Todo int // number of tasks to be done (unchecked)
	Done int // number of tasks that are done (checked)
}

type Client struct {
	// Services used to communicate with different parts of the Sourcegraph API.
	BuildData    BuildDataService
	Builds       BuildsService
	Deltas       DeltasService
	Issues       IssuesService
	Orgs         OrgsService
	People       PeopleService
	PullRequests PullRequestsService
	Repos        ReposService
	RepoTree     RepoTreeService
	Search       SearchService
	Units        UnitsService
	Users        UsersService
	Defs         DefsService
	Markdown     MarkdownService

	// Base URL for API requests, which should have a trailing slash.
	BaseURL *url.URL

	// User agent used for HTTP requests to the Sourcegraph API.
	UserAgent string
	// contains filtered or unexported fields
}

type ClientStats struct {
	AuthorshipInfo

	// DefRepo is the URI of the repository that defines defs that
	// this client referred to.
	DefRepo string `db:"def_repo"`

	// DefUnitType and DefUnit are the unit in DefRepo that defines
	// defs that this client referred to. If DefUnitType == "" and
	// DefUnit == "", then this ClientStats is an aggregate of this client's
	// refs to all units in DefRepo.
	DefUnitType nnz.String `db:"def_unit_type"`
	DefUnit     nnz.String `db:"def_unit"`

	// RefCount is the number of references this client made in this repository
	// to DefRepo.
	RefCount int `db:"ref_count"`
}

type CombinedStatus struct {
	github.CombinedStatus
}

type Commit struct {
	*vcs.Commit
}

type Completions struct {
	// TokenCompletions are suggested completions for the token at the
	// raw query's InsertionPoint.
	TokenCompletions Tokens

	// ResolvedTokens is the resolution of the original query's tokens
	// used to produce the completions. It is useful for debugging.
	ResolvedTokens Tokens

	ResolveErrors   []TokenError `json:",omitempty"`
	ResolutionFatal bool         `json:",omitempty"`
}

type Counter struct {
	Name              string
	Description       string
	ImageURL          string
	UncountedImageURL string
	Markdown          string
}

type Def struct {
	graph.Def

	Stat graph.Stats `json:",omitempty"`

	DocHTML string `json:",omitempty"`

	FmtStrings *DefFormatStrings `json:",omitempty"`
}

type DefAuthor struct {
	UID   nnz.Int
	Email nnz.String
	DefAuthorship
}

type DefAuthorsByBytes []*DefAuthor

type DefAuthorship struct {
	AuthorshipInfo

	// Exported is whether the def is exported.
	Exported bool

	Bytes           int
	BytesProportion float64
}

type DefClient struct {
	UID   nnz.Int
	Email nnz.String

	AuthorshipInfo

	// UseCount is the number of times this person referred to the def.
	UseCount int `db:"use_count"`
}

type DefDelta struct {
	Base *Def // the def in the base commit (if nil, this def was added in the head)
	Head *Def // the def in the head commit (if nil, this def was deleted in the head)
}

type DefDependent struct {
	FromRepo string `db:"from_repo"`
	Count    int
}

type DefFormatStrings struct {
	Name                 QualFormatStrings
	Type                 QualFormatStrings
	NameAndTypeSeparator string
	Language             string `json:",omitempty"`
	DefKeyword           string `json:",omitempty"`
	Kind                 string `json:",omitempty"`
}

type DefGetOptions struct {
	Doc bool `url:",omitempty"`

	// Stats is whether the Def response object should include statistics.
	Stats bool `url:",omitempty"`
}

type DefListAuthorsOptions struct {
	ListOptions
}

type DefListClientsOptions struct {
	ListOptions
}

type DefListDependentsOptions struct {
	ListOptions
}

type DefListExamplesOptions struct {
	Formatted bool `url:",omitempty"`

	// Filter by a specific Repo URI
	Repo string `url:",omitempty"`

	// TokenizedSource requests that the source code be returned as a tokenized data
	// structure rather than an (annotated) string.
	//
	// This is useful when the client wants to take full control of rendering and manipulating
	// the contents.
	TokenizedSource bool `url:",omitempty"`

	ListOptions
}

type DefListOptions struct {
	Name string `url:",omitempty" json:",omitempty"`

	// Specifies a search query for defs. If specified, then the Sort and Direction options are ignored
	Query string `url:",omitempty" json:",omitempty"`

	// ByteStart and ByteEnd will restrict the results to only definitions that overlap with the specified
	// start and end byte offsets. This filter is only applied if both values are set.
	ByteStart, ByteEnd uint32

	// DefKeys, if set, will return the definitions that match the given DefKey
	DefKeys []*graph.DefKey

	// RepoRevs constrains the results to a set of repository
	// revisions (given by their URIs plus an optional "@" and a
	// revision specifier). For example, "repo.com/foo@revspec".
	RepoRevs []string `url:",omitempty,comma" json:",omitempty"`

	UnitType string `url:",omitempty" json:",omitempty"`
	Unit     string `url:",omitempty" json:",omitempty"`

	Path string `url:",omitempty" json:",omitempty"`

	// File, if specified, will restrict the results to only defs defined in
	// the specified file.
	File string `url:",omitempty" json:",omitempty"`

	// FilePathPrefix, if specified, will restrict the results to only defs defined in
	// files whose path is underneath the specified prefix.
	FilePathPrefix string `url:",omitempty" json:",omitempty"`

	Kinds    []string `url:",omitempty,comma" json:",omitempty"`
	Exported bool     `url:",omitempty" json:",omitempty"`
	Nonlocal bool     `url:",omitempty" json:",omitempty"`

	// IncludeTest is whether the results should include definitions in test
	// files.
	IncludeTest bool `url:",omitempty" json:",omitempty"`

	// Enhancements
	Doc   bool `url:",omitempty" json:",omitempty"`
	Stats bool `url:",omitempty" json:",omitempty"`
	Fuzzy bool `url:",omitempty" json:",omitempty"`

	// Sorting
	Sort      string `url:",omitempty" json:",omitempty"`
	Direction string `url:",omitempty" json:",omitempty"`

	// Paging
	ListOptions
}

type DefListRefsOptions struct {
	Authorship bool   `url:",omitempty"` // whether to fetch authorship info about the refs
	Repo       string `url:",omitempty"` // only fetch refs from this repository URI
	ListOptions
}

type DefListVersionsOptions struct {
	ListOptions
}

type DefSpec struct {
	Repo     string
	CommitID string
	UnitType string
	Unit     string
	Path     string
}

type DefsService interface {
	// Get fetches a def.
	Get(def DefSpec, opt *DefGetOptions) (*Def, Response, error)

	// List defs.
	List(opt *DefListOptions) ([]*Def, Response, error)

	// ListRefs lists references to def.
	ListRefs(def DefSpec, opt *DefListRefsOptions) ([]*Ref, Response, error)

	// ListExamples lists examples for def.
	ListExamples(def DefSpec, opt *DefListExamplesOptions) ([]*Example, Response, error)

	// ListExamples lists people who committed parts of def's definition.
	ListAuthors(def DefSpec, opt *DefListAuthorsOptions) ([]*AugmentedDefAuthor, Response, error)

	// ListClients lists people who use def in their code.
	ListClients(def DefSpec, opt *DefListClientsOptions) ([]*AugmentedDefClient, Response, error)

	// ListDependents lists repositories that use def in their code.
	ListDependents(def DefSpec, opt *DefListDependentsOptions) ([]*AugmentedDefDependent, Response, error)

	// ListVersions lists all available versions of a definition in
	// the various repository commits in which it has appeared.
	//
	// TODO(sqs): how to deal with renames, etc.?
	ListVersions(def DefSpec, opt *DefListVersionsOptions) ([]*Def, Response, error)
}

type Delta struct {
	Base, Head             RepoRevSpec // base/head repo and revspec
	BaseCommit, HeadCommit *Commit     // base/head commits
	BaseRepo, HeadRepo     *Repo       // base/head repositories
	BaseBuild, HeadBuild   *Build      // base/head builds (or nil)
}

type DeltaAffectedPerson struct {
	Person // the affected person

	Defs []*Def // the defs they authored or use (the reason why they're affected)
}

type DeltaAffectedRepo struct {
	Repo // the affected repository

	DefRefs []*DeltaDefRefs // refs to defs that were changed/deleted
}

type DeltaDefRefs struct {
	Def  *Def       // the changed/deleted def
	Refs []*Example // all of the parent DeltaAffectedRepo.Repo's refs to Def
}

type DeltaDefs struct {
	Defs []*DefDelta // added/changed/deleted defs

	DiffStat diff.Stat // overall diffstat (not subject to pagination)
}

type DeltaDependencies struct {
}

type DeltaFiles struct {
	FileDiffs []*FileDiff
	Delta     *Delta
	Stats     diff.Stat
}

type DeltaFilter struct {
	Unit     string `url:",omitempty"`
	UnitType string `url:",omitempty"`
}

type DeltaGetOptions struct{}

type DeltaListAffectedAuthorsOptions struct {
	DeltaFilter
	ListOptions
}

type DeltaListAffectedClientsOptions struct {
	DeltaFilter
	ListOptions
}

type DeltaListAffectedDependentsOptions struct {
	NotFormatted bool `url:",omitempty"`

	DeltaFilter
	ListOptions
}

type DeltaListDefsOptions struct {
	DeltaFilter
	ListOptions
}

type DeltaListDependenciesOptions struct {
	DeltaFilter
	ListOptions
}

type DeltaListFilesOptions struct {
	// Formatted is whether the files should have their contents
	// code-formatted (syntax-highlighted and reference-linked) if
	// they contain code.
	Formatted bool `url:",omitempty"`

	// Filter filters the list of returned files to those whose name matches Filter.
	Filter string `url:",omitempty"`

	// Tokenized, when set, will tokenize the whole source code contained in the diff,
	// returning 3 versions for each hunk: Head revision, Base revision and Hunk body.
	// For more information, see sourcegraph.Hunk.
	Tokenized bool `url:",omitempty"`

	DeltaFilter
}

type DeltaListIncomingOptions struct {
	DeltaFilter
	ListOptions
}

type DeltaListReviewersOptions struct {
	DeltaFilter
	ListOptions
}

type DeltaListUnitsOptions struct{}

type DeltaReviewer struct {
	Person

	Suggested       bool   `json:",omitempty"` // whether this reviewer is just suggested as a possible reviewer (and not actually assigned)
	ReasonSuggested string `json:",omitempty"` // if Suggested, this is why (e.g., because the person wrote code this delta touches)

	Defs []*Def `json:",omitempty"` // defs that this reviewer committed to and that were changed in or affected by the delta
}

type DeltaSpec struct {
	Base RepoRevSpec
	Head RepoRevSpec
}

type DeltasService interface {
	// Get fetches a summary of a delta.
	Get(ds DeltaSpec, opt *DeltaGetOptions) (*Delta, Response, error)

	// ListUnits lists units added/changed/deleted in a delta.
	ListUnits(ds DeltaSpec, opt *DeltaListUnitsOptions) ([]*UnitDelta, Response, error)

	// ListDefs lists definitions added/changed/deleted in a delta.
	ListDefs(ds DeltaSpec, opt *DeltaListDefsOptions) (*DeltaDefs, Response, error)

	// ListDependencies lists dependencies added/changed/deleted in a
	// delta.
	ListDependencies(ds DeltaSpec, opt *DeltaListDependenciesOptions) (*DeltaDependencies, Response, error)

	// ListFiles fetches the file diff for a delta.
	ListFiles(ds DeltaSpec, opt *DeltaListFilesOptions) (*DeltaFiles, Response, error)

	// ListAffectedAuthors lists authors whose code is added/deleted/changed
	// in a delta.
	ListAffectedAuthors(ds DeltaSpec, opt *DeltaListAffectedAuthorsOptions) ([]*DeltaAffectedPerson, Response, error)

	// ListAffectedClients lists clients whose code is affected by a delta.
	ListAffectedClients(ds DeltaSpec, opt *DeltaListAffectedClientsOptions) ([]*DeltaAffectedPerson, Response, error)

	// ListAffectedDependents lists dependent repositories that are affected
	// by a delta.
	ListAffectedDependents(ds DeltaSpec, opt *DeltaListAffectedDependentsOptions) ([]*DeltaAffectedRepo, Response, error)

	// ListReviewers lists people who are reviewing or are suggested
	// reviewers for this delta.
	ListReviewers(ds DeltaSpec, opt *DeltaListReviewersOptions) ([]*DeltaReviewer, Response, error)

	// ListIncoming lists deltas that affect the given repo.
	ListIncoming(rr RepoRevSpec, opt *DeltaListIncomingOptions) ([]*Delta, Response, error)
}

type EmailAddr struct {
	Email string // the email address (case-insensitively compared in the DB and API)

	Verified bool // whether this email address has been verified

	Primary bool // indicates this is the user's primary email (only 1 email can be primary per user)

	Guessed bool // whether Sourcegraph inferred via public data that this is an email for the user

	Blacklisted bool // indicates that this email should not be associated with the user (even if guessed in the future)
}

type ErrRedirect struct {
	RedirectURI string
}

type ErrRenamed struct {
	// OldURI is the previous repository URI.
	OldURI string

	// NewURI is the new URI that the repository was renamed to.
	NewURI string
}

type ErrUserRenamed struct {
	// OldLogin is the previous login name.
	OldLogin string

	// NewLogin is what the old login was renamed to.
	NewLogin string
}

type ErrorResponse struct {
	Response *http.Response `json:",omitempty"` // HTTP response that caused this error
	Message  string         // error message
}

type Example struct {
	graph.Ref

	// SrcHTML is the formatted HTML source code of the example, with links to
	// definitions.
	SrcHTML template.HTML `json:",omitempty"`

	// SourceCode contains the parsed source for this example, if requested via
	// DefListExamplesOptions.
	SourceCode *SourceCode `json:",omitempty"`

	// The line that the given example starts on
	StartLine int

	// The line that the given example ends on
	EndLine int

	// Error is whether an error occurred while fetching this example.
	Error bool
}

type Examples []*Example

type FileData struct {
	// Repo is the repository that contains this file data.
	RepoRev RepoRevSpec

	// File is the file (relative to the repository root directory) that this
	// file data is from.
	File string

	// Start and End is the range of the data in the file.
	Range *Range `json:",omitempty"`

	// EntireFile is true if the data spans the entire file contents.
	EntireFile bool `json:",omitempty"`

	// Annotated (i.e., HTML-marked up) content.
	Annotated template.HTML

	// Raw data.
	Raw []byte
}

type FileDiff struct {
	*diff.FileDiff
	Hunks []*Hunk
	Stats diff.Stat
}

type FileToken struct {
	Path string

	Entry *vcsclient.TreeEntry
}

type FormatResult struct {
	// TooManyRefs indicates that the file being formatted exceeded the maximum
	// number of refs that are linked. Only the first NumRefs refs are linked.
	TooManyRefs bool `json:",omitempty"`

	// NumRefs is the number of refs that were linked in this file. If the total
	// number of refs in the file exceeds the (server-defined) limit, NumRefs is
	// capped at the limit.
	NumRefs int

	// LineStartByteOffsets is the byte offset of each line's first
	// byte.
	LineStartByteOffsets []int
}

type GitHubUserSpec struct {
	Login string
	ID    int
}

type HTTPResponse struct {
	*http.Response
}

type Hunk struct {
	*diff.Hunk

	// LinePrefixes holds a string where each character's index corresponds
	// to a line in the BodySource, and it's value reflects whether the line
	// is an addition, deletion, or change ('+', '-', ' ')
	LinePrefixes string `json:",omitempty"`

	// BaseSource holds the source code for the original hunk, having all
	// lines starting from the original line down to the end of the hunk.
	BaseSource *SourceCode `json:",omitempty"`

	// HeadSource contains the source code for the new hunk, holding
	// all consecutive lines from the start to the end.
	HeadSource *SourceCode `json:",omitempty"`

	// BodySource contains the source code for the Hunk body and is a mix
	// of both additions and deletions.
	BodySource *SourceCode `json:",omitempty"`
}

type Issue struct {
	github.Issue
}

type IssueComment struct {
	RenderedBody string // the body rendered to HTML (from raw markdown)
	Checklist    *Checklist
	github.IssueComment
}

type IssueCommentSpec struct {
	Issue   IssueSpec
	Comment int
}

type IssueGetOptions struct{}

type IssueListCommentsOptions struct {
	ListOptions
}

type IssueListOptions struct {
	State string `url:",omitempty"` // "open", "closed", or "all"
	ListOptions
}

type IssueSpec struct {
	Repo RepoSpec

	Number int // Sequence number of the issue
}

type IssuesService interface {
	// Get fetches a issue.
	Get(issue IssueSpec, opt *IssueGetOptions) (*Issue, Response, error)

	// List issues for a repository.
	ListByRepo(repo RepoSpec, opt *IssueListOptions) ([]*Issue, Response, error)

	// ListComments lists comments on a issue.
	ListComments(issue IssueSpec, opt *IssueListCommentsOptions) ([]*IssueComment, Response, error)

	// CreateComment creates a comment on an issue.
	CreateComment(issue IssueSpec, comment *IssueComment) (*IssueComment, Response, error)

	// EditComment updates a comment on an issue.
	EditComment(issue IssueSpec, comment *IssueComment) (*IssueComment, Response, error)

	// DeleteComment deletes a comment on an issue.
	DeleteComment(issue IssueSpec, commentID int) (Response, error)
}

type ListOptions struct {
	PerPage int `url:",omitempty" json:",omitempty"`
	Page    int `url:",omitempty" json:",omitempty"`
}

type LogEntries struct {
	MaxID   string
	Entries []string
}

type MarkdownData struct {
	Rendered  []byte
	Checklist *Checklist
}

type MarkdownOpt struct {
	EnableCheckboxes bool
}

type MarkdownRequestBody struct {
	Markdown []byte
	MarkdownOpt
}

type MarkdownService interface {
	Render(markdown []byte, opt MarkdownOpt) (*MarkdownData, Response, error)
}

type MockBuildDataService struct {
	FileSystem_ func(repo RepoRevSpec) (rwvfs.FileSystem, error)
}

type MockBuildsService struct {
	Get_            func(build BuildSpec, opt *BuildGetOptions) (*Build, Response, error)
	List_           func(opt *BuildListOptions) ([]*Build, Response, error)
	Create_         func(repoRev RepoRevSpec, opt *BuildCreateOptions) (*Build, Response, error)
	Update_         func(build BuildSpec, info BuildUpdate) (*Build, Response, error)
	ListBuildTasks_ func(build BuildSpec, opt *BuildTaskListOptions) ([]*BuildTask, Response, error)
	CreateTasks_    func(build BuildSpec, tasks []*BuildTask) ([]*BuildTask, Response, error)
	UpdateTask_     func(task TaskSpec, info TaskUpdate) (*BuildTask, Response, error)
	GetLog_         func(build BuildSpec, opt *BuildGetLogOptions) (*LogEntries, Response, error)
	GetTaskLog_     func(task TaskSpec, opt *BuildGetLogOptions) (*LogEntries, Response, error)
	DequeueNext_    func() (*Build, Response, error)
}

type MockDefsService struct {
	Get_            func(def DefSpec, opt *DefGetOptions) (*Def, Response, error)
	List_           func(opt *DefListOptions) ([]*Def, Response, error)
	ListRefs_       func(def DefSpec, opt *DefListRefsOptions) ([]*Ref, Response, error)
	ListExamples_   func(def DefSpec, opt *DefListExamplesOptions) ([]*Example, Response, error)
	ListAuthors_    func(def DefSpec, opt *DefListAuthorsOptions) ([]*AugmentedDefAuthor, Response, error)
	ListClients_    func(def DefSpec, opt *DefListClientsOptions) ([]*AugmentedDefClient, Response, error)
	ListDependents_ func(def DefSpec, opt *DefListDependentsOptions) ([]*AugmentedDefDependent, Response, error)
	ListVersions_   func(def DefSpec, opt *DefListVersionsOptions) ([]*Def, Response, error)
}

type MockDeltasService struct {
	Get_                    func(ds DeltaSpec, opt *DeltaGetOptions) (*Delta, Response, error)
	ListUnits_              func(ds DeltaSpec, opt *DeltaListUnitsOptions) ([]*UnitDelta, Response, error)
	ListDefs_               func(ds DeltaSpec, opt *DeltaListDefsOptions) (*DeltaDefs, Response, error)
	ListDependencies_       func(ds DeltaSpec, opt *DeltaListDependenciesOptions) (*DeltaDependencies, Response, error)
	ListFiles_              func(ds DeltaSpec, opt *DeltaListFilesOptions) (*DeltaFiles, Response, error)
	ListAffectedAuthors_    func(ds DeltaSpec, opt *DeltaListAffectedAuthorsOptions) ([]*DeltaAffectedPerson, Response, error)
	ListAffectedClients_    func(ds DeltaSpec, opt *DeltaListAffectedClientsOptions) ([]*DeltaAffectedPerson, Response, error)
	ListAffectedDependents_ func(ds DeltaSpec, opt *DeltaListAffectedDependentsOptions) ([]*DeltaAffectedRepo, Response, error)
	ListReviewers_          func(ds DeltaSpec, opt *DeltaListReviewersOptions) ([]*DeltaReviewer, Response, error)
	ListIncoming_           func(rr RepoRevSpec, opt *DeltaListIncomingOptions) ([]*Delta, Response, error)
}

type MockIssuesService struct {
	Get_           func(issue IssueSpec, opt *IssueGetOptions) (*Issue, Response, error)
	ListByRepo_    func(repo RepoSpec, opt *IssueListOptions) ([]*Issue, Response, error)
	ListComments_  func(issue IssueSpec, opt *IssueListCommentsOptions) ([]*IssueComment, Response, error)
	CreateComment_ func(issue IssueSpec, comment *IssueComment) (*IssueComment, Response, error)
	EditComment_   func(issue IssueSpec, comment *IssueComment) (*IssueComment, Response, error)
	DeleteComment_ func(issue IssueSpec, commentID int) (Response, error)
}

type MockMarkdownService struct {
	Render_ func(markdown []byte, opt MarkdownOpt) (*MarkdownData, Response, error)
}

type MockOrgsService struct {
	Get_            func(org OrgSpec) (*Org, Response, error)
	ListMembers_    func(org OrgSpec, opt *OrgListMembersOptions) ([]*User, Response, error)
	GetSettings_    func(org OrgSpec) (*OrgSettings, Response, error)
	UpdateSettings_ func(org OrgSpec, settings OrgSettings) (Response, error)
}

type MockPeopleService struct {
	Get_ func(person PersonSpec) (*Person, Response, error)
}

type MockPullRequestsService struct {
	Get_           func(pull PullRequestSpec, opt *PullRequestGetOptions) (*PullRequest, Response, error)
	ListByRepo_    func(repo RepoSpec, opt *PullRequestListOptions) ([]*PullRequest, Response, error)
	ListComments_  func(pull PullRequestSpec, opt *PullRequestListCommentsOptions) ([]*PullRequestComment, Response, error)
	CreateComment_ func(pull PullRequestSpec, comment *PullRequestComment) (*PullRequestComment, Response, error)
	EditComment_   func(pull PullRequestSpec, comment *PullRequestComment) (*PullRequestComment, Response, error)
	DeleteComment_ func(pull PullRequestSpec, commentID int) (Response, error)
	Merge_         func(pull PullRequestSpec, mergeRequest *PullRequestMergeRequest) (*PullRequestMergeResult, Response, error)
}

type MockRepoTreeService struct {
	Get_    func(entry TreeEntrySpec, opt *RepoTreeGetOptions) (*TreeEntry, Response, error)
	Search_ func(RepoRevSpec, *RepoTreeSearchOptions) ([]*vcs.SearchResult, Response, error)
}

type MockReposService struct {
	Get_               func(repo RepoSpec, opt *RepoGetOptions) (*Repo, Response, error)
	GetStats_          func(repo RepoRevSpec) (RepoStats, Response, error)
	GetCombinedStatus_ func(spec RepoRevSpec) (*CombinedStatus, Response, error)
	CreateStatus_      func(spec RepoRevSpec, st RepoStatus) (*RepoStatus, Response, error)
	GetOrCreate_       func(repo RepoSpec, opt *RepoGetOptions) (*Repo, Response, error)
	GetSettings_       func(repo RepoSpec) (*RepoSettings, Response, error)
	UpdateSettings_    func(repo RepoSpec, settings RepoSettings) (Response, error)
	RefreshProfile_    func(repo RepoSpec) (Response, error)
	RefreshVCSData_    func(repo RepoSpec) (Response, error)
	ComputeStats_      func(repo RepoRevSpec) (Response, error)
	GetBuild_          func(repo RepoRevSpec, opt *RepoGetBuildOptions) (*RepoBuildInfo, Response, error)
	Create_            func(newRepoSpec NewRepoSpec) (*Repo, Response, error)
	GetReadme_         func(repo RepoRevSpec) (*vcsclient.TreeEntry, Response, error)
	List_              func(opt *RepoListOptions) ([]*Repo, Response, error)
	ListCommits_       func(repo RepoSpec, opt *RepoListCommitsOptions) ([]*Commit, Response, error)
	GetCommit_         func(rev RepoRevSpec, opt *RepoGetCommitOptions) (*Commit, Response, error)
	ListBranches_      func(repo RepoSpec, opt *RepoListBranchesOptions) ([]*vcs.Branch, Response, error)
	ListTags_          func(repo RepoSpec, opt *RepoListTagsOptions) ([]*vcs.Tag, Response, error)
	ListBadges_        func(repo RepoSpec) ([]*Badge, Response, error)
	ListCounters_      func(repo RepoSpec) ([]*Counter, Response, error)
	ListAuthors_       func(repo RepoRevSpec, opt *RepoListAuthorsOptions) ([]*AugmentedRepoAuthor, Response, error)
	ListClients_       func(repo RepoSpec, opt *RepoListClientsOptions) ([]*AugmentedRepoClient, Response, error)
	ListDependencies_  func(repo RepoRevSpec, opt *RepoListDependenciesOptions) ([]*AugmentedRepoDependency, Response, error)
	ListDependents_    func(repo RepoSpec, opt *RepoListDependentsOptions) ([]*AugmentedRepoDependent, Response, error)
	ListByContributor_ func(user UserSpec, opt *RepoListByContributorOptions) ([]*AugmentedRepoContribution, Response, error)
	ListByClient_      func(user UserSpec, opt *RepoListByClientOptions) ([]*AugmentedRepoUsageByClient, Response, error)
	ListByRefdAuthor_  func(user UserSpec, opt *RepoListByRefdAuthorOptions) ([]*AugmentedRepoUsageOfAuthor, Response, error)
}

type MockResponse struct{}

type MockSearchService struct {
	Search_   func(opt *SearchOptions) (*SearchResults, Response, error)
	Complete_ func(q RawQuery) (*Completions, Response, error)
	Suggest_  func(q RawQuery) ([]*Suggestion, Response, error)
}

type MockUnitsService struct {
	Get_  func(spec UnitSpec) (*unit.RepoSourceUnit, Response, error)
	List_ func(opt *UnitListOptions) ([]*unit.RepoSourceUnit, Response, error)
}

type MockUsersService struct {
	Get_                   func(user UserSpec, opt *UserGetOptions) (*User, Response, error)
	GetSettings_           func(user UserSpec) (*UserSettings, Response, error)
	UpdateSettings_        func(user UserSpec, settings UserSettings) (Response, error)
	ListEmails_            func(user UserSpec) ([]*EmailAddr, Response, error)
	GetOrCreateFromGitHub_ func(user GitHubUserSpec, opt *UserGetOptions) (*User, Response, error)
	RefreshProfile_        func(userSpec UserSpec) (Response, error)
	ComputeStats_          func(userSpec UserSpec) (Response, error)
	List_                  func(opt *UsersListOptions) ([]*User, Response, error)
	ListAuthors_           func(user UserSpec, opt *UsersListAuthorsOptions) ([]*AugmentedPersonUsageByClient, Response, error)
	ListClients_           func(user UserSpec, opt *UsersListClientsOptions) ([]*AugmentedPersonUsageOfAuthor, Response, error)
	ListOrgs_              func(member UserSpec, opt *UsersListOrgsOptions) ([]*Org, Response, error)
}

type NewRepoSpec struct {
	Type        string
	CloneURLStr string `json:"CloneURL"`
}

type Org struct {
	User
}

type OrgListMembersOptions struct {
	ListOptions
}

type OrgSettings struct {
	PlanSettings `json:",omitempty"`
}

type OrgSpec struct {
	Org string // name of organization
	UID int    // user ID of the "user" record for this organization
}

type OrgsService interface {
	// Get fetches an organization.
	Get(org OrgSpec) (*Org, Response, error)

	// ListMembers lists members of an organization.
	ListMembers(org OrgSpec, opt *OrgListMembersOptions) ([]*User, Response, error)

	// GetSettings fetches an org's configuration settings.
	GetSettings(org OrgSpec) (*OrgSettings, Response, error)

	// UpdateSettings updates an org's configuration settings.
	UpdateSettings(org OrgSpec, settings OrgSettings) (Response, error)
}

type PeopleService interface {
	// Get gets a person. If an email is provided and it resolves to a
	// registered user, information about that user is
	// returned. Otherwise a transient person is created and returned.
	Get(person PersonSpec) (*Person, Response, error)
}

type Person struct {
	// PersonSpec is an identifier for the person. If the person was
	// resolved to a user, then both Login and UID are set. Otherwise
	// only Email is set, and it may be obfuscated (to protect
	// privacy).
	PersonSpec

	// FullName is the (possibly empty) full name of the person.
	FullName string

	// AvatarURL is the URL to the user's avatar image.
	AvatarURL string
}

type PersonSpec struct {
	// Email is a person's email address. It may be obfuscated (to
	// protect privacy).
	Email string

	// Login is a user's login.
	Login string

	// UID is a user's UID.
	UID int
}

type PersonStatType string

type PersonStats map[PersonStatType]int

type PersonUsageByClient struct {
	AuthorUID   nnz.Int    `db:"author_uid"`
	AuthorEmail nnz.String `db:"author_email"`
	RefCount    int        `db:"ref_count"`
}

type PersonUsageOfAuthor struct {
	ClientUID   nnz.Int    `db:"client_uid"`
	ClientEmail nnz.String `db:"client_email"`
	RefCount    int        `db:"ref_count"`
}

type Plan struct {
	Repos *RepoListOptions
	Defs  *DefListOptions
	Users *UsersListOptions

	Tree *RepoTreeSearchOptions

	// TreeRepoRevs constrains the Tree search results to a set of
	// repository revisions (given by their URIs plus an optional "@"
	// and a revision specifier). For example, "repo.com/foo@revspec".
	//
	// TODO(sqs): gorilla/schema does not respect ",comma" and it has
	// no similar option, so specifying multiple repo revs here does
	// NOT work.
	TreeRepoRevs []string `url:",omitempty,comma" json:",omitempty"`
}

type PlanSettings struct {
	PlanID *string `json:",omitempty"`
}

type PullRequest struct {
	github.PullRequest

	// Checklist is a summary of all the checkboxes in the pull request (number of checked and unchecked).
	Checklist *Checklist `json:",omitempty"`
}

type PullRequestComment struct {
	github.PullRequestComment

	// Published is whether the comment is in a published state, currently always true.
	Published bool

	// RenderedBody is the comment body rendered as HTML (from raw markdown).
	RenderedBody string

	// Checklist is a summary of all the checkboxes in the comment (number of checked and unchecked).
	Checklist *Checklist
}

type PullRequestCommentSpec struct {
	Pull    PullRequestSpec
	Comment int
}

type PullRequestGetOptions struct {
	// Checklist is whether to populate the Checklist field on the returned PullRequest.
	Checklist bool
}

type PullRequestListCommentsOptions struct {
	ListOptions
}

type PullRequestListOptions struct {
	State string `url:",omitempty"` // "open", "closed", or "all"
	ListOptions
}

type PullRequestMergeRequest struct {
	CommitMessage string
}

type PullRequestMergeResult struct {
	github.PullRequestMergeResult
}

type PullRequestSpec struct {
	Repo RepoSpec // the base repository of the pull request

	Number int // Sequence number of the pull request
}

type PullRequestsService interface {
	// Get fetches a pull request.
	Get(pull PullRequestSpec, opt *PullRequestGetOptions) (*PullRequest, Response, error)

	// List pull requests for a repository.
	ListByRepo(repo RepoSpec, opt *PullRequestListOptions) ([]*PullRequest, Response, error)

	// ListComments lists comments on a pull request.
	ListComments(pull PullRequestSpec, opt *PullRequestListCommentsOptions) ([]*PullRequestComment, Response, error)

	// CreateComment creates a comment on a pull request.
	CreateComment(pull PullRequestSpec, comment *PullRequestComment) (*PullRequestComment, Response, error)

	// EditComment updates an existing comment on a pull request.
	EditComment(pull PullRequestSpec, comment *PullRequestComment) (*PullRequestComment, Response, error)

	// DeleteComment deletes a comment on a pull request.
	DeleteComment(pull PullRequestSpec, commentID int) (Response, error)

	// Merge merges a pull request
	Merge(pull PullRequestSpec, mergeRequest *PullRequestMergeRequest) (*PullRequestMergeResult, Response, error)
}

type QualFormatStrings struct {
	Unqualified             string `json:",omitempty"`
	ScopeQualified          string `json:",omitempty"`
	DepQualified            string `json:",omitempty"`
	RepositoryWideQualified string `json:",omitempty"`
	LanguageWideQualified   string `json:",omitempty"`
}

type Range struct {
	Start, End int
}

type RawQuery struct {
	// String is the raw query string from the client.
	String string

	// InsertionPoint is the 0-indexed character offset of the text
	// insertion cursor on the client.
	InsertionPoint int
}

type Ref struct {
	graph.Ref
	Authorship *AuthorshipInfo
}

type Refs []*Ref

type Repo struct {
	// RID is the numeric primary key for a repository.
	RID int

	// URI is a normalized identifier for this repository based on its primary
	// clone URL. E.g., "github.com/user/repo".
	URI string

	// URIAlias is another URI that, if accessed, will redirect to
	// this repository's primary URI. It's used, for example, to
	// redirect from GitHub repos to their canonical URI (such as Go
	// repos on gopkg.in).
	URIAlias nnz.String `db:"uri_alias"`

	// Name is the base name (the final path component) of the repository,
	// typically the name of the directory that the repository would be cloned
	// into. (For example, for git://example.com/foo.git, the name is "foo".)
	Name string

	// OwnerUserID is the account that owns this repository.
	OwnerUserID int `db:"owner_user_id"`

	// OwnerGitHubUserID is the GitHub user ID of this repository's owner, if this
	// is a GitHub repository.
	OwnerGitHubUserID nnz.Int `db:"owner_github_user_id" json:",omitempty"`

	// Description is a brief description of the repository.
	Description string `json:",omitempty"`

	// VCS is the short name of the VCS system that this repository uses: "git"
	// or "hg".
	VCS string `db:"vcs"`

	// HTTPCloneURL is the HTTPS clone URL of the repository (or the
	// HTTP clone URL, if no HTTPS clone URL is available).
	HTTPCloneURL string `db:"http_clone_url"`

	// SSHCloneURL is the SSH clone URL if the repository, if any.
	SSHCloneURL nnz.String `db:"ssh_clone_url"`

	// HomepageURL is the URL to the repository's homepage, if any.
	HomepageURL nnz.String `db:"homepage_url"`

	// DefaultBranch is the default VCS branch used (typically "master" for git
	// repositories and "default" for hg repositories).
	DefaultBranch string `db:"default_branch"`

	// Language is the primary programming language used in this repository.
	Language string

	// GitHubStars is the number of stargazers this repository has on GitHub (or
	// 0 if it is not a GitHub repository).
	GitHubStars int `db:"github_stars"`

	// GitHubID is the GitHub ID of this repository. If a GitHub repository is
	// renamed, the ID remains the same and should be used to resolve across the
	// name change.
	GitHubID nnz.Int `db:"github_id" json:",omitempty"`

	// Disabled is whether this repo should not be downloaded and processed by the worker.
	Disabled bool `json:",omitempty"`

	// Deprecated repositories are labeled as such and hidden from global search results.
	Deprecated bool

	// Fork is whether this repository is a fork.
	Fork bool

	// Mirror is whether this repository is a mirror.
	Mirror bool

	// Private is whether this repository is private.
	Private bool

	// CreatedAt is when this repository was created. If it represents
	// an externally hosted (e.g., GitHub) repository, the creation
	// date is when it was created at that origin.
	CreatedAt time.Time `db:"created_at"`

	// UpdatedAt is when this repository's metadata was last updated
	// (on its origin if it's an externally hosted repository).
	UpdatedAt time.Time `db:"updated_at"`

	// PushedAt is when this repository's was last (VCS-)pushed to.
	PushedAt time.Time `db:"pushed_at"`

	// Stat holds repository statistics. It's only filled in if Repo{Get,List}Options has Stats == true.
	Stat RepoStats `db:"-" json:",omitempty"`

	// Permissions describes the permissions that the current user (or
	// anonymous users, if there is no current user) is granted to
	// this repository.
	Permissions RepoPermissions `db:"-"`
}

type RepoAuthor struct {
	UID   nnz.Int
	Email nnz.String
	AuthorStats
}

type RepoBuildInfo struct {
	Exact *Build // the newest build, if any, that exactly matches the revspec (can be same as LastSuccessful)

	LastSuccessful *Build // the last successful build of a commit ID reachable from the revspec (can be same as Exact)

	CommitsBehind        int     // the number of commits between the revspec and the commit of the LastSuccessful build
	LastSuccessfulCommit *Commit // the commit of the LastSuccessful build
}

type RepoClient struct {
	UID   nnz.Int
	Email nnz.String
	ClientStats
}

type RepoContribution struct {
	RepoURI string `db:"repo"`
	AuthorStats
}

type RepoDependency struct {
	ToRepo string `db:"to_repo"`
}

type RepoDependent struct {
	FromRepo string `db:"from_repo"`
}

type RepoGetBuildOptions struct {
	// Exact is whether only a build whose commit ID exactly matches
	// the revspec should be returned. (For non-full-commit ID
	// revspecs, such as branches, tags, and partial commit IDs, this
	// means that the build's commit ID matches the resolved revspec's
	// commit ID.)
	//
	// If Exact is false, then builds for older commits that are
	// reachable from the revspec may also be returned. For example,
	// if there's a build for master~1 but no build for master, and
	// your revspec is master, using Exact=false will return the build
	// for master~1.
	//
	// Using Exact=true is faster as the commit and build history
	// never needs to be searched. If the exact build is not
	// found, or the exact build was found but it failed,
	// LastSuccessful and LastSuccessfulCommit for RepoBuildInfo
	// will be nil.
	Exact bool `url:",omitempty" json:",omitempty"`
}

type RepoGetCommitOptions struct {
}

type RepoGetOptions struct {
	Stats bool `url:",omitempty" json:",omitempty"` // whether to fetch and include stats in the returned repository
}

type RepoListAuthorsOptions struct {
	ListOptions
}

type RepoListBranchesOptions struct {
	ListOptions
}

type RepoListByClientOptions struct {
	ListOptions
}

type RepoListByContributorOptions struct {
	NoFork bool
	ListOptions
}

type RepoListByRefdAuthorOptions struct {
	ListOptions
}

type RepoListClientsOptions struct {
	ListOptions
}

type RepoListCommitsOptions struct {
	Head string `url:",omitempty" json:",omitempty"`
	Base string `url:",omitempty" json:",omitempty"`
	ListOptions
}

type RepoListDependenciesOptions struct {
	ListOptions
}

type RepoListDependentsOptions struct{ ListOptions }

type RepoListOptions struct {
	Name string `url:",omitempty" json:",omitempty"`

	// Specifies a search query for repositories. If specified, then the Sort and Direction options are ignored
	Query string `url:",omitempty" json:",omitempty"`

	URIs []string `url:",comma,omitempty" json:",omitempty"`

	BuiltOnly bool `url:",omitempty" json:",omitempty"`

	Sort      string `url:",omitempty" json:",omitempty"`
	Direction string `url:",omitempty" json:",omitempty"`

	NoFork bool `url:",omitempty" json:",omitempty"`

	Type string `url:",omitempty" json:",omitempty"` // "public" or "private" (empty default means "all")

	State string `url:",omitempty" json:",omitempty"` // "enabled" or "disabled" (empty default means return "all")

	Owner string `url:",omitempty" json:",omitempty"`

	Stats bool `url:",omitempty" json:",omitempty"` // whether to fetch and include stats in the returned repositories

	ListOptions
}

type RepoListTagsOptions struct {
	ListOptions
}

type RepoPermissions struct {
	Read  bool
	Write bool
	Admin bool
}

type RepoRevSpec struct {
	RepoSpec        // repository URI or RID
	Rev      string // the abstract/unresolved revspec, such as a branch name or abbreviated commit ID
	CommitID string // the full commit ID that Rev resolves to
}

type RepoSettings struct {
	// Enabled is whether this repository has been enabled for use on
	// Sourcegraph by a repository owner or a site admin.
	Enabled *bool `db:"enabled" json:",omitempty"`

	// BuildPushes is whether head commits on newly pushed branches
	// should be automatically built.
	BuildPushes *bool `db:"build_pushes" json:",omitempty"`

	// ExternalCommitStatuses is whether the build status
	// (pending/failure/success) of each commit should be published to
	// GitHub using the repo status API
	// (https://developer.github.com/v3/repos/statuses/).
	//
	// This behavior is also subject to the
	// UnsuccessfulExternalCommitStatuses setting value.
	ExternalCommitStatuses *bool `db:"external_commit_statuses" json:",omitempty"`

	// UnsuccessfulExternalCommitStatuses, if true, indicates that
	// pending/failure commit statuses should be published to
	// GitHub. If false (default), only successful commit status are
	// published. The default of false avoids bothersome warning
	// messages and UI pollution in case the Sourcegraph build
	// fails. Until our builds are highly reliable, a Sourcegraph
	// build failure is not necessarily an indication of a problem
	// with the repository.
	//
	// This setting is only meaningful if ExternalCommitStatuses is
	// true.
	UnsuccessfulExternalCommitStatuses *bool `db:"unsuccessful_external_commit_statuses" json:",omitempty"`

	// UseSSHPrivateKey is whether Sourcegraph should clone and update
	// the repository using an SSH key, and whether it should copy the
	// corresponding public key to the repository's origin host as an
	// authorized key. It is only necessary for private repositories
	// and for write operations on public repositories.
	UseSSHPrivateKey *bool `db:"use_ssh_private_key" json:",omitempty"`
}

type RepoSpec struct {
	URI string
	RID int
}

type RepoStatType string

type RepoStats map[RepoStatType]int

type RepoStatus struct {
	github.RepoStatus
}

type RepoToken struct {
	URI string

	Repo *Repo `json:",omitempty"`
}

type RepoTreeGetOptions struct {
	// Formatted is whether the specified entry, if it's a file, should have its
	// Contents code-formatted using HTML.
	Formatted bool

	// HighlightStrings is a list of fixed strings that should be
	// wrapped in a <span class="highlight"> in the returned HTML. It
	// only takes effect if Formatted is true.
	HighlightStrings []string

	// TokenizedSource requests that the source code be returned as a tokenized data
	// structure rather than an (annotated) string.
	//
	// This is useful when the client wants to take full control of rendering and manipulating
	// the contents.
	TokenizedSource bool `url:",omitempty"`

	ContentsAsString bool `url:",omitempty"`

	vcsclient.GetFileOptions
}

type RepoTreeSearchOptions struct {
	vcs.SearchOptions
	Formatted bool
}

type RepoTreeSearchResult struct {
	vcs.SearchResult
	RepoRev RepoRevSpec
}

type RepoTreeService interface {
	Get(entry TreeEntrySpec, opt *RepoTreeGetOptions) (*TreeEntry, Response, error)
	Search(RepoRevSpec, *RepoTreeSearchOptions) ([]*vcs.SearchResult, Response, error)
}

type RepoUsageByClient struct {
	// DefRepo is the repository that defines the code that was referenced.
	// It's called DefRepo because "Repo" usually refers to the repository
	// whose analysis created this linkage (i.e., the repository that contains
	// the reference).
	DefRepo string `db:"def_repo"`

	RefCount int `db:"ref_count"`

	AuthorshipInfo
}

type RepoUsageOfAuthor struct {
	Repo string

	RefCount int `db:"ref_count"`
}

type Repos []*Repo

type ReposService interface {
	// Get fetches a repository.
	Get(repo RepoSpec, opt *RepoGetOptions) (*Repo, Response, error)

	// GetStats gets statistics about a repository at a specific
	// commit. Some statistics are per-commit and some are global to
	// the repository. If you only care about global repository
	// statistics, pass an empty Rev to the RepoRevSpec (which will be
	// resolved to the repository's default branch).
	GetStats(repo RepoRevSpec) (RepoStats, Response, error)

	// CreateStatus creates a repository status for the given commit.
	CreateStatus(spec RepoRevSpec, st RepoStatus) (*RepoStatus, Response, error)

	// GetCombinedStatus fetches the combined repository status for
	// the given commit.
	GetCombinedStatus(spec RepoRevSpec) (*CombinedStatus, Response, error)

	// GetOrCreate fetches a repository using Get. If no such repository exists
	// with the URI, and the URI refers to a recognized repository host (such as
	// github.com), the repository's information is fetched from the external
	// host and the repository is created.
	GetOrCreate(repo RepoSpec, opt *RepoGetOptions) (*Repo, Response, error)

	// GetSettings fetches a repository's configuration settings.
	GetSettings(repo RepoSpec) (*RepoSettings, Response, error)

	// UpdateSettings updates a repository's configuration settings.
	UpdateSettings(repo RepoSpec, settings RepoSettings) (Response, error)

	// RefreshProfile updates the repository metadata for a repository, fetching
	// it from an external host if the host is recognized (such as GitHub).
	//
	// This operation is performed asynchronously on the server side (after
	// receiving the request) and the API currently has no way of notifying
	// callers when the operation completes.
	RefreshProfile(repo RepoSpec) (Response, error)

	// RefreshVCSData updates the repository VCS (git/hg) data, fetching all new
	// commits, branches, tags, and blobs.
	//
	// This operation is performed asynchronously on the server side (after
	// receiving the request) and the API currently has no way of notifying
	// callers when the operation completes.
	RefreshVCSData(repo RepoSpec) (Response, error)

	// ComputeStats updates the statistics about a repository.
	//
	// This operation is performed asynchronously on the server side (after
	// receiving the request) and the API currently has no way of notifying
	// callers when the operation completes.
	ComputeStats(repo RepoRevSpec) (Response, error)

	// GetBuild gets the build for a specific revspec. It returns
	// additional information about the build, such as whether it is
	// exactly up-to-date with the revspec or a few commits behind the
	// revspec. The opt param controls what is returned in this case.
	GetBuild(repo RepoRevSpec, opt *RepoGetBuildOptions) (*RepoBuildInfo, Response, error)

	// Create adds the repository at cloneURL, filling in all information about
	// the repository that can be inferred from the URL (or, for GitHub
	// repositories, fetched from the GitHub API). If a repository with the
	// specified clone URL, or the same URI, already exists, it is returned.
	Create(newRepoSpec NewRepoSpec) (*Repo, Response, error)

	// GetReadme fetches the formatted README file for a repository.
	GetReadme(repo RepoRevSpec) (*vcsclient.TreeEntry, Response, error)

	// List repositories.
	List(opt *RepoListOptions) ([]*Repo, Response, error)

	// List commits.
	ListCommits(repo RepoSpec, opt *RepoListCommitsOptions) ([]*Commit, Response, error)

	// GetCommit gets a commit.
	GetCommit(rev RepoRevSpec, opt *RepoGetCommitOptions) (*Commit, Response, error)

	// ListBranches lists a repository's branches.
	ListBranches(repo RepoSpec, opt *RepoListBranchesOptions) ([]*vcs.Branch, Response, error)

	// ListTags lists a repository's tags.
	ListTags(repo RepoSpec, opt *RepoListTagsOptions) ([]*vcs.Tag, Response, error)

	// ListBadges lists the available badges for repo.
	ListBadges(repo RepoSpec) ([]*Badge, Response, error)

	// ListCounters lists the available counters for repo.
	ListCounters(repo RepoSpec) ([]*Counter, Response, error)

	// ListAuthors lists people who have contributed (i.e., committed) code to
	// repo.
	ListAuthors(repo RepoRevSpec, opt *RepoListAuthorsOptions) ([]*AugmentedRepoAuthor, Response, error)

	// ListClients lists people who reference defs defined in repo.
	ListClients(repo RepoSpec, opt *RepoListClientsOptions) ([]*AugmentedRepoClient, Response, error)

	// ListDependents lists repositories that contain defs referenced by
	// repo.
	ListDependencies(repo RepoRevSpec, opt *RepoListDependenciesOptions) ([]*AugmentedRepoDependency, Response, error)

	// ListDependents lists repositories that reference defs defined in repo.
	ListDependents(repo RepoSpec, opt *RepoListDependentsOptions) ([]*AugmentedRepoDependent, Response, error)

	// ListByContributor lists repositories that user has contributed (i.e.,
	// committed) code to.
	ListByContributor(user UserSpec, opt *RepoListByContributorOptions) ([]*AugmentedRepoContribution, Response, error)

	// ListByClient lists repositories that contain defs referenced by
	// user.
	ListByClient(user UserSpec, opt *RepoListByClientOptions) ([]*AugmentedRepoUsageByClient, Response, error)

	// ListByRefdAuthor lists repositories that reference code authored by
	// user.
	ListByRefdAuthor(user UserSpec, opt *RepoListByRefdAuthorOptions) ([]*AugmentedRepoUsageOfAuthor, Response, error)
}

type ResolvedQuery struct {
	// Tokens are resolved tokens, each of whose meaning is
	// unambiguous.
	Tokens []Token
}

type Response interface {
	// TotalCount is the total number of items in the resource or result set
	// that exist remotely. Only a portion of the total may be in the response
	// body. If the endpoint did not return a total count, then TotalCount
	// returns -1.
	TotalCount() int
}

type RevToken struct {
	Rev string // Rev is either a revspec or commit ID

	Commit *Commit `json:",omitempty"`
}

type SearchOptions struct {
	Query string `url:"q" schema:"q"`

	Defs   bool
	Repos  bool
	People bool
	Tree   bool

	ListOptions
}

type SearchResults struct {
	Defs   []*Def                  `json:",omitempty"`
	People []*Person               `json:",omitempty"`
	Repos  []*Repo                 `json:",omitempty"`
	Tree   []*RepoTreeSearchResult `json:",omitempty"`

	// RawQuery is the raw query passed to search.
	RawQuery RawQuery

	// Tokens are the unresolved tokens.
	Tokens Tokens `json:",omitempty"`

	// Plan is the query plan used to fetch the results.
	Plan *Plan `json:",omitempty"`

	// ResolvedTokens holds the resolved tokens from the original query
	// string.
	ResolvedTokens Tokens

	ResolveErrors []TokenError `json:",omitempty"`

	// Tips are helpful tips for the user about their query. They are
	// not errors per se, but they use the TokenError type because it
	// allows us to associate a message with a particular token (and
	// JSON de/serialize that).
	Tips []TokenError `json:",omitempty"`

	// Canceled is true if the query was canceled. More information
	// about how to correct the issue can be found in the
	// ResolveErrors and Tips.
	Canceled bool
}

type SearchService interface {
	// Search searches the full index.
	Search(opt *SearchOptions) (*SearchResults, Response, error)

	// Complete completes the token at the RawQuery's InsertionPoint.
	Complete(q RawQuery) (*Completions, Response, error)

	// Suggest suggests queries given an existing query. It can be
	// called with an empty query to get example queries that pertain
	// to the current user's repositories, orgs, etc.
	Suggest(q RawQuery) ([]*Suggestion, Response, error)
}