discovery

type Observation struct {
	Identity  string    `json:"-"`
	Number    int       `json:"number"`
	HeadSHA   string    `json:"head_sha"`
	Title     string    `json:"title"`
	State     string    `json:"state"`
	Draft     bool      `json:"draft"`
	FetchedAt time.Time `json:"fetched_at"`
	Checks    string    `json:"checks"`
}

type PullRequest struct {
	Repository string `json:"repository"`
	Number     int    `json:"number"`
	HeadSHA    string `json:"head_sha"`
	// HeadRef is the head branch's name, which links a local session on that
	// branch to the pull request. It is empty in a snapshot cached before it
	// was kept, until the next poll.
	HeadRef string `json:"head_ref"`
	// HeadRepository is the canonical host/repository owning the head branch.
	HeadRepository string `json:"head_repository,omitempty"`
	// BaseRef is the base branch's name; a pull request whose base is
	// another open pull request's head branch is stacked on it. Empty in a
	// snapshot cached before it was kept, until the next poll.
	BaseRef string `json:"base_ref"`
	// Additions, Deletions and ChangedFiles size the change as GitHub counts
	// it. They are zero in a snapshot cached before they were kept, until the
	// next poll.
	Additions    int    `json:"additions"`
	Deletions    int    `json:"deletions"`
	ChangedFiles int    `json:"changed_files"`
	Title        string `json:"title"`
	URL          string `json:"url"`
	Author       string `json:"author"`
	// AuthorBot is true for a GitHub App or other bot author. Snapshots cached
	// before it existed decode as false.
	AuthorBot             bool   `json:"author_bot"`
	State                 string `json:"state"`
	Draft                 bool   `json:"draft"`
	Fork                  bool   `json:"fork"`
	AuthoredByMe          bool   `json:"authored_by_me"`
	ReviewRequestedFromMe bool   `json:"review_requested_from_me"`
	// AssignedToMe is true when the viewer is one of the first 20 assignees.
	// Snapshots cached before it existed decode as false.
	AssignedToMe bool `json:"assigned_to_me"`
	// Nil means the token could not establish repository write permission.
	AuthorHasWrite *bool `json:"author_has_write"`
	// ViewerCanPush is whether the signed-in account may push to the
	// repository (GitHub's viewerPermission is write, maintain or admin),
	// which a fix needs; nil when GitHub did not say.
	ViewerCanPush *bool `json:"viewer_can_push"`
	// False means team membership was unavailable; false review-request flags
	// must not be interpreted as proof that no team requested this viewer.
	TeamMembershipKnown bool   `json:"team_membership_known"`
	Review              string `json:"review"`
	Checks              string `json:"checks"`
	Merge               string `json:"merge"`
	// Behind is GitHub's report (mergeStateStatus BEHIND) that the head
	// branch is out of date with its base and not conflicting, which Update
	// branch fixes. A draft never reports it.
	Behind           bool `json:"behind"`
	Unresolved       *int `json:"unresolved"`
	UnresolvedCapped bool `json:"unresolved_capped"`
	// UpdatedAt is GitHub's last update of the pull request: a push, an edit,
	// a review or a comment. The background refresh re-reads a saved review's
	// evidence when it is newer than the last read.
	UpdatedAt time.Time `json:"updated_at,omitzero"`
}

type RateLimit struct {
	Cost      *int      `json:"cost,omitempty"`
	Remaining *int      `json:"remaining"`
	Reset     time.Time `json:"reset"`
	RetryAt   time.Time `json:"retry_at"`
}

type Service struct {

	// Updated, when set before use, is called after anything Cached reads
	// changes: a cache write, or live freshness. It may run with the
	// service's locks held, so it must not call the service.
	Updated func()
	// contains filtered or unexported fields
}

type Snapshot struct {
	Epoch        uint64        `json:"-"`
	Repository   string        `json:"repository"`
	Observations []Observation `json:"observations,omitempty"`
	Viewer       string        `json:"viewer"`
	PullRequests []PullRequest `json:"pull_requests"`
	Stale        bool          `json:"stale"`
	FetchedAt    time.Time     `json:"fetched_at"`
	NextPoll     time.Time     `json:"next_poll"`
	Rate         RateLimit     `json:"rate"`
	Error        string        `json:"error,omitempty"`
	// Settling: this poll found a new head or a mergeability GitHub forgot,
	// or GitHub still works one out since, so NextPoll comes after
	// settleInterval.
	Settling bool `json:"settling,omitempty"`
}