Help us shape the future of Go! Take the 2026 Go Developer Survey

api

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 18, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, m ServeMux) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, m ServeMux, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

Types

type Activity added in v0.6.0

type Activity struct {
	// From The period's first day, YYYY-MM-DD.
	From openapi_types.Date `json:"from"`

	// PostLength How long the summary's text is once rendered for the messaging service set up, as that service measures it, against the most it takes. Left out where no messaging is set up, or where the service names no limit (a plain webhook). A post longer than the limit is refused with too_long, and nothing is sent.
	PostLength *PostLength `json:"post_length,omitempty"`

	// Sources Each source asked, in a fixed order, and how its read went.
	Sources []ActivitySource `json:"sources"`

	// Text The summary as Markdown, ready to copy.
	Text string `json:"text"`

	// To The period's last day, YYYY-MM-DD.
	To openapi_types.Date `json:"to"`

	// Today The day it is where the server runs, YYYY-MM-DD, so a later period is not offered.
	Today openapi_types.Date `json:"today"`
	Years []ActivityYear     `json:"years"`
}

Activity defines model for Activity.

type ActivityDay added in v0.6.0

type ActivityDay struct {
	// Date The day, YYYY-MM-DD.
	Date  string         `json:"date"`
	Hours []ActivityHour `json:"hours"`

	// Weekday The day of the week, such as Friday.
	Weekday string `json:"weekday"`
}

ActivityDay defines model for ActivityDay.

type ActivityHour added in v0.6.0

type ActivityHour struct {
	Items []ActivityItem `json:"items"`

	// Label The hour as the clock showed it, such as 09:00, with its zone added when the clocks showed it twice that day.
	Label string `json:"label"`
}

ActivityHour defines model for ActivityHour.

type ActivityItem added in v0.6.0

type ActivityItem struct {
	At time.Time `json:"at"`

	// Ref What it was done to, such as a commit's hash, PROJ-412 or o/r#42.
	Ref        string `json:"ref"`
	Repository string `json:"repository"`

	// Source A place work leaves a trace.
	Source ActivitySourceName `json:"source"`
	Title  string             `json:"title"`

	// URL A link to it, or empty where there is none.
	URL string `json:"url"`

	// Verb What was done, such as "committed" or "moved".
	Verb string `json:"verb"`
}

ActivityItem defines model for ActivityItem.

type ActivityMonth added in v0.6.0

type ActivityMonth struct {
	Days  []ActivityDay `json:"days"`
	Month int           `json:"month"`

	// Name The month's name, such as October.
	Name string `json:"name"`
}

ActivityMonth defines model for ActivityMonth.

type ActivityPost added in v0.7.0

type ActivityPost struct {
	// Channel The channel it was posted to, or empty for a webhook's own channel.
	Channel string `json:"channel"`

	// Destination Where it went, in words: the channel, or the channel its webhook is bound to.
	Destination string `json:"destination"`

	// From The period's first day, YYYY-MM-DD.
	From openapi_types.Date `json:"from"`

	// Text The Markdown posted, before it was rendered for the service.
	Text string `json:"text"`

	// To The period's last day, YYYY-MM-DD.
	To openapi_types.Date `json:"to"`
}

ActivityPost A Summary as it was posted.

type ActivityPostRequest added in v0.7.0

type ActivityPostRequest struct {
	// Channel The channel to post to; empty or left out uses the configured channel or the webhook.
	Channel *string `json:"channel,omitempty"`

	// From The period's first day, YYYY-MM-DD.
	From openapi_types.Date `json:"from"`

	// Text The Summary's Markdown, as GET /api/activity wrote it or as it was edited.
	Text string `json:"text"`

	// To The period's last day, YYYY-MM-DD.
	To openapi_types.Date `json:"to"`
}

ActivityPostRequest The period a Summary is of, its Markdown to post, and where.

type ActivitySource added in v0.6.0

type ActivitySource struct {
	// Detail Why the source is not set up and how to set it up, or why it could not be read, in words that never name a host or a path; empty when it was read. When several repositories were read, each that could not be is named in its own clause.
	Detail string `json:"detail"`

	// Name The source as a sentence starts with it, such as "Jira".
	Name string `json:"name"`

	// Source A place work leaves a trace.
	Source ActivitySourceName `json:"source"`

	// State How the source answered: read; not_set_up, when there was nothing set up to ask — no credential, no forge the base remote names, no Taskwarrior installed, no git user.email — so it was left out; or failed, when a source that is set up was asked and could not be read.
	State ActivitySourceState `json:"state"`

	// Truncated The source had more than it gave.
	Truncated bool `json:"truncated"`
}

ActivitySource defines model for ActivitySource.

type ActivitySourceName added in v0.6.0

type ActivitySourceName string

ActivitySourceName A place work leaves a trace.

const (
	ActivitySourceNameForge ActivitySourceName = "forge"
	ActivitySourceNameGit   ActivitySourceName = "git"
	ActivitySourceNameJira  ActivitySourceName = "jira"
	ActivitySourceNameTasks ActivitySourceName = "tasks"
)

Defines values for ActivitySourceName.

func (ActivitySourceName) Valid added in v0.6.0

func (e ActivitySourceName) Valid() bool

Valid indicates whether the value is a known member of the ActivitySourceName enum.

type ActivitySourceState added in v0.7.0

type ActivitySourceState string

ActivitySourceState How the source answered: read; not_set_up, when there was nothing set up to ask — no credential, no forge the base remote names, no Taskwarrior installed, no git user.email — so it was left out; or failed, when a source that is set up was asked and could not be read.

const (
	ActivitySourceStateFailed   ActivitySourceState = "failed"
	ActivitySourceStateNotSetUp ActivitySourceState = "not_set_up"
	ActivitySourceStateRead     ActivitySourceState = "read"
)

Defines values for ActivitySourceState.

func (ActivitySourceState) Valid added in v0.7.0

func (e ActivitySourceState) Valid() bool

Valid indicates whether the value is a known member of the ActivitySourceState enum.

type ActivityYear added in v0.6.0

type ActivityYear struct {
	Months []ActivityMonth `json:"months"`
	Year   int             `json:"year"`
}

ActivityYear defines model for ActivityYear.

type AddComment200JSONResponse added in v0.5.1

type AddComment200JSONResponse Comment

func (AddComment200JSONResponse) VisitAddCommentResponse added in v0.5.1

func (response AddComment200JSONResponse) VisitAddCommentResponse(w http.ResponseWriter) error

type AddComment404ApplicationProblemPlusJSONResponse added in v0.5.1

type AddComment404ApplicationProblemPlusJSONResponse Problem

func (AddComment404ApplicationProblemPlusJSONResponse) VisitAddCommentResponse added in v0.5.1

func (response AddComment404ApplicationProblemPlusJSONResponse) VisitAddCommentResponse(w http.ResponseWriter) error

type AddComment422ApplicationProblemPlusJSONResponse added in v0.5.1

type AddComment422ApplicationProblemPlusJSONResponse Problem

func (AddComment422ApplicationProblemPlusJSONResponse) VisitAddCommentResponse added in v0.5.1

func (response AddComment422ApplicationProblemPlusJSONResponse) VisitAddCommentResponse(w http.ResponseWriter) error

type AddCommentJSONRequestBody added in v0.5.1

type AddCommentJSONRequestBody = CommentRequest

AddCommentJSONRequestBody defines body for AddComment for application/json ContentType.

type AddCommentRequestObject added in v0.5.1

type AddCommentRequestObject struct {
	Key  string `json:"key"`
	Body *AddCommentJSONRequestBody
}

type AddCommentResponseObject added in v0.5.1

type AddCommentResponseObject interface {
	VisitAddCommentResponse(w http.ResponseWriter) error
}

type AddCommentdefaultApplicationProblemPlusJSONResponse added in v0.5.1

type AddCommentdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (AddCommentdefaultApplicationProblemPlusJSONResponse) VisitAddCommentResponse added in v0.5.1

type AddFavorite200JSONResponse added in v0.6.0

type AddFavorite200JSONResponse Repositories

func (AddFavorite200JSONResponse) VisitAddFavoriteResponse added in v0.6.0

func (response AddFavorite200JSONResponse) VisitAddFavoriteResponse(w http.ResponseWriter) error

type AddFavorite422ApplicationProblemPlusJSONResponse added in v0.6.0

type AddFavorite422ApplicationProblemPlusJSONResponse Problem

func (AddFavorite422ApplicationProblemPlusJSONResponse) VisitAddFavoriteResponse added in v0.6.0

func (response AddFavorite422ApplicationProblemPlusJSONResponse) VisitAddFavoriteResponse(w http.ResponseWriter) error

type AddFavoriteJSONRequestBody added in v0.6.0

type AddFavoriteJSONRequestBody = DirectoryChoice

AddFavoriteJSONRequestBody defines body for AddFavorite for application/json ContentType.

type AddFavoriteRequestObject added in v0.6.0

type AddFavoriteRequestObject struct {
	Body *AddFavoriteJSONRequestBody
}

type AddFavoriteResponseObject added in v0.6.0

type AddFavoriteResponseObject interface {
	VisitAddFavoriteResponse(w http.ResponseWriter) error
}

type AddFavoritedefaultApplicationProblemPlusJSONResponse added in v0.6.0

type AddFavoritedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (AddFavoritedefaultApplicationProblemPlusJSONResponse) VisitAddFavoriteResponse added in v0.6.0

type AddTask200JSONResponse added in v0.4.1

type AddTask200JSONResponse TaskList

func (AddTask200JSONResponse) VisitAddTaskResponse added in v0.4.1

func (response AddTask200JSONResponse) VisitAddTaskResponse(w http.ResponseWriter) error

type AddTask422ApplicationProblemPlusJSONResponse added in v0.4.1

type AddTask422ApplicationProblemPlusJSONResponse Problem

func (AddTask422ApplicationProblemPlusJSONResponse) VisitAddTaskResponse added in v0.4.1

func (response AddTask422ApplicationProblemPlusJSONResponse) VisitAddTaskResponse(w http.ResponseWriter) error

type AddTaskJSONRequestBody added in v0.4.1

type AddTaskJSONRequestBody = TaskLine

AddTaskJSONRequestBody defines body for AddTask for application/json ContentType.

type AddTaskRequestObject added in v0.4.1

type AddTaskRequestObject struct {
	Body *AddTaskJSONRequestBody
}

type AddTaskResponseObject added in v0.4.1

type AddTaskResponseObject interface {
	VisitAddTaskResponse(w http.ResponseWriter) error
}

type AddTaskdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type AddTaskdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (AddTaskdefaultApplicationProblemPlusJSONResponse) VisitAddTaskResponse added in v0.4.1

type AnnotateTask200JSONResponse added in v0.4.1

type AnnotateTask200JSONResponse TaskList

func (AnnotateTask200JSONResponse) VisitAnnotateTaskResponse added in v0.4.1

func (response AnnotateTask200JSONResponse) VisitAnnotateTaskResponse(w http.ResponseWriter) error

type AnnotateTask409ApplicationProblemPlusJSONResponse added in v0.4.1

type AnnotateTask409ApplicationProblemPlusJSONResponse Problem

func (AnnotateTask409ApplicationProblemPlusJSONResponse) VisitAnnotateTaskResponse added in v0.4.1

func (response AnnotateTask409ApplicationProblemPlusJSONResponse) VisitAnnotateTaskResponse(w http.ResponseWriter) error

type AnnotateTask422ApplicationProblemPlusJSONResponse added in v0.4.1

type AnnotateTask422ApplicationProblemPlusJSONResponse Problem

func (AnnotateTask422ApplicationProblemPlusJSONResponse) VisitAnnotateTaskResponse added in v0.4.1

func (response AnnotateTask422ApplicationProblemPlusJSONResponse) VisitAnnotateTaskResponse(w http.ResponseWriter) error

type AnnotateTaskJSONRequestBody added in v0.4.1

type AnnotateTaskJSONRequestBody = TaskText

AnnotateTaskJSONRequestBody defines body for AnnotateTask for application/json ContentType.

type AnnotateTaskRequestObject added in v0.4.1

type AnnotateTaskRequestObject struct {
	UUID TaskUUID `json:"uuid"`
	Body *AnnotateTaskJSONRequestBody
}

type AnnotateTaskResponseObject added in v0.4.1

type AnnotateTaskResponseObject interface {
	VisitAnnotateTaskResponse(w http.ResponseWriter) error
}

type AnnotateTaskdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type AnnotateTaskdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (AnnotateTaskdefaultApplicationProblemPlusJSONResponse) VisitAnnotateTaskResponse added in v0.4.1

type Announce200JSONResponse added in v0.0.7

type Announce200JSONResponse Announcement

func (Announce200JSONResponse) VisitAnnounceResponse added in v0.0.7

func (response Announce200JSONResponse) VisitAnnounceResponse(w http.ResponseWriter) error

type Announce202JSONResponse added in v0.7.0

type Announce202JSONResponse QueuedAnnouncement

func (Announce202JSONResponse) VisitAnnounceResponse added in v0.7.0

func (response Announce202JSONResponse) VisitAnnounceResponse(w http.ResponseWriter) error

type Announce409ApplicationProblemPlusJSONResponse added in v0.3.0

type Announce409ApplicationProblemPlusJSONResponse Problem

func (Announce409ApplicationProblemPlusJSONResponse) VisitAnnounceResponse added in v0.3.0

func (response Announce409ApplicationProblemPlusJSONResponse) VisitAnnounceResponse(w http.ResponseWriter) error

type Announce422ApplicationProblemPlusJSONResponse added in v0.3.0

type Announce422ApplicationProblemPlusJSONResponse Problem

func (Announce422ApplicationProblemPlusJSONResponse) VisitAnnounceResponse added in v0.3.0

func (response Announce422ApplicationProblemPlusJSONResponse) VisitAnnounceResponse(w http.ResponseWriter) error

type AnnounceJSONRequestBody added in v0.0.7

type AnnounceJSONRequestBody = AnnounceRequest

AnnounceJSONRequestBody defines body for Announce for application/json ContentType.

type AnnounceMentions added in v0.5.0

type AnnounceMentions struct {
	Groups []string `json:"groups"`
	Users  []string `json:"users"`
}

AnnounceMentions Whom to tag with the post. The linked user owners are tagged from what is kept, not from the request; users are the ones the preview showed tagged, so a post whose kept links changed since is refused rather than tagging someone else. groups name the user groups checked, each one the announcement offered.

type AnnounceRequest added in v0.0.7

type AnnounceRequest struct {
	// Channel The channel to post to; empty uses the configured channel or the webhook.
	Channel string `json:"channel"`

	// EditedText The text to post in place of the composed announcement, as edited in the preview. It needs text, the composed announcement the edit began from, which is still checked against the one composed now.
	EditedText *string `json:"edited_text,omitempty"`

	// Mentions Whom to tag with the post. The linked user owners are tagged from what is kept, not from the request; users are the ones the preview showed tagged, so a post whose kept links changed since is refused rather than tagging someone else. groups name the user groups checked, each one the announcement offered.
	Mentions *AnnounceMentions `json:"mentions,omitempty"`

	// Text The announcement as GET /api/announcement showed it. When given, the post is refused with 409 unless the announcement composed now reads the same; when left out, the announcement composed now is posted.
	Text *string `json:"text,omitempty"`

	// When now, the default, posts at once; ci_passes holds a ready-for-review announcement until the pull request's CI passes.
	When *AnnounceRequestWhen `json:"when,omitempty"`
}

AnnounceRequest Where to post the announcement, the text its preview showed, the text to post in its place when it was edited, and when to post it.

type AnnounceRequestObject added in v0.0.7

type AnnounceRequestObject struct {
	Body *AnnounceJSONRequestBody
}

type AnnounceRequestWhen added in v0.7.0

type AnnounceRequestWhen string

AnnounceRequestWhen now, the default, posts at once; ci_passes holds a ready-for-review announcement until the pull request's CI passes.

const (
	AnnounceRequestWhenCiPasses AnnounceRequestWhen = "ci_passes"
	AnnounceRequestWhenNow      AnnounceRequestWhen = "now"
)

Defines values for AnnounceRequestWhen.

func (AnnounceRequestWhen) Valid added in v0.7.0

func (e AnnounceRequestWhen) Valid() bool

Valid indicates whether the value is a known member of the AnnounceRequestWhen enum.

type AnnounceResponseObject added in v0.0.7

type AnnounceResponseObject interface {
	VisitAnnounceResponse(w http.ResponseWriter) error
}

type AnnouncedefaultApplicationProblemPlusJSONResponse added in v0.3.0

type AnnouncedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (AnnouncedefaultApplicationProblemPlusJSONResponse) VisitAnnounceResponse added in v0.3.0

type Announcement added in v0.0.7

type Announcement struct {
	// CanWaitForCi Whether a preview's announcement can be held until the pull request's CI passes: it is ready for review and its CI has not passed — running, no checks reported yet, or a check failed, which the hold waits out for a fix. Left out where it cannot, and on a post.
	CanWaitForCi *bool `json:"can_wait_for_ci,omitempty"`

	// Channel The channel it posts to, or empty for a webhook's own channel.
	Channel string `json:"channel"`

	// Ci How the pull request's CI stands as the preview was composed; a failed check means announcing now is refused. Left out when the CI could not be read, and on a post.
	Ci *CIState `json:"ci,omitempty"`

	// Tagging Whom a ready-for-review announcement proposes to tag on Slack: the code owners of the branch's changes, and the user groups it offers.
	Tagging *AnnouncementTagging `json:"tagging,omitempty"`

	// Text The message that would be posted.
	Text string `json:"text"`

	// Warning Set only on a post that went out but that the store could not remember, so a later session may offer it again; the post is not a failure. Left out on a preview.
	//
	// Example: Posted, but not remembered: it may be offered again.
	Warning *string `json:"warning,omitempty"`
}

Announcement A composed announcement and where it would post.

type AnnouncementTagging added in v0.5.0

type AnnouncementTagging struct {
	// Available Whether this announcement can tag anyone: only a ready-for-review announcement does, and only with the store on. When false, owners and groups are empty.
	Available bool       `json:"available"`
	Groups    []GroupTag `json:"groups"`

	// MissingScope A scope the Slack token lacks to offer the people or groups an owner not yet linked could be linked to, such as users:read. The announcement still posts, tagging whom it can.
	//
	// Example: usergroups:read
	MissingScope *string    `json:"missing_scope,omitempty"`
	Owners       []OwnerTag `json:"owners"`

	// UnavailableReason Why this announcement tags no one though it would: the Slack workspace the token is for could not be read, and links are kept per workspace. The announcement posts untagged; available is false and owners and groups are empty.
	//
	// Example: can't tell which Slack workspace this token is for: the credential was not accepted
	UnavailableReason *string `json:"unavailable_reason,omitempty"`
}

AnnouncementTagging Whom a ready-for-review announcement proposes to tag on Slack: the code owners of the branch's changes, and the user groups it offers.

type AssignIssue200JSONResponse added in v0.7.0

type AssignIssue200JSONResponse AssignedIssue

func (AssignIssue200JSONResponse) VisitAssignIssueResponse added in v0.7.0

func (response AssignIssue200JSONResponse) VisitAssignIssueResponse(w http.ResponseWriter) error

type AssignIssue404ApplicationProblemPlusJSONResponse added in v0.7.0

type AssignIssue404ApplicationProblemPlusJSONResponse Problem

func (AssignIssue404ApplicationProblemPlusJSONResponse) VisitAssignIssueResponse added in v0.7.0

func (response AssignIssue404ApplicationProblemPlusJSONResponse) VisitAssignIssueResponse(w http.ResponseWriter) error

type AssignIssue422ApplicationProblemPlusJSONResponse added in v0.7.0

type AssignIssue422ApplicationProblemPlusJSONResponse Problem

func (AssignIssue422ApplicationProblemPlusJSONResponse) VisitAssignIssueResponse added in v0.7.0

func (response AssignIssue422ApplicationProblemPlusJSONResponse) VisitAssignIssueResponse(w http.ResponseWriter) error

type AssignIssueJSONRequestBody added in v0.7.0

type AssignIssueJSONRequestBody = AssignRequest

AssignIssueJSONRequestBody defines body for AssignIssue for application/json ContentType.

type AssignIssueRequestObject added in v0.7.0

type AssignIssueRequestObject struct {
	Key  string `json:"key"`
	Body *AssignIssueJSONRequestBody
}

type AssignIssueResponseObject added in v0.7.0

type AssignIssueResponseObject interface {
	VisitAssignIssueResponse(w http.ResponseWriter) error
}

type AssignIssuedefaultApplicationProblemPlusJSONResponse added in v0.7.0

type AssignIssuedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (AssignIssuedefaultApplicationProblemPlusJSONResponse) VisitAssignIssueResponse added in v0.7.0

type AssignRequest added in v0.7.0

type AssignRequest struct {
	// Assignee The username, as the issue's tracker knows it.
	Assignee string `json:"assignee"`
}

AssignRequest Whom to assign an issue to.

type AssignedIssue added in v0.7.0

type AssignedIssue struct {
	// Assignee Example: ana.lopez
	Assignee string `json:"assignee"`

	// Key Example: PROJ-412
	Key string `json:"key"`
}

AssignedIssue An issue just assigned, and to whom.

type Branch

type Branch struct {
	Ahead int `json:"ahead"`

	// Base The base branch, such as origin/main, or upstream/main in a fork's clone.
	Base string `json:"base"`

	// BaseRemote The remote the base is read from: the one gh marked as the base, else upstream, else origin. Start work fetches it, and a finish pulls the base from it.
	BaseRemote string `json:"base_remote"`
	Behind     int    `json:"behind"`

	// Commits The commits on this branch since its base.
	Commits []Commit `json:"commits"`

	// Detached Whether HEAD is detached rather than on a branch.
	Detached bool `json:"detached"`

	// FinishCommands The git commands finishing the branch runs, in order, as the server runs them — what the finish's last look shows before the force delete in them is confirmed. Absent for a detached HEAD or a branch with no base to finish onto.
	FinishCommands *[]string `json:"finish_commands,omitempty"`

	// Head The commit SHA; empty before the first commit, and in a write's answer when the branch could not be read back after the write landed.
	Head string `json:"head"`

	// IssueLink The issue the branch was linked to by hand, for work begun outside workflow; empty when it was never linked.
	IssueLink string `json:"issue_link"`

	// IssueLinkTracker The tracker the linked issue lives in, read from its key by the rule the server routes it by; absent when the branch was never linked.
	IssueLinkTracker *IssueTracker `json:"issue_link_tracker,omitempty"`
	Name             string        `json:"name"`

	// PushRemote The remote a push of the branch goes to, as git decides it: branch.<name>.pushRemote, else remote.pushDefault, else the remote the branch tracks (branch.<name>.remote), else origin.
	PushRemote string `json:"push_remote"`

	// Upstream The tracking branch; empty if never pushed.
	Upstream string `json:"upstream"`
}

Branch defines model for Branch.

type BranchConfig

type BranchConfig struct {
	DefaultPrefix *string            `json:"default_prefix,omitempty"`
	Prefixes      *map[string]string `json:"prefixes,omitempty"`

	// SlugLimit The summary slug's length cap in a branch name; zero keeps 48.
	SlugLimit *int `json:"slug_limit,omitempty"`

	// Template The branch-name template; must contain {key}.
	Template *string `json:"template,omitempty"`
}

BranchConfig defines model for BranchConfig.

type BranchIssuePreview added in v0.5.0

type BranchIssuePreview struct {
	// Body Its description as linking would leave it.
	Body string `json:"body"`

	// Changes Whether linking would change the description at all.
	Changes bool `json:"changes"`

	// Key The issue's key, a forge number without its #.
	Key string `json:"key"`

	// Pull The open pull request's number, or 0 when the branch has none.
	Pull int `json:"pull"`
}

BranchIssuePreview defines model for BranchIssuePreview.

type BranchIssueRequest added in v0.5.0

type BranchIssueRequest struct {
	// Key A Jira key, or a forge issue number with or without its #.
	//
	// Example: PROJ-412
	Key string `json:"key"`

	// UpdatePull Add the line naming the issue to the open pull request's description.
	UpdatePull bool `json:"update_pull"`
}

BranchIssueRequest defines model for BranchIssueRequest.

type CI

type CI struct {
	Checks []Check `json:"checks"`
	Done   int     `json:"done"`
	Failed int     `json:"failed"`
	State  CIState `json:"state"`

	// Total Total checks; 0 on a forge that reports the pipeline whole.
	Total int `json:"total"`
}

CI defines model for CI.

type CIState

type CIState string

CIState defines model for CIState.

const (
	CIStateFailed  CIState = "failed"
	CIStateNone    CIState = "none"
	CIStatePassed  CIState = "passed"
	CIStateRunning CIState = "running"
)

Defines values for CIState.

func (CIState) Valid

func (e CIState) Valid() bool

Valid indicates whether the value is a known member of the CIState enum.

type CancelQueuedAnnouncement204Response added in v0.7.0

type CancelQueuedAnnouncement204Response struct {
}

func (CancelQueuedAnnouncement204Response) VisitCancelQueuedAnnouncementResponse added in v0.7.0

func (response CancelQueuedAnnouncement204Response) VisitCancelQueuedAnnouncementResponse(w http.ResponseWriter) error

type CancelQueuedAnnouncement409ApplicationProblemPlusJSONResponse added in v0.7.0

type CancelQueuedAnnouncement409ApplicationProblemPlusJSONResponse Problem

func (CancelQueuedAnnouncement409ApplicationProblemPlusJSONResponse) VisitCancelQueuedAnnouncementResponse added in v0.7.0

func (response CancelQueuedAnnouncement409ApplicationProblemPlusJSONResponse) VisitCancelQueuedAnnouncementResponse(w http.ResponseWriter) error

type CancelQueuedAnnouncementRequestObject added in v0.7.0

type CancelQueuedAnnouncementRequestObject struct {
}

type CancelQueuedAnnouncementResponseObject added in v0.7.0

type CancelQueuedAnnouncementResponseObject interface {
	VisitCancelQueuedAnnouncementResponse(w http.ResponseWriter) error
}

type CancelQueuedAnnouncementdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type CancelQueuedAnnouncementdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (CancelQueuedAnnouncementdefaultApplicationProblemPlusJSONResponse) VisitCancelQueuedAnnouncementResponse added in v0.7.0

func (response CancelQueuedAnnouncementdefaultApplicationProblemPlusJSONResponse) VisitCancelQueuedAnnouncementResponse(w http.ResponseWriter) error

type Change

type Change struct {
	Conflicted bool `json:"conflicted"`

	// HasUnstaged Whether there are unstaged edits to the same path.
	HasUnstaged bool `json:"has_unstaged"`

	// Kind What kind of change this is.
	Kind ChangeKind `json:"kind"`

	// OriginalPath The former path for a rename or copy; absent otherwise.
	OriginalPath *string `json:"original_path,omitempty"`
	Path         string  `json:"path"`

	// Staged Whether the change (or part of it) is staged.
	Staged bool `json:"staged"`
}

Change defines model for Change.

type ChangeKind

type ChangeKind string

ChangeKind What kind of change this is.

const (
	ChangeKindConflicted ChangeKind = "conflicted"
	ChangeKindCopied     ChangeKind = "copied"
	ChangeKindDeleted    ChangeKind = "deleted"
	ChangeKindModified   ChangeKind = "modified"
	ChangeKindNew        ChangeKind = "new"
	ChangeKindRenamed    ChangeKind = "renamed"
	ChangeKindUntracked  ChangeKind = "untracked"
)

Defines values for ChangeKind.

func (ChangeKind) Valid

func (e ChangeKind) Valid() bool

Valid indicates whether the value is a known member of the ChangeKind enum.

type ChangeList

type ChangeList struct {
	Changes []Change `json:"changes"`
}

ChangeList defines model for ChangeList.

type ChangeStatus200JSONResponse added in v0.7.0

type ChangeStatus200JSONResponse MovedIssue

func (ChangeStatus200JSONResponse) VisitChangeStatusResponse added in v0.7.0

func (response ChangeStatus200JSONResponse) VisitChangeStatusResponse(w http.ResponseWriter) error

type ChangeStatus404ApplicationProblemPlusJSONResponse added in v0.7.0

type ChangeStatus404ApplicationProblemPlusJSONResponse Problem

func (ChangeStatus404ApplicationProblemPlusJSONResponse) VisitChangeStatusResponse added in v0.7.0

func (response ChangeStatus404ApplicationProblemPlusJSONResponse) VisitChangeStatusResponse(w http.ResponseWriter) error

type ChangeStatus409ApplicationProblemPlusJSONResponse added in v0.7.0

type ChangeStatus409ApplicationProblemPlusJSONResponse Problem

func (ChangeStatus409ApplicationProblemPlusJSONResponse) VisitChangeStatusResponse added in v0.7.0

func (response ChangeStatus409ApplicationProblemPlusJSONResponse) VisitChangeStatusResponse(w http.ResponseWriter) error

type ChangeStatus422ApplicationProblemPlusJSONResponse added in v0.7.0

type ChangeStatus422ApplicationProblemPlusJSONResponse Problem

func (ChangeStatus422ApplicationProblemPlusJSONResponse) VisitChangeStatusResponse added in v0.7.0

func (response ChangeStatus422ApplicationProblemPlusJSONResponse) VisitChangeStatusResponse(w http.ResponseWriter) error

type ChangeStatusJSONRequestBody added in v0.7.0

type ChangeStatusJSONRequestBody = StatusChangeRequest

ChangeStatusJSONRequestBody defines body for ChangeStatus for application/json ContentType.

type ChangeStatusRequestObject added in v0.7.0

type ChangeStatusRequestObject struct {
	Key  string `json:"key"`
	Body *ChangeStatusJSONRequestBody
}

type ChangeStatusResponseObject added in v0.7.0

type ChangeStatusResponseObject interface {
	VisitChangeStatusResponse(w http.ResponseWriter) error
}

type ChangeStatusdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type ChangeStatusdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ChangeStatusdefaultApplicationProblemPlusJSONResponse) VisitChangeStatusResponse added in v0.7.0

type Check

type Check struct {
	// ID The forge's own id for the check, so its log can be asked for; absent for a status.
	ID *string `json:"id,omitempty"`

	// LogAvailable Whether the forge serves the check's log.
	LogAvailable *bool  `json:"log_available,omitempty"`
	Name         string `json:"name"`

	// Reason Why a failed check failed, in the forge's few words; absent when it gives none.
	Reason *string `json:"reason,omitempty"`

	// Stage The pipeline stage a GitLab job ran in; absent on GitHub.
	Stage *string `json:"stage,omitempty"`
	State CIState `json:"state"`
	URL   string  `json:"url"`
}

Check defines model for Check.

type Checkout200JSONResponse

type Checkout200JSONResponse Branch

func (Checkout200JSONResponse) VisitCheckoutResponse

func (response Checkout200JSONResponse) VisitCheckoutResponse(w http.ResponseWriter) error

type Checkout409ApplicationProblemPlusJSONResponse added in v0.3.0

type Checkout409ApplicationProblemPlusJSONResponse Problem

func (Checkout409ApplicationProblemPlusJSONResponse) VisitCheckoutResponse added in v0.3.0

func (response Checkout409ApplicationProblemPlusJSONResponse) VisitCheckoutResponse(w http.ResponseWriter) error

type Checkout422ApplicationProblemPlusJSONResponse added in v0.3.0

type Checkout422ApplicationProblemPlusJSONResponse Problem

func (Checkout422ApplicationProblemPlusJSONResponse) VisitCheckoutResponse added in v0.3.0

func (response Checkout422ApplicationProblemPlusJSONResponse) VisitCheckoutResponse(w http.ResponseWriter) error

type CheckoutJSONRequestBody

type CheckoutJSONRequestBody = CheckoutRequest

CheckoutJSONRequestBody defines body for Checkout for application/json ContentType.

type CheckoutRequest

type CheckoutRequest struct {
	// Branch The local branch to switch the working tree to.
	//
	// Example: fix/PROJ-412-redact-tokens
	Branch string `json:"branch"`
}

CheckoutRequest The branch to check out.

type CheckoutRequestObject

type CheckoutRequestObject struct {
	Body *CheckoutJSONRequestBody
}

type CheckoutResponseObject

type CheckoutResponseObject interface {
	VisitCheckoutResponse(w http.ResponseWriter) error
}

type CheckoutdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type CheckoutdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (CheckoutdefaultApplicationProblemPlusJSONResponse) VisitCheckoutResponse added in v0.3.0

type Comment

type Comment struct {
	Author string `json:"author"`
	Body   string `json:"body"`

	// Created RFC 3339; left out when the tracker's date could not be read.
	Created *time.Time `json:"created,omitempty"`
}

Comment defines model for Comment.

type CommentRequest added in v0.5.1

type CommentRequest struct {
	// Text The comment, written as Markdown when jira.markdown_comments is on as last saved, and as Jira wiki markup otherwise.
	Text string `json:"text"`
}

CommentRequest A comment to post on an issue.

type Commit

type Commit struct {
	Hash    string `json:"hash"`
	Subject string `json:"subject"`

	// Unpushed Whether the commit is one not yet pushed, which alone staged changes can be amended or fixed up into. A branch with more commits than are read marks none.
	Unpushed bool `json:"unpushed"`
}

Commit defines model for Commit.

type Commit200JSONResponse added in v0.0.7

type Commit200JSONResponse Branch

func (Commit200JSONResponse) VisitCommitResponse added in v0.0.7

func (response Commit200JSONResponse) VisitCommitResponse(w http.ResponseWriter) error

type Commit409ApplicationProblemPlusJSONResponse added in v0.3.0

type Commit409ApplicationProblemPlusJSONResponse Problem

func (Commit409ApplicationProblemPlusJSONResponse) VisitCommitResponse added in v0.3.0

func (response Commit409ApplicationProblemPlusJSONResponse) VisitCommitResponse(w http.ResponseWriter) error

type Commit422ApplicationProblemPlusJSONResponse added in v0.3.0

type Commit422ApplicationProblemPlusJSONResponse Problem

func (Commit422ApplicationProblemPlusJSONResponse) VisitCommitResponse added in v0.3.0

func (response Commit422ApplicationProblemPlusJSONResponse) VisitCommitResponse(w http.ResponseWriter) error

type CommitConfig

type CommitConfig struct {
	DefaultScope *string `json:"default_scope,omitempty"`

	// RefsTrailer The issue trailer's label, such as "Closes"; empty keeps "Refs".
	RefsTrailer *string `json:"refs_trailer,omitempty"`

	// SubjectLimit The longest a subject may be, in characters; zero keeps 72.
	SubjectLimit *int `json:"subject_limit,omitempty"`

	// Types The commit types the composer offers and validates against, in order; empty keeps the built-in Conventional Commit types.
	Types *[]string `json:"types,omitempty"`
}

CommitConfig defines model for CommitConfig.

type CommitJSONRequestBody added in v0.0.7

type CommitJSONRequestBody = CommitRequest

CommitJSONRequestBody defines body for Commit for application/json ContentType.

type CommitRequest added in v0.0.7

type CommitRequest struct {
	// Body The optional message body, after a blank line.
	Body *string `json:"body,omitempty"`

	// Breaking Whether this is a breaking change, marked with "!".
	Breaking *bool `json:"breaking,omitempty"`

	// Scope The optional scope, written in parentheses after the type.
	Scope *string `json:"scope,omitempty"`

	// Subject The description written after the colon.
	//
	// Example: redact tokens before they reach the request log
	Subject string `json:"subject"`

	// Type The Conventional Commit type, such as feat or fix.
	//
	// Example: fix
	Type string `json:"type"`
}

CommitRequest The parts of a Conventional Commit message for the staged changes.

type CommitRequestObject added in v0.0.7

type CommitRequestObject struct {
	Body *CommitJSONRequestBody
}

type CommitResponseObject added in v0.0.7

type CommitResponseObject interface {
	VisitCommitResponse(w http.ResponseWriter) error
}

type CommitdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type CommitdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (CommitdefaultApplicationProblemPlusJSONResponse) VisitCommitResponse added in v0.3.0

type CompleteTask200JSONResponse added in v0.4.1

type CompleteTask200JSONResponse TaskList

func (CompleteTask200JSONResponse) VisitCompleteTaskResponse added in v0.4.1

func (response CompleteTask200JSONResponse) VisitCompleteTaskResponse(w http.ResponseWriter) error

type CompleteTask409ApplicationProblemPlusJSONResponse added in v0.4.1

type CompleteTask409ApplicationProblemPlusJSONResponse Problem

func (CompleteTask409ApplicationProblemPlusJSONResponse) VisitCompleteTaskResponse added in v0.4.1

func (response CompleteTask409ApplicationProblemPlusJSONResponse) VisitCompleteTaskResponse(w http.ResponseWriter) error

type CompleteTask422ApplicationProblemPlusJSONResponse added in v0.4.1

type CompleteTask422ApplicationProblemPlusJSONResponse Problem

func (CompleteTask422ApplicationProblemPlusJSONResponse) VisitCompleteTaskResponse added in v0.4.1

func (response CompleteTask422ApplicationProblemPlusJSONResponse) VisitCompleteTaskResponse(w http.ResponseWriter) error

type CompleteTaskRequestObject added in v0.4.1

type CompleteTaskRequestObject struct {
	UUID TaskUUID `json:"uuid"`
}

type CompleteTaskResponseObject added in v0.4.1

type CompleteTaskResponseObject interface {
	VisitCompleteTaskResponse(w http.ResponseWriter) error
}

type CompleteTaskdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type CompleteTaskdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (CompleteTaskdefaultApplicationProblemPlusJSONResponse) VisitCompleteTaskResponse added in v0.4.1

type Config

type Config struct {
	Branch      BranchConfig      `json:"branch"`
	Commit      CommitConfig      `json:"commit"`
	Forge       ForgeConfig       `json:"forge"`
	Issues      IssuesConfig      `json:"issues"`
	Jira        JiraConfig        `json:"jira"`
	Messaging   MessagingConfig   `json:"messaging"`
	PullRequest PullRequestConfig `json:"pull_request"`
	Store       StoreConfig       `json:"store"`
	Taskwarrior TaskwarriorConfig `json:"taskwarrior"`
	Timing      TimingConfig      `json:"timing"`
	UI          UIConfig          `json:"ui"`
	Version     string            `json:"version"`
}

Config The whole configuration file. On a read, the six secret fields and the Jira header values are masked; on a write, a masked or empty secret keeps the stored value, and null removes it.

type ConfiguredHooks added in v0.10.0

type ConfiguredHooks struct {
	// GitOnly The hooks only git runs, in the order git documents them.
	GitOnly []GitOnlyHook `json:"git_only"`

	// Runnable The hooks a run by hand can stand in for, git's own first in the order git documents them, then the configuration's own, sorted.
	Runnable []string `json:"runnable"`
}

ConfiguredHooks The hooks lefthook configures: those a run by hand can run, and those only git runs. A name is the configuration's own, as lefthook takes it back.

type CreateBranch200JSONResponse added in v0.0.7

type CreateBranch200JSONResponse Branch

func (CreateBranch200JSONResponse) VisitCreateBranchResponse added in v0.0.7

func (response CreateBranch200JSONResponse) VisitCreateBranchResponse(w http.ResponseWriter) error

type CreateBranch409ApplicationProblemPlusJSONResponse added in v0.3.0

type CreateBranch409ApplicationProblemPlusJSONResponse Problem

func (CreateBranch409ApplicationProblemPlusJSONResponse) VisitCreateBranchResponse added in v0.3.0

func (response CreateBranch409ApplicationProblemPlusJSONResponse) VisitCreateBranchResponse(w http.ResponseWriter) error

type CreateBranch422ApplicationProblemPlusJSONResponse added in v0.3.0

type CreateBranch422ApplicationProblemPlusJSONResponse Problem

func (CreateBranch422ApplicationProblemPlusJSONResponse) VisitCreateBranchResponse added in v0.3.0

func (response CreateBranch422ApplicationProblemPlusJSONResponse) VisitCreateBranchResponse(w http.ResponseWriter) error

type CreateBranchJSONRequestBody added in v0.0.7

type CreateBranchJSONRequestBody = CreateBranchRequest

CreateBranchJSONRequestBody defines body for CreateBranch for application/json ContentType.

type CreateBranchRequest added in v0.0.7

type CreateBranchRequest struct {
	// Fetch Whether to fetch the base remote first — upstream in a fork's clone, else origin — so the branch starts from what it holds now, as the terminal's branch creator and workflow branch --fetch do. A fetch that fails creates nothing and is a 502 with code fetch_failed; asking again with fetch false branches from what you have, the terminal's way out. With no base to refresh nothing is fetched either way.
	Fetch *bool `json:"fetch,omitempty"`

	// IssueKey The issue to name and create a branch for.
	//
	// Example: PROJ-412
	IssueKey string `json:"issue_key"`
}

CreateBranchRequest The issue to start work on by creating its branch.

type CreateBranchRequestObject added in v0.0.7

type CreateBranchRequestObject struct {
	Body *CreateBranchJSONRequestBody
}

type CreateBranchResponseObject added in v0.0.7

type CreateBranchResponseObject interface {
	VisitCreateBranchResponse(w http.ResponseWriter) error
}

type CreateBranchdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type CreateBranchdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (CreateBranchdefaultApplicationProblemPlusJSONResponse) VisitCreateBranchResponse added in v0.3.0

type CreateWorktree200JSONResponse added in v0.6.0

type CreateWorktree200JSONResponse CreatedWorktree

func (CreateWorktree200JSONResponse) VisitCreateWorktreeResponse added in v0.6.0

func (response CreateWorktree200JSONResponse) VisitCreateWorktreeResponse(w http.ResponseWriter) error

type CreateWorktree409ApplicationProblemPlusJSONResponse added in v0.6.0

type CreateWorktree409ApplicationProblemPlusJSONResponse Problem

func (CreateWorktree409ApplicationProblemPlusJSONResponse) VisitCreateWorktreeResponse added in v0.6.0

func (response CreateWorktree409ApplicationProblemPlusJSONResponse) VisitCreateWorktreeResponse(w http.ResponseWriter) error

type CreateWorktree422ApplicationProblemPlusJSONResponse added in v0.6.0

type CreateWorktree422ApplicationProblemPlusJSONResponse Problem

func (CreateWorktree422ApplicationProblemPlusJSONResponse) VisitCreateWorktreeResponse added in v0.6.0

func (response CreateWorktree422ApplicationProblemPlusJSONResponse) VisitCreateWorktreeResponse(w http.ResponseWriter) error

type CreateWorktreeJSONRequestBody added in v0.6.0

type CreateWorktreeJSONRequestBody = CreateWorktreeRequest

CreateWorktreeJSONRequestBody defines body for CreateWorktree for application/json ContentType.

type CreateWorktreeRequest added in v0.6.0

type CreateWorktreeRequest struct {
	// Fetch Whether to fetch the base remote first — upstream in a fork's clone, else origin — so the branch starts from what it holds now, as the terminal's branch creator and workflow branch --fetch do. A fetch that fails creates nothing and is a 502 with code fetch_failed; asking again with fetch false branches from what you have, the terminal's way out. With no base to refresh nothing is fetched either way.
	Fetch *bool `json:"fetch,omitempty"`

	// IssueKey The issue to name and create a branch for.
	//
	// Example: PROJ-412
	IssueKey string `json:"issue_key"`
}

CreateWorktreeRequest The issue to start work on in a new worktree.

type CreateWorktreeRequestObject added in v0.6.0

type CreateWorktreeRequestObject struct {
	Body *CreateWorktreeJSONRequestBody
}

type CreateWorktreeResponseObject added in v0.6.0

type CreateWorktreeResponseObject interface {
	VisitCreateWorktreeResponse(w http.ResponseWriter) error
}

type CreateWorktreedefaultApplicationProblemPlusJSONResponse added in v0.6.0

type CreateWorktreedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (CreateWorktreedefaultApplicationProblemPlusJSONResponse) VisitCreateWorktreeResponse added in v0.6.0

func (response CreateWorktreedefaultApplicationProblemPlusJSONResponse) VisitCreateWorktreeResponse(w http.ResponseWriter) error

type CreatedWorktree added in v0.6.0

type CreatedWorktree struct {
	// Branch The branch created and checked out there.
	Branch string `json:"branch"`

	// Dir The worktree's directory, as an absolute path.
	Dir string `json:"dir"`

	// Shown The directory written from your home.
	Shown string `json:"shown"`
}

CreatedWorktree A worktree just created for an issue's branch.

type DirectoryChoice added in v0.6.0

type DirectoryChoice struct {
	Dir string `json:"dir"`
}

DirectoryChoice A directory, as an absolute path.

type DirectoryEntry added in v0.6.0

type DirectoryEntry struct {
	Name string `json:"name"`

	// Path The directory, as an absolute path.
	Path string `json:"path"`

	// Repository Whether it is a repository's root.
	Repository bool `json:"repository"`
}

DirectoryEntry A directory in another.

type DirectoryListing added in v0.6.0

type DirectoryListing struct {
	Entries []DirectoryEntry `json:"entries"`

	// Parent The directory above it, or empty at the root.
	Parent string `json:"parent"`

	// Path The directory listed, as an absolute path.
	Path string `json:"path"`

	// Shown The directory written from your home.
	Shown string `json:"shown"`

	// TruncatedTo The most a listing holds, when the directory held more: only the first this many by name are listed, and a prefix reaches the rest. Absent when every directory that matches is listed.
	TruncatedTo *int `json:"truncated_to,omitempty"`
}

DirectoryListing A directory and the directories in it, by name.

type Discard200JSONResponse added in v0.7.0

type Discard200JSONResponse ChangeList

func (Discard200JSONResponse) VisitDiscardResponse added in v0.7.0

func (response Discard200JSONResponse) VisitDiscardResponse(w http.ResponseWriter) error

type Discard404ApplicationProblemPlusJSONResponse added in v0.7.0

type Discard404ApplicationProblemPlusJSONResponse Problem

func (Discard404ApplicationProblemPlusJSONResponse) VisitDiscardResponse added in v0.7.0

func (response Discard404ApplicationProblemPlusJSONResponse) VisitDiscardResponse(w http.ResponseWriter) error

type Discard422ApplicationProblemPlusJSONResponse added in v0.7.0

type Discard422ApplicationProblemPlusJSONResponse Problem

func (Discard422ApplicationProblemPlusJSONResponse) VisitDiscardResponse added in v0.7.0

func (response Discard422ApplicationProblemPlusJSONResponse) VisitDiscardResponse(w http.ResponseWriter) error

type DiscardJSONRequestBody added in v0.7.0

type DiscardJSONRequestBody = DiscardRequest

DiscardJSONRequestBody defines body for Discard for application/json ContentType.

type DiscardRequest added in v0.7.0

type DiscardRequest struct {
	// Path A changed file, by the path the working tree's changes list it under (a rename's new path).
	//
	// Example: internal/config/config.go
	Path string `json:"path"`
}

DiscardRequest The one changed file whose changes to discard.

type DiscardRequestObject added in v0.7.0

type DiscardRequestObject struct {
	Body *DiscardJSONRequestBody
}

type DiscardResponseObject added in v0.7.0

type DiscardResponseObject interface {
	VisitDiscardResponse(w http.ResponseWriter) error
}

type DiscarddefaultApplicationProblemPlusJSONResponse added in v0.7.0

type DiscarddefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (DiscarddefaultApplicationProblemPlusJSONResponse) VisitDiscardResponse added in v0.7.0

type EditPullRequest200JSONResponse added in v0.7.0

type EditPullRequest200JSONResponse PullRequest

func (EditPullRequest200JSONResponse) VisitEditPullRequestResponse added in v0.7.0

func (response EditPullRequest200JSONResponse) VisitEditPullRequestResponse(w http.ResponseWriter) error

type EditPullRequest409ApplicationProblemPlusJSONResponse added in v0.7.0

type EditPullRequest409ApplicationProblemPlusJSONResponse Problem

func (EditPullRequest409ApplicationProblemPlusJSONResponse) VisitEditPullRequestResponse added in v0.7.0

func (response EditPullRequest409ApplicationProblemPlusJSONResponse) VisitEditPullRequestResponse(w http.ResponseWriter) error

type EditPullRequest422ApplicationProblemPlusJSONResponse added in v0.7.0

type EditPullRequest422ApplicationProblemPlusJSONResponse Problem

func (EditPullRequest422ApplicationProblemPlusJSONResponse) VisitEditPullRequestResponse added in v0.7.0

func (response EditPullRequest422ApplicationProblemPlusJSONResponse) VisitEditPullRequestResponse(w http.ResponseWriter) error

type EditPullRequestJSONRequestBody added in v0.7.0

type EditPullRequestJSONRequestBody = PullRequestText

EditPullRequestJSONRequestBody defines body for EditPullRequest for application/json ContentType.

type EditPullRequestRequestObject added in v0.7.0

type EditPullRequestRequestObject struct {
	Body *EditPullRequestJSONRequestBody
}

type EditPullRequestResponseObject added in v0.7.0

type EditPullRequestResponseObject interface {
	VisitEditPullRequestResponse(w http.ResponseWriter) error
}

type EditPullRequestdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type EditPullRequestdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (EditPullRequestdefaultApplicationProblemPlusJSONResponse) VisitEditPullRequestResponse added in v0.7.0

func (response EditPullRequestdefaultApplicationProblemPlusJSONResponse) VisitEditPullRequestResponse(w http.ResponseWriter) error

type Favorite added in v0.6.0

type Favorite struct {
	// Dir The directory, as an absolute path.
	Dir string `json:"dir"`

	// Origin Origin's host and path, or empty.
	Origin string `json:"origin"`

	// Shown The directory written from your home.
	Shown string `json:"shown"`

	// State here is where the server works; repository is a repository's directory; directory is one in no repository; missing is not there.
	State FavoriteState `json:"state"`
}

Favorite A directory you keep as a favorite, and what is there now.

type FavoriteState added in v0.6.0

type FavoriteState string

FavoriteState here is where the server works; repository is a repository's directory; directory is one in no repository; missing is not there.

const (
	FavoriteStateDirectory  FavoriteState = "directory"
	FavoriteStateHere       FavoriteState = "here"
	FavoriteStateMissing    FavoriteState = "missing"
	FavoriteStateRepository FavoriteState = "repository"
)

Defines values for FavoriteState.

func (FavoriteState) Valid added in v0.6.0

func (e FavoriteState) Valid() bool

Valid indicates whether the value is a known member of the FavoriteState enum.

type FieldEntry added in v0.7.0

type FieldEntry struct {
	// ID The field's id.
	ID        string    `json:"id"`
	OptionID  *string   `json:"option_id,omitempty"`
	OptionIds *[]string `json:"option_ids,omitempty"`
	Text      *string   `json:"text,omitempty"`
}

FieldEntry The value given a field: option_id for an option field, option_ids for an option_list field, and text for a text, user or date field.

type FieldOption added in v0.7.0

type FieldOption struct {
	// ID Example: 1
	ID string `json:"id"`

	// Name Example: Fixed
	Name string `json:"name"`
}

FieldOption One value a field allows.

type FileDiff added in v0.7.0

type FileDiff struct {
	// Lines The diff, line by line, as git writes it — headers, hunks, and each line marked +, - or space — with terminal controls taken out; empty when git reports no difference.
	Lines []string `json:"lines"`

	// Path The file, as the working tree's changes list it.
	Path string `json:"path"`
}

FileDiff A changed file's diff against HEAD.

type FinishBranch200JSONResponse added in v0.7.0

type FinishBranch200JSONResponse Branch

func (FinishBranch200JSONResponse) VisitFinishBranchResponse added in v0.7.0

func (response FinishBranch200JSONResponse) VisitFinishBranchResponse(w http.ResponseWriter) error

type FinishBranch409ApplicationProblemPlusJSONResponse added in v0.7.0

type FinishBranch409ApplicationProblemPlusJSONResponse Problem

func (FinishBranch409ApplicationProblemPlusJSONResponse) VisitFinishBranchResponse added in v0.7.0

func (response FinishBranch409ApplicationProblemPlusJSONResponse) VisitFinishBranchResponse(w http.ResponseWriter) error

type FinishBranch422ApplicationProblemPlusJSONResponse added in v0.7.0

type FinishBranch422ApplicationProblemPlusJSONResponse Problem

func (FinishBranch422ApplicationProblemPlusJSONResponse) VisitFinishBranchResponse added in v0.7.0

func (response FinishBranch422ApplicationProblemPlusJSONResponse) VisitFinishBranchResponse(w http.ResponseWriter) error

type FinishBranchRequestObject added in v0.7.0

type FinishBranchRequestObject struct {
}

type FinishBranchResponseObject added in v0.7.0

type FinishBranchResponseObject interface {
	VisitFinishBranchResponse(w http.ResponseWriter) error
}

type FinishBranchdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type FinishBranchdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (FinishBranchdefaultApplicationProblemPlusJSONResponse) VisitFinishBranchResponse added in v0.7.0

type FollowUp added in v0.3.0

type FollowUp struct {
	Action FollowUpAction `json:"action"`

	// IssueKey The Jira issue the checked-out branch names.
	//
	// Example: PROJ-412
	IssueKey string `json:"issue_key"`

	// Status Set only on a transition — the status the issue would move to.
	//
	// Example: In Review
	Status *string `json:"status,omitempty"`
}

FollowUp One offer after opening: to link the pull request on the branch's issue (POST /api/issues/{key}/link), or to move that issue to the review status (POST /api/issues/{key}/transition). A move is offered only when Jira offers one that needs no fields.

type FollowUpAction added in v0.3.0

type FollowUpAction string

FollowUpAction defines model for FollowUp.Action.

const (
	FollowUpActionLink       FollowUpAction = "link"
	FollowUpActionTransition FollowUpAction = "transition"
)

Defines values for FollowUpAction.

func (FollowUpAction) Valid added in v0.3.0

func (e FollowUpAction) Valid() bool

Valid indicates whether the value is a known member of the FollowUpAction enum.

type ForgeConfig

type ForgeConfig struct {
	Cli  *bool   `json:"cli,omitempty"`
	Host *string `json:"host,omitempty"`

	// Kind Empty for auto-detect, else github or gitlab.
	Kind *ForgeConfigKind `json:"kind,omitempty"`

	// Token Masked on read, or empty when none is stored; on write, empty or masked keeps the stored value and null removes it.
	Token *string `json:"token"`
}

ForgeConfig defines model for ForgeConfig.

type ForgeConfigKind

type ForgeConfigKind string

ForgeConfigKind Empty for auto-detect, else github or gitlab.

const (
	ForgeConfigKindEmpty  ForgeConfigKind = ""
	ForgeConfigKindGithub ForgeConfigKind = "github"
	ForgeConfigKindGitlab ForgeConfigKind = "gitlab"
)

Defines values for ForgeConfigKind.

func (ForgeConfigKind) Valid

func (e ForgeConfigKind) Valid() bool

Valid indicates whether the value is a known member of the ForgeConfigKind enum.

type ForgetPerson200JSONResponse added in v0.5.0

type ForgetPerson200JSONResponse People

func (ForgetPerson200JSONResponse) VisitForgetPersonResponse added in v0.5.0

func (response ForgetPerson200JSONResponse) VisitForgetPersonResponse(w http.ResponseWriter) error

type ForgetPerson422ApplicationProblemPlusJSONResponse added in v0.5.0

type ForgetPerson422ApplicationProblemPlusJSONResponse Problem

func (ForgetPerson422ApplicationProblemPlusJSONResponse) VisitForgetPersonResponse added in v0.5.0

func (response ForgetPerson422ApplicationProblemPlusJSONResponse) VisitForgetPersonResponse(w http.ResponseWriter) error

type ForgetPersonParams added in v0.5.0

type ForgetPersonParams struct {
	// Owner The forge owner, a user or org/team.
	Owner OwnerName `form:"owner" json:"owner"`
}

ForgetPersonParams defines parameters for ForgetPerson.

type ForgetPersonRequestObject added in v0.5.0

type ForgetPersonRequestObject struct {
	Params ForgetPersonParams
}

type ForgetPersonResponseObject added in v0.5.0

type ForgetPersonResponseObject interface {
	VisitForgetPersonResponse(w http.ResponseWriter) error
}

type ForgetPersondefaultApplicationProblemPlusJSONResponse added in v0.5.0

type ForgetPersondefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ForgetPersondefaultApplicationProblemPlusJSONResponse) VisitForgetPersonResponse added in v0.5.0

type GetActivity200JSONResponse added in v0.6.0

type GetActivity200JSONResponse Activity

func (GetActivity200JSONResponse) VisitGetActivityResponse added in v0.6.0

func (response GetActivity200JSONResponse) VisitGetActivityResponse(w http.ResponseWriter) error

type GetActivity422ApplicationProblemPlusJSONResponse added in v0.6.0

type GetActivity422ApplicationProblemPlusJSONResponse Problem

func (GetActivity422ApplicationProblemPlusJSONResponse) VisitGetActivityResponse added in v0.6.0

func (response GetActivity422ApplicationProblemPlusJSONResponse) VisitGetActivityResponse(w http.ResponseWriter) error

type GetActivityParams added in v0.6.0

type GetActivityParams struct {
	// From The first day, written as YYYY-MM-DD.
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`

	// To The last day, written as YYYY-MM-DD.
	To *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

GetActivityParams defines parameters for GetActivity.

type GetActivityRequestObject added in v0.6.0

type GetActivityRequestObject struct {
	Params GetActivityParams
}

type GetActivityResponseObject added in v0.6.0

type GetActivityResponseObject interface {
	VisitGetActivityResponse(w http.ResponseWriter) error
}

type GetActivitydefaultApplicationProblemPlusJSONResponse added in v0.6.0

type GetActivitydefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetActivitydefaultApplicationProblemPlusJSONResponse) VisitGetActivityResponse added in v0.6.0

type GetAnnouncement200JSONResponse added in v0.0.7

type GetAnnouncement200JSONResponse Announcement

func (GetAnnouncement200JSONResponse) VisitGetAnnouncementResponse added in v0.0.7

func (response GetAnnouncement200JSONResponse) VisitGetAnnouncementResponse(w http.ResponseWriter) error

type GetAnnouncement409ApplicationProblemPlusJSONResponse added in v0.3.0

type GetAnnouncement409ApplicationProblemPlusJSONResponse Problem

func (GetAnnouncement409ApplicationProblemPlusJSONResponse) VisitGetAnnouncementResponse added in v0.3.0

func (response GetAnnouncement409ApplicationProblemPlusJSONResponse) VisitGetAnnouncementResponse(w http.ResponseWriter) error

type GetAnnouncementParams added in v0.5.0

type GetAnnouncementParams struct {
	// Channel The channel the preview would post to, whose members an owner not yet linked is checked against; the configured channel when left out.
	Channel *string `form:"channel,omitempty" json:"channel,omitempty"`
}

GetAnnouncementParams defines parameters for GetAnnouncement.

type GetAnnouncementRequestObject added in v0.0.7

type GetAnnouncementRequestObject struct {
	Params GetAnnouncementParams
}

type GetAnnouncementResponseObject added in v0.0.7

type GetAnnouncementResponseObject interface {
	VisitGetAnnouncementResponse(w http.ResponseWriter) error
}

type GetAnnouncementdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type GetAnnouncementdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetAnnouncementdefaultApplicationProblemPlusJSONResponse) VisitGetAnnouncementResponse added in v0.3.0

func (response GetAnnouncementdefaultApplicationProblemPlusJSONResponse) VisitGetAnnouncementResponse(w http.ResponseWriter) error

type GetBranch200JSONResponse

type GetBranch200JSONResponse Branch

func (GetBranch200JSONResponse) VisitGetBranchResponse

func (response GetBranch200JSONResponse) VisitGetBranchResponse(w http.ResponseWriter) error

type GetBranchRequestObject

type GetBranchRequestObject struct {
}

type GetBranchResponseObject

type GetBranchResponseObject interface {
	VisitGetBranchResponse(w http.ResponseWriter) error
}

type GetBranchdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type GetBranchdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetBranchdefaultApplicationProblemPlusJSONResponse) VisitGetBranchResponse added in v0.3.0

type GetChangeDiff200JSONResponse added in v0.7.0

type GetChangeDiff200JSONResponse FileDiff

func (GetChangeDiff200JSONResponse) VisitGetChangeDiffResponse added in v0.7.0

func (response GetChangeDiff200JSONResponse) VisitGetChangeDiffResponse(w http.ResponseWriter) error

type GetChangeDiff404ApplicationProblemPlusJSONResponse added in v0.7.0

type GetChangeDiff404ApplicationProblemPlusJSONResponse Problem

func (GetChangeDiff404ApplicationProblemPlusJSONResponse) VisitGetChangeDiffResponse added in v0.7.0

func (response GetChangeDiff404ApplicationProblemPlusJSONResponse) VisitGetChangeDiffResponse(w http.ResponseWriter) error

type GetChangeDiff422ApplicationProblemPlusJSONResponse added in v0.7.0

type GetChangeDiff422ApplicationProblemPlusJSONResponse Problem

func (GetChangeDiff422ApplicationProblemPlusJSONResponse) VisitGetChangeDiffResponse added in v0.7.0

func (response GetChangeDiff422ApplicationProblemPlusJSONResponse) VisitGetChangeDiffResponse(w http.ResponseWriter) error

type GetChangeDiffParams added in v0.7.0

type GetChangeDiffParams struct {
	// Path The changed file's path, as the working tree's changes list it.
	Path string `form:"path" json:"path"`
}

GetChangeDiffParams defines parameters for GetChangeDiff.

type GetChangeDiffRequestObject added in v0.7.0

type GetChangeDiffRequestObject struct {
	Params GetChangeDiffParams
}

type GetChangeDiffResponseObject added in v0.7.0

type GetChangeDiffResponseObject interface {
	VisitGetChangeDiffResponse(w http.ResponseWriter) error
}

type GetChangeDiffdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type GetChangeDiffdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetChangeDiffdefaultApplicationProblemPlusJSONResponse) VisitGetChangeDiffResponse added in v0.7.0

type GetCheckLog200JSONResponse added in v0.5.0

type GetCheckLog200JSONResponse JobLog

func (GetCheckLog200JSONResponse) VisitGetCheckLogResponse added in v0.5.0

func (response GetCheckLog200JSONResponse) VisitGetCheckLogResponse(w http.ResponseWriter) error

type GetCheckLog404ApplicationProblemPlusJSONResponse added in v0.5.0

type GetCheckLog404ApplicationProblemPlusJSONResponse Problem

func (GetCheckLog404ApplicationProblemPlusJSONResponse) VisitGetCheckLogResponse added in v0.5.0

func (response GetCheckLog404ApplicationProblemPlusJSONResponse) VisitGetCheckLogResponse(w http.ResponseWriter) error

type GetCheckLog422ApplicationProblemPlusJSONResponse added in v0.5.0

type GetCheckLog422ApplicationProblemPlusJSONResponse Problem

func (GetCheckLog422ApplicationProblemPlusJSONResponse) VisitGetCheckLogResponse added in v0.5.0

func (response GetCheckLog422ApplicationProblemPlusJSONResponse) VisitGetCheckLogResponse(w http.ResponseWriter) error

type GetCheckLogRequestObject added in v0.5.0

type GetCheckLogRequestObject struct {
	ID string `json:"id"`
}

type GetCheckLogResponseObject added in v0.5.0

type GetCheckLogResponseObject interface {
	VisitGetCheckLogResponse(w http.ResponseWriter) error
}

type GetCheckLogdefaultApplicationProblemPlusJSONResponse added in v0.5.0

type GetCheckLogdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetCheckLogdefaultApplicationProblemPlusJSONResponse) VisitGetCheckLogResponse added in v0.5.0

type GetConfig200JSONResponse

type GetConfig200JSONResponse struct {
	Body    Config
	Headers GetConfig200ResponseHeaders
}

func (GetConfig200JSONResponse) VisitGetConfigResponse

func (response GetConfig200JSONResponse) VisitGetConfigResponse(w http.ResponseWriter) error

type GetConfig200ResponseHeaders added in v0.3.1

type GetConfig200ResponseHeaders struct {
	ETag string
}

type GetConfig404ApplicationProblemPlusJSONResponse added in v0.7.0

type GetConfig404ApplicationProblemPlusJSONResponse Problem

func (GetConfig404ApplicationProblemPlusJSONResponse) VisitGetConfigResponse added in v0.7.0

func (response GetConfig404ApplicationProblemPlusJSONResponse) VisitGetConfigResponse(w http.ResponseWriter) error

type GetConfig422ApplicationProblemPlusJSONResponse added in v0.3.1

type GetConfig422ApplicationProblemPlusJSONResponse Problem

func (GetConfig422ApplicationProblemPlusJSONResponse) VisitGetConfigResponse added in v0.3.1

func (response GetConfig422ApplicationProblemPlusJSONResponse) VisitGetConfigResponse(w http.ResponseWriter) error

type GetConfigRequestObject

type GetConfigRequestObject struct {
}

type GetConfigResponseObject

type GetConfigResponseObject interface {
	VisitGetConfigResponse(w http.ResponseWriter) error
}

type GetConfigdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type GetConfigdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetConfigdefaultApplicationProblemPlusJSONResponse) VisitGetConfigResponse added in v0.3.0

type GetDirectories200JSONResponse added in v0.6.0

type GetDirectories200JSONResponse DirectoryListing

func (GetDirectories200JSONResponse) VisitGetDirectoriesResponse added in v0.6.0

func (response GetDirectories200JSONResponse) VisitGetDirectoriesResponse(w http.ResponseWriter) error

type GetDirectories404ApplicationProblemPlusJSONResponse added in v0.6.0

type GetDirectories404ApplicationProblemPlusJSONResponse Problem

func (GetDirectories404ApplicationProblemPlusJSONResponse) VisitGetDirectoriesResponse added in v0.6.0

func (response GetDirectories404ApplicationProblemPlusJSONResponse) VisitGetDirectoriesResponse(w http.ResponseWriter) error

type GetDirectories422ApplicationProblemPlusJSONResponse added in v0.6.0

type GetDirectories422ApplicationProblemPlusJSONResponse Problem

func (GetDirectories422ApplicationProblemPlusJSONResponse) VisitGetDirectoriesResponse added in v0.6.0

func (response GetDirectories422ApplicationProblemPlusJSONResponse) VisitGetDirectoriesResponse(w http.ResponseWriter) error

type GetDirectoriesParams added in v0.6.0

type GetDirectoriesParams struct {
	// Path The directory to list.
	Path *string `form:"path,omitempty" json:"path,omitempty"`

	// Prefix Only the directories whose names start with it, in any case; a hidden one is listed once the prefix starts with its dot. Every directory when left out.
	Prefix *string `form:"prefix,omitempty" json:"prefix,omitempty"`
}

GetDirectoriesParams defines parameters for GetDirectories.

type GetDirectoriesRequestObject added in v0.6.0

type GetDirectoriesRequestObject struct {
	Params GetDirectoriesParams
}

type GetDirectoriesResponseObject added in v0.6.0

type GetDirectoriesResponseObject interface {
	VisitGetDirectoriesResponse(w http.ResponseWriter) error
}

type GetDirectoriesdefaultApplicationProblemPlusJSONResponse added in v0.6.0

type GetDirectoriesdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetDirectoriesdefaultApplicationProblemPlusJSONResponse) VisitGetDirectoriesResponse added in v0.6.0

func (response GetDirectoriesdefaultApplicationProblemPlusJSONResponse) VisitGetDirectoriesResponse(w http.ResponseWriter) error

type GetHealth200JSONResponse

type GetHealth200JSONResponse Health

func (GetHealth200JSONResponse) VisitGetHealthResponse

func (response GetHealth200JSONResponse) VisitGetHealthResponse(w http.ResponseWriter) error

type GetHealthRequestObject

type GetHealthRequestObject struct {
}

type GetHealthResponseObject

type GetHealthResponseObject interface {
	VisitGetHealthResponse(w http.ResponseWriter) error
}

type GetHealthdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type GetHealthdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetHealthdefaultApplicationProblemPlusJSONResponse) VisitGetHealthResponse added in v0.3.0

type GetHookSetup200JSONResponse added in v0.7.0

type GetHookSetup200JSONResponse HookSetup

func (GetHookSetup200JSONResponse) VisitGetHookSetupResponse added in v0.7.0

func (response GetHookSetup200JSONResponse) VisitGetHookSetupResponse(w http.ResponseWriter) error

type GetHookSetup422ApplicationProblemPlusJSONResponse added in v0.7.0

type GetHookSetup422ApplicationProblemPlusJSONResponse Problem

func (GetHookSetup422ApplicationProblemPlusJSONResponse) VisitGetHookSetupResponse added in v0.7.0

func (response GetHookSetup422ApplicationProblemPlusJSONResponse) VisitGetHookSetupResponse(w http.ResponseWriter) error

type GetHookSetupRequestObject added in v0.7.0

type GetHookSetupRequestObject struct {
}

type GetHookSetupResponseObject added in v0.7.0

type GetHookSetupResponseObject interface {
	VisitGetHookSetupResponse(w http.ResponseWriter) error
}

type GetHookSetupdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type GetHookSetupdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetHookSetupdefaultApplicationProblemPlusJSONResponse) VisitGetHookSetupResponse added in v0.7.0

type GetIssue200JSONResponse

type GetIssue200JSONResponse IssueDetail

func (GetIssue200JSONResponse) VisitGetIssueResponse

func (response GetIssue200JSONResponse) VisitGetIssueResponse(w http.ResponseWriter) error

type GetIssue404ApplicationProblemPlusJSONResponse added in v0.3.0

type GetIssue404ApplicationProblemPlusJSONResponse Problem

func (GetIssue404ApplicationProblemPlusJSONResponse) VisitGetIssueResponse added in v0.3.0

func (response GetIssue404ApplicationProblemPlusJSONResponse) VisitGetIssueResponse(w http.ResponseWriter) error

type GetIssueRequestObject

type GetIssueRequestObject struct {
	Key string `json:"key"`
}

type GetIssueResponseObject

type GetIssueResponseObject interface {
	VisitGetIssueResponse(w http.ResponseWriter) error
}

type GetIssuedefaultApplicationProblemPlusJSONResponse added in v0.3.0

type GetIssuedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetIssuedefaultApplicationProblemPlusJSONResponse) VisitGetIssueResponse added in v0.3.0

type GetKeys200JSONResponse added in v0.7.0

type GetKeys200JSONResponse KeyList

func (GetKeys200JSONResponse) VisitGetKeysResponse added in v0.7.0

func (response GetKeys200JSONResponse) VisitGetKeysResponse(w http.ResponseWriter) error

type GetKeysRequestObject added in v0.7.0

type GetKeysRequestObject struct {
}

type GetKeysResponseObject added in v0.7.0

type GetKeysResponseObject interface {
	VisitGetKeysResponse(w http.ResponseWriter) error
}

type GetKeysdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type GetKeysdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetKeysdefaultApplicationProblemPlusJSONResponse) VisitGetKeysResponse added in v0.7.0

type GetLocalData200JSONResponse added in v0.5.0

type GetLocalData200JSONResponse LocalData

func (GetLocalData200JSONResponse) VisitGetLocalDataResponse added in v0.5.0

func (response GetLocalData200JSONResponse) VisitGetLocalDataResponse(w http.ResponseWriter) error

type GetLocalData422ApplicationProblemPlusJSONResponse added in v0.5.0

type GetLocalData422ApplicationProblemPlusJSONResponse Problem

func (GetLocalData422ApplicationProblemPlusJSONResponse) VisitGetLocalDataResponse added in v0.5.0

func (response GetLocalData422ApplicationProblemPlusJSONResponse) VisitGetLocalDataResponse(w http.ResponseWriter) error

type GetLocalDataRequestObject added in v0.5.0

type GetLocalDataRequestObject struct {
}

type GetLocalDataResponseObject added in v0.5.0

type GetLocalDataResponseObject interface {
	VisitGetLocalDataResponse(w http.ResponseWriter) error
}

type GetLocalDatadefaultApplicationProblemPlusJSONResponse added in v0.5.0

type GetLocalDatadefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetLocalDatadefaultApplicationProblemPlusJSONResponse) VisitGetLocalDataResponse added in v0.5.0

type GetMergeMethods200JSONResponse added in v0.7.0

type GetMergeMethods200JSONResponse MergeOffer

func (GetMergeMethods200JSONResponse) VisitGetMergeMethodsResponse added in v0.7.0

func (response GetMergeMethods200JSONResponse) VisitGetMergeMethodsResponse(w http.ResponseWriter) error

type GetMergeMethods409ApplicationProblemPlusJSONResponse added in v0.7.0

type GetMergeMethods409ApplicationProblemPlusJSONResponse Problem

func (GetMergeMethods409ApplicationProblemPlusJSONResponse) VisitGetMergeMethodsResponse added in v0.7.0

func (response GetMergeMethods409ApplicationProblemPlusJSONResponse) VisitGetMergeMethodsResponse(w http.ResponseWriter) error

type GetMergeMethods422ApplicationProblemPlusJSONResponse added in v0.7.0

type GetMergeMethods422ApplicationProblemPlusJSONResponse Problem

func (GetMergeMethods422ApplicationProblemPlusJSONResponse) VisitGetMergeMethodsResponse added in v0.7.0

func (response GetMergeMethods422ApplicationProblemPlusJSONResponse) VisitGetMergeMethodsResponse(w http.ResponseWriter) error

type GetMergeMethodsRequestObject added in v0.7.0

type GetMergeMethodsRequestObject struct {
}

type GetMergeMethodsResponseObject added in v0.7.0

type GetMergeMethodsResponseObject interface {
	VisitGetMergeMethodsResponse(w http.ResponseWriter) error
}

type GetMergeMethodsdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type GetMergeMethodsdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetMergeMethodsdefaultApplicationProblemPlusJSONResponse) VisitGetMergeMethodsResponse added in v0.7.0

func (response GetMergeMethodsdefaultApplicationProblemPlusJSONResponse) VisitGetMergeMethodsResponse(w http.ResponseWriter) error

type GetMessaging200JSONResponse added in v0.2.0

type GetMessaging200JSONResponse MessagingDestination

func (GetMessaging200JSONResponse) VisitGetMessagingResponse added in v0.2.0

func (response GetMessaging200JSONResponse) VisitGetMessagingResponse(w http.ResponseWriter) error

type GetMessagingRequestObject added in v0.2.0

type GetMessagingRequestObject struct {
}

type GetMessagingResponseObject added in v0.2.0

type GetMessagingResponseObject interface {
	VisitGetMessagingResponse(w http.ResponseWriter) error
}

type GetMessagingdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type GetMessagingdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetMessagingdefaultApplicationProblemPlusJSONResponse) VisitGetMessagingResponse added in v0.3.0

type GetPeople200JSONResponse added in v0.5.0

type GetPeople200JSONResponse People

func (GetPeople200JSONResponse) VisitGetPeopleResponse added in v0.5.0

func (response GetPeople200JSONResponse) VisitGetPeopleResponse(w http.ResponseWriter) error

type GetPeople422ApplicationProblemPlusJSONResponse added in v0.5.0

type GetPeople422ApplicationProblemPlusJSONResponse Problem

func (GetPeople422ApplicationProblemPlusJSONResponse) VisitGetPeopleResponse added in v0.5.0

func (response GetPeople422ApplicationProblemPlusJSONResponse) VisitGetPeopleResponse(w http.ResponseWriter) error

type GetPeopleRequestObject added in v0.5.0

type GetPeopleRequestObject struct {
}

type GetPeopleResponseObject added in v0.5.0

type GetPeopleResponseObject interface {
	VisitGetPeopleResponse(w http.ResponseWriter) error
}

type GetPeopledefaultApplicationProblemPlusJSONResponse added in v0.5.0

type GetPeopledefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetPeopledefaultApplicationProblemPlusJSONResponse) VisitGetPeopleResponse added in v0.5.0

type GetPullRequestDraft200JSONResponse added in v0.0.7

type GetPullRequestDraft200JSONResponse PullRequestDraft

func (GetPullRequestDraft200JSONResponse) VisitGetPullRequestDraftResponse added in v0.0.7

func (response GetPullRequestDraft200JSONResponse) VisitGetPullRequestDraftResponse(w http.ResponseWriter) error

type GetPullRequestDraft404ApplicationProblemPlusJSONResponse added in v0.7.0

type GetPullRequestDraft404ApplicationProblemPlusJSONResponse Problem

func (GetPullRequestDraft404ApplicationProblemPlusJSONResponse) VisitGetPullRequestDraftResponse added in v0.7.0

func (response GetPullRequestDraft404ApplicationProblemPlusJSONResponse) VisitGetPullRequestDraftResponse(w http.ResponseWriter) error

type GetPullRequestDraft409ApplicationProblemPlusJSONResponse added in v0.3.0

type GetPullRequestDraft409ApplicationProblemPlusJSONResponse Problem

func (GetPullRequestDraft409ApplicationProblemPlusJSONResponse) VisitGetPullRequestDraftResponse added in v0.3.0

func (response GetPullRequestDraft409ApplicationProblemPlusJSONResponse) VisitGetPullRequestDraftResponse(w http.ResponseWriter) error

type GetPullRequestDraftParams added in v0.7.0

type GetPullRequestDraftParams struct {
	// Template The template to start the body from, by name; the repository's first when omitted.
	Template *string `form:"template,omitempty" json:"template,omitempty"`

	// Base The branch to merge into, by name, as the form's base field names it; the base the branch left when omitted.
	Base *string `form:"base,omitempty" json:"base,omitempty"`
}

GetPullRequestDraftParams defines parameters for GetPullRequestDraft.

type GetPullRequestDraftRequestObject added in v0.0.7

type GetPullRequestDraftRequestObject struct {
	Params GetPullRequestDraftParams
}

type GetPullRequestDraftResponseObject added in v0.0.7

type GetPullRequestDraftResponseObject interface {
	VisitGetPullRequestDraftResponse(w http.ResponseWriter) error
}

type GetPullRequestDraftdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type GetPullRequestDraftdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetPullRequestDraftdefaultApplicationProblemPlusJSONResponse) VisitGetPullRequestDraftResponse added in v0.3.0

func (response GetPullRequestDraftdefaultApplicationProblemPlusJSONResponse) VisitGetPullRequestDraftResponse(w http.ResponseWriter) error

type GetPullRequestText200JSONResponse added in v0.7.0

type GetPullRequestText200JSONResponse PullRequestText

func (GetPullRequestText200JSONResponse) VisitGetPullRequestTextResponse added in v0.7.0

func (response GetPullRequestText200JSONResponse) VisitGetPullRequestTextResponse(w http.ResponseWriter) error

type GetPullRequestText409ApplicationProblemPlusJSONResponse added in v0.7.0

type GetPullRequestText409ApplicationProblemPlusJSONResponse Problem

func (GetPullRequestText409ApplicationProblemPlusJSONResponse) VisitGetPullRequestTextResponse added in v0.7.0

func (response GetPullRequestText409ApplicationProblemPlusJSONResponse) VisitGetPullRequestTextResponse(w http.ResponseWriter) error

type GetPullRequestTextRequestObject added in v0.7.0

type GetPullRequestTextRequestObject struct {
}

type GetPullRequestTextResponseObject added in v0.7.0

type GetPullRequestTextResponseObject interface {
	VisitGetPullRequestTextResponse(w http.ResponseWriter) error
}

type GetPullRequestTextdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type GetPullRequestTextdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetPullRequestTextdefaultApplicationProblemPlusJSONResponse) VisitGetPullRequestTextResponse added in v0.7.0

func (response GetPullRequestTextdefaultApplicationProblemPlusJSONResponse) VisitGetPullRequestTextResponse(w http.ResponseWriter) error

type GetRepoGroups200JSONResponse added in v0.5.0

type GetRepoGroups200JSONResponse RepoGroups

func (GetRepoGroups200JSONResponse) VisitGetRepoGroupsResponse added in v0.5.0

func (response GetRepoGroups200JSONResponse) VisitGetRepoGroupsResponse(w http.ResponseWriter) error

type GetRepoGroups422ApplicationProblemPlusJSONResponse added in v0.5.0

type GetRepoGroups422ApplicationProblemPlusJSONResponse Problem

func (GetRepoGroups422ApplicationProblemPlusJSONResponse) VisitGetRepoGroupsResponse added in v0.5.0

func (response GetRepoGroups422ApplicationProblemPlusJSONResponse) VisitGetRepoGroupsResponse(w http.ResponseWriter) error

type GetRepoGroupsRequestObject added in v0.5.0

type GetRepoGroupsRequestObject struct {
}

type GetRepoGroupsResponseObject added in v0.5.0

type GetRepoGroupsResponseObject interface {
	VisitGetRepoGroupsResponse(w http.ResponseWriter) error
}

type GetRepoGroupsdefaultApplicationProblemPlusJSONResponse added in v0.5.0

type GetRepoGroupsdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetRepoGroupsdefaultApplicationProblemPlusJSONResponse) VisitGetRepoGroupsResponse added in v0.5.0

type GetRepositories200JSONResponse added in v0.6.0

type GetRepositories200JSONResponse Repositories

func (GetRepositories200JSONResponse) VisitGetRepositoriesResponse added in v0.6.0

func (response GetRepositories200JSONResponse) VisitGetRepositoriesResponse(w http.ResponseWriter) error

type GetRepositoriesRequestObject added in v0.6.0

type GetRepositoriesRequestObject struct {
}

type GetRepositoriesResponseObject added in v0.6.0

type GetRepositoriesResponseObject interface {
	VisitGetRepositoriesResponse(w http.ResponseWriter) error
}

type GetRepositoriesdefaultApplicationProblemPlusJSONResponse added in v0.6.0

type GetRepositoriesdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetRepositoriesdefaultApplicationProblemPlusJSONResponse) VisitGetRepositoriesResponse added in v0.6.0

func (response GetRepositoriesdefaultApplicationProblemPlusJSONResponse) VisitGetRepositoriesResponse(w http.ResponseWriter) error

type GetReview200JSONResponse

type GetReview200JSONResponse Review

func (GetReview200JSONResponse) VisitGetReviewResponse

func (response GetReview200JSONResponse) VisitGetReviewResponse(w http.ResponseWriter) error

type GetReviewRequestObject

type GetReviewRequestObject struct {
}

type GetReviewResponseObject

type GetReviewResponseObject interface {
	VisitGetReviewResponse(w http.ResponseWriter) error
}

type GetReviewdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type GetReviewdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetReviewdefaultApplicationProblemPlusJSONResponse) VisitGetReviewResponse added in v0.3.0

type GetSetup200JSONResponse added in v0.7.0

type GetSetup200JSONResponse SetupOffer

func (GetSetup200JSONResponse) VisitGetSetupResponse added in v0.7.0

func (response GetSetup200JSONResponse) VisitGetSetupResponse(w http.ResponseWriter) error

type GetSetupRequestObject added in v0.7.0

type GetSetupRequestObject struct {
}

type GetSetupResponseObject added in v0.7.0

type GetSetupResponseObject interface {
	VisitGetSetupResponse(w http.ResponseWriter) error
}

type GetSetupdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type GetSetupdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetSetupdefaultApplicationProblemPlusJSONResponse) VisitGetSetupResponse added in v0.7.0

type GetSlackGroups200JSONResponse added in v0.5.0

type GetSlackGroups200JSONResponse SlackDirectory

func (GetSlackGroups200JSONResponse) VisitGetSlackGroupsResponse added in v0.5.0

func (response GetSlackGroups200JSONResponse) VisitGetSlackGroupsResponse(w http.ResponseWriter) error

type GetSlackGroups422ApplicationProblemPlusJSONResponse added in v0.5.0

type GetSlackGroups422ApplicationProblemPlusJSONResponse Problem

func (GetSlackGroups422ApplicationProblemPlusJSONResponse) VisitGetSlackGroupsResponse added in v0.5.0

func (response GetSlackGroups422ApplicationProblemPlusJSONResponse) VisitGetSlackGroupsResponse(w http.ResponseWriter) error

type GetSlackGroupsRequestObject added in v0.5.0

type GetSlackGroupsRequestObject struct {
}

type GetSlackGroupsResponseObject added in v0.5.0

type GetSlackGroupsResponseObject interface {
	VisitGetSlackGroupsResponse(w http.ResponseWriter) error
}

type GetSlackGroupsdefaultApplicationProblemPlusJSONResponse added in v0.5.0

type GetSlackGroupsdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetSlackGroupsdefaultApplicationProblemPlusJSONResponse) VisitGetSlackGroupsResponse added in v0.5.0

func (response GetSlackGroupsdefaultApplicationProblemPlusJSONResponse) VisitGetSlackGroupsResponse(w http.ResponseWriter) error

type GetSlackMembers200JSONResponse added in v0.5.0

type GetSlackMembers200JSONResponse SlackDirectory

func (GetSlackMembers200JSONResponse) VisitGetSlackMembersResponse added in v0.5.0

func (response GetSlackMembers200JSONResponse) VisitGetSlackMembersResponse(w http.ResponseWriter) error

type GetSlackMembers422ApplicationProblemPlusJSONResponse added in v0.5.0

type GetSlackMembers422ApplicationProblemPlusJSONResponse Problem

func (GetSlackMembers422ApplicationProblemPlusJSONResponse) VisitGetSlackMembersResponse added in v0.5.0

func (response GetSlackMembers422ApplicationProblemPlusJSONResponse) VisitGetSlackMembersResponse(w http.ResponseWriter) error

type GetSlackMembersParams added in v0.5.0

type GetSlackMembersParams struct {
	// Channel The channel, by name or ID; the configured channel when left out.
	Channel *string `form:"channel,omitempty" json:"channel,omitempty"`
}

GetSlackMembersParams defines parameters for GetSlackMembers.

type GetSlackMembersRequestObject added in v0.5.0

type GetSlackMembersRequestObject struct {
	Params GetSlackMembersParams
}

type GetSlackMembersResponseObject added in v0.5.0

type GetSlackMembersResponseObject interface {
	VisitGetSlackMembersResponse(w http.ResponseWriter) error
}

type GetSlackMembersdefaultApplicationProblemPlusJSONResponse added in v0.5.0

type GetSlackMembersdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (GetSlackMembersdefaultApplicationProblemPlusJSONResponse) VisitGetSlackMembersResponse added in v0.5.0

func (response GetSlackMembersdefaultApplicationProblemPlusJSONResponse) VisitGetSlackMembersResponse(w http.ResponseWriter) error

type GitOnlyHook added in v0.10.0

type GitOnlyHook struct {
	// Name Example: commit-msg
	Name string `json:"name"`

	// Reason What git hands it that a run by hand would not.
	//
	// Example: git hands it the file holding the commit message
	Reason string `json:"reason"`
}

GitOnlyHook A hook only git runs, and why.

type GroupTag added in v0.5.0

type GroupTag struct {
	// Checked Whether it starts checked — a team owning the changed paths links it, or it was chosen last time.
	Checked bool `json:"checked"`

	// FromOwners Whether it is offered because a team owning the changed paths is linked to it.
	FromOwners bool `json:"from_owners"`

	// Slack A Slack user or user group, by its ID and the name Slack shows for it.
	Slack SlackTarget `json:"slack"`
}

GroupTag A user group an announcement offers to tag.

type Health

type Health struct {
	// DryRun Whether writes are held back (the --dry-run flag).
	DryRun bool `json:"dry_run"`

	// ForgeKind Which forge the repository is on under the settings in effect: forge.kind when it names one, else the one the base remote's host names (upstream's in a fork's clone, else origin's); unknown when neither says, as outside a repository or on a self-hosted forge the settings do not name. What the page decides by, where forge_noun and forge_sigil are only words to show.
	//
	// Example: gitlab
	ForgeKind HealthForgeKind `json:"forge_kind"`

	// ForgeNoun What the repository's forge calls a proposed change, lowercase — a "merge request" on GitLab and a "pull request" everywhere else — so the browser says what the terminal and the command line say.
	//
	// Example: merge request
	ForgeNoun string `json:"forge_noun"`

	// ForgeSigil The mark the forge writes before a proposed change's number: "!" on GitLab, "#" everywhere else.
	//
	// Example: !
	ForgeSigil string `json:"forge_sigil"`

	// Version The binary's version, or a short commit for a dev build.
	Version string `json:"version"`
}

Health defines model for Health.

type HealthForgeKind added in v0.9.0

type HealthForgeKind string

HealthForgeKind Which forge the repository is on under the settings in effect: forge.kind when it names one, else the one the base remote's host names (upstream's in a fork's clone, else origin's); unknown when neither says, as outside a repository or on a self-hosted forge the settings do not name. What the page decides by, where forge_noun and forge_sigil are only words to show.

Example: gitlab

const (
	HealthForgeKindGithub  HealthForgeKind = "github"
	HealthForgeKindGitlab  HealthForgeKind = "gitlab"
	HealthForgeKindUnknown HealthForgeKind = "unknown"
)

Defines values for HealthForgeKind.

func (HealthForgeKind) Valid added in v0.9.0

func (e HealthForgeKind) Valid() bool

Valid indicates whether the value is a known member of the HealthForgeKind enum.

type HookSetup added in v0.7.0

type HookSetup struct {
	// Config The lefthook.yml that would run them; empty when nothing is offered.
	Config string `json:"config"`

	// Hooks The hooks found that lefthook does not manage.
	Hooks []UnmanagedHook `json:"hooks"`

	// Offered Whether there is anything to set up.
	Offered bool `json:"offered"`

	// Scripts How many hooks it keeps whole as scripts under .lefthook.
	Scripts int `json:"scripts"`
}

HookSetup The lefthook configuration offered for hooks lefthook does not manage.

type HookSetupRequest added in v0.7.0

type HookSetupRequest struct {
	// Verbatim Keep every hook whole as a script rather than turning plain commands into lefthook jobs.
	Verbatim *bool `json:"verbatim,omitempty"`
}

HookSetupRequest defines model for HookSetupRequest.

type HookSetupWritten added in v0.7.0

type HookSetupWritten struct {
	// Scripts How many scripts were written under .lefthook beside lefthook.yml.
	Scripts int `json:"scripts"`
}

HookSetupWritten defines model for HookSetupWritten.

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type Issue

type Issue struct {
	// Key Example: PROJ-412
	Key string `json:"key"`

	// Priority Absent when the issue has none.
	Priority *string `json:"priority,omitempty"`

	// Status The human status name, such as "In Progress".
	Status         string         `json:"status"`
	StatusCategory StatusCategory `json:"status_category"`
	Summary        string         `json:"summary"`

	// Tracker Where the issue lives: Jira, keyed like PROJ-412, or the repository's own forge, GitHub or GitLab, keyed by its number.
	Tracker IssueTracker `json:"tracker"`

	// Type The issue type name, such as Bug or Story.
	Type string `json:"type"`
}

Issue defines model for Issue.

type IssueDetail

type IssueDetail struct {
	// Assignee Who the issue is assigned to; absent when no one is.
	Assignee *string `json:"assignee,omitempty"`

	// CommentTotal The total on the issue, which may exceed those returned.
	CommentTotal int `json:"comment_total"`

	// Comments Oldest first.
	Comments       []Comment      `json:"comments"`
	Description    string         `json:"description"`
	Key            string         `json:"key"`
	Priority       *string        `json:"priority,omitempty"`
	Reporter       string         `json:"reporter"`
	Status         string         `json:"status"`
	StatusCategory StatusCategory `json:"status_category"`
	Summary        string         `json:"summary"`

	// Tracker Where the issue lives: Jira, keyed like PROJ-412, or the repository's own forge, GitHub or GitLab, keyed by its number.
	Tracker IssueTracker `json:"tracker"`
	Type    string       `json:"type"`

	// URL The issue in the tracker's own web interface, for a link to open. Empty when the tracker's base URL cannot be read; never carries the base URL's username or password.
	URL string `json:"url"`
}

IssueDetail defines model for IssueDetail.

type IssueTracker added in v0.5.0

type IssueTracker string

IssueTracker Where the issue lives: Jira, keyed like PROJ-412, or the repository's own forge, GitHub or GitLab, keyed by its number.

const (
	IssueTrackerForge IssueTracker = "forge"
	IssueTrackerJira  IssueTracker = "jira"
)

Defines values for IssueTracker.

func (IssueTracker) Valid added in v0.5.0

func (e IssueTracker) Valid() bool

Valid indicates whether the value is a known member of the IssueTracker enum.

type IssuesConfig added in v0.5.0

type IssuesConfig struct {
	// Forge List the issues assigned to you on this repository's own forge, GitHub or GitLab, beside Jira's. Set per repository, over the home file's default.
	Forge *bool `json:"forge,omitempty"`
}

IssuesConfig defines model for IssuesConfig.

type IssuesPage

type IssuesPage struct {
	Issues []Issue `json:"issues"`

	// StartAt The index of the first issue in this page.
	StartAt int `json:"start_at"`

	// Total How many issues the view matches in all.
	Total int `json:"total"`

	// Unavailable Each tracker a list drawing on Jira and the forge together could not read, so what is listed is not taken for all there is. Empty when every tracker answered.
	Unavailable []string `json:"unavailable"`
}

IssuesPage defines model for IssuesPage.

type JiraConfig

type JiraConfig struct {
	BaseURL *string `json:"base_url,omitempty"`

	// Headers Extra request headers; values masked on read. On write, a value empty or masked keeps the stored one, and a header left out is removed.
	Headers *map[string]string `json:"headers,omitempty"`

	// Keychain Read the token from the OS keychain item kept for base_url (macOS), one item for each address, so a token is only ever read back for the address it was kept for. After the file's own token, and before token_env and token_command.
	Keychain *bool `json:"keychain,omitempty"`

	// MarkdownComments Post comments written in Markdown as Jira's wiki markup.
	MarkdownComments *bool   `json:"markdown_comments,omitempty"`
	Project          *string `json:"project,omitempty"`

	// ReviewStatus The status an issue moves to once its pull request is open, e.g. "In Review". Empty makes no offer.
	ReviewStatus *string `json:"review_status,omitempty"`

	// Token Masked on read, or empty when none is stored; on write, empty or masked keeps the stored value and null removes it.
	Token *string `json:"token"`

	// TokenCommand A program that prints the token. workflow runs it as you, so a save keeps it as the file holds it, left out or not; one carrying another value is refused 422. It changes only in the file.
	TokenCommand *string `json:"token_command,omitempty"`

	// TokenEnv An environment variable that holds the token. Held as token_command is: a save keeps it, and one carrying another value is refused 422.
	TokenEnv *string     `json:"token_env,omitempty"`
	User     *string     `json:"user,omitempty"`
	Views    *[]JiraView `json:"views,omitempty"`
}

JiraConfig defines model for JiraConfig.

type JiraView

type JiraView struct {
	// Jql The query the view searches: a configured view's JQL narrowed to the issues assigned to you, unless it already names the assignee.
	Jql  string `json:"jql"`
	Name string `json:"name"`
}

JiraView defines model for JiraView.

type JobLog added in v0.5.0

type JobLog struct {
	// Text The log's last lines, with every terminal control taken out.
	Text string `json:"text"`

	// Truncated Whether the log ran on before the lines kept.
	Truncated bool `json:"truncated"`
}

JobLog defines model for JobLog.

type KeyAction added in v0.7.0

type KeyAction struct {
	// Action The action's name, as ui.keys names it, e.g. comment.
	Action string `json:"action"`

	// Default The key the help shows for it with no ui.keys entry, e.g. c.
	Default string `json:"default"`

	// Group The help group it is listed under, e.g. Issues.
	Group string `json:"group"`

	// Help The words the help says it in, e.g. change status.
	Help string `json:"help"`

	// Keys Every key that triggers it, in the terminal's names, e.g. c, C, ctrl+e.
	Keys []string `json:"keys"`

	// Shown The key the help shows, e.g. c, or 1-9 for the pane numbers.
	Shown string `json:"shown"`
}

KeyAction One action the terminal interface binds, as its help lists it.

type KeyList added in v0.7.0

type KeyList struct {
	Actions []KeyAction `json:"actions"`

	// PaneSections The page's section each of the terminal's panes is shown in, in the panes' order, which is the order of jump-to-pane's keys: the Commits pane, the third, is part of the Branch section, so two pane numbers open it. The terminal's key check reads the same list, and refuses a key two panes shown in one section share. Empty where the server lists no keys.
	PaneSections []PaneSection `json:"pane_sections"`

	// SingleKeyShortcuts Whether a single key pressed outside a text field acts (ui.web_shortcuts).
	SingleKeyShortcuts bool `json:"single_key_shortcuts"`
}

KeyList defines model for KeyList.

type LinkBranchIssue200JSONResponse added in v0.5.0

type LinkBranchIssue200JSONResponse Branch

func (LinkBranchIssue200JSONResponse) VisitLinkBranchIssueResponse added in v0.5.0

func (response LinkBranchIssue200JSONResponse) VisitLinkBranchIssueResponse(w http.ResponseWriter) error

type LinkBranchIssue409ApplicationProblemPlusJSONResponse added in v0.5.0

type LinkBranchIssue409ApplicationProblemPlusJSONResponse Problem

func (LinkBranchIssue409ApplicationProblemPlusJSONResponse) VisitLinkBranchIssueResponse added in v0.5.0

func (response LinkBranchIssue409ApplicationProblemPlusJSONResponse) VisitLinkBranchIssueResponse(w http.ResponseWriter) error

type LinkBranchIssue422ApplicationProblemPlusJSONResponse added in v0.5.0

type LinkBranchIssue422ApplicationProblemPlusJSONResponse Problem

func (LinkBranchIssue422ApplicationProblemPlusJSONResponse) VisitLinkBranchIssueResponse added in v0.5.0

func (response LinkBranchIssue422ApplicationProblemPlusJSONResponse) VisitLinkBranchIssueResponse(w http.ResponseWriter) error

type LinkBranchIssueJSONRequestBody added in v0.5.0

type LinkBranchIssueJSONRequestBody = BranchIssueRequest

LinkBranchIssueJSONRequestBody defines body for LinkBranchIssue for application/json ContentType.

type LinkBranchIssueRequestObject added in v0.5.0

type LinkBranchIssueRequestObject struct {
	Body *LinkBranchIssueJSONRequestBody
}

type LinkBranchIssueResponseObject added in v0.5.0

type LinkBranchIssueResponseObject interface {
	VisitLinkBranchIssueResponse(w http.ResponseWriter) error
}

type LinkBranchIssuedefaultApplicationProblemPlusJSONResponse added in v0.5.0

type LinkBranchIssuedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (LinkBranchIssuedefaultApplicationProblemPlusJSONResponse) VisitLinkBranchIssueResponse added in v0.5.0

func (response LinkBranchIssuedefaultApplicationProblemPlusJSONResponse) VisitLinkBranchIssueResponse(w http.ResponseWriter) error

type LinkPerson200JSONResponse added in v0.5.0

type LinkPerson200JSONResponse People

func (LinkPerson200JSONResponse) VisitLinkPersonResponse added in v0.5.0

func (response LinkPerson200JSONResponse) VisitLinkPersonResponse(w http.ResponseWriter) error

type LinkPerson422ApplicationProblemPlusJSONResponse added in v0.5.0

type LinkPerson422ApplicationProblemPlusJSONResponse Problem

func (LinkPerson422ApplicationProblemPlusJSONResponse) VisitLinkPersonResponse added in v0.5.0

func (response LinkPerson422ApplicationProblemPlusJSONResponse) VisitLinkPersonResponse(w http.ResponseWriter) error

type LinkPersonJSONRequestBody added in v0.5.0

type LinkPersonJSONRequestBody = PersonLink

LinkPersonJSONRequestBody defines body for LinkPerson for application/json ContentType.

type LinkPersonRequestObject added in v0.5.0

type LinkPersonRequestObject struct {
	Body *LinkPersonJSONRequestBody
}

type LinkPersonResponseObject added in v0.5.0

type LinkPersonResponseObject interface {
	VisitLinkPersonResponse(w http.ResponseWriter) error
}

type LinkPersondefaultApplicationProblemPlusJSONResponse added in v0.5.0

type LinkPersondefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (LinkPersondefaultApplicationProblemPlusJSONResponse) VisitLinkPersonResponse added in v0.5.0

type LinkPullRequest200JSONResponse added in v0.3.0

type LinkPullRequest200JSONResponse PullRequest

func (LinkPullRequest200JSONResponse) VisitLinkPullRequestResponse added in v0.3.0

func (response LinkPullRequest200JSONResponse) VisitLinkPullRequestResponse(w http.ResponseWriter) error

type LinkPullRequest409ApplicationProblemPlusJSONResponse added in v0.3.0

type LinkPullRequest409ApplicationProblemPlusJSONResponse Problem

func (LinkPullRequest409ApplicationProblemPlusJSONResponse) VisitLinkPullRequestResponse added in v0.3.0

func (response LinkPullRequest409ApplicationProblemPlusJSONResponse) VisitLinkPullRequestResponse(w http.ResponseWriter) error

type LinkPullRequest422ApplicationProblemPlusJSONResponse added in v0.3.0

type LinkPullRequest422ApplicationProblemPlusJSONResponse Problem

func (LinkPullRequest422ApplicationProblemPlusJSONResponse) VisitLinkPullRequestResponse added in v0.3.0

func (response LinkPullRequest422ApplicationProblemPlusJSONResponse) VisitLinkPullRequestResponse(w http.ResponseWriter) error

type LinkPullRequestRequestObject added in v0.3.0

type LinkPullRequestRequestObject struct {
	Key string `json:"key"`
}

type LinkPullRequestResponseObject added in v0.3.0

type LinkPullRequestResponseObject interface {
	VisitLinkPullRequestResponse(w http.ResponseWriter) error
}

type LinkPullRequestdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type LinkPullRequestdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (LinkPullRequestdefaultApplicationProblemPlusJSONResponse) VisitLinkPullRequestResponse added in v0.3.0

func (response LinkPullRequestdefaultApplicationProblemPlusJSONResponse) VisitLinkPullRequestResponse(w http.ResponseWriter) error

type LinkedIssue added in v0.5.0

type LinkedIssue struct {
	// Key The issue's key, a forge number without its #.
	Key string `json:"key"`

	// Origin Where the issue was found: the link the branch was given by hand, the branch's name, or the pull request's title or description.
	Origin LinkedIssueOrigin `json:"origin"`

	// Tracker Where the issue lives: Jira, keyed like PROJ-412, or the repository's own forge, GitHub or GitLab, keyed by its number.
	Tracker IssueTracker `json:"tracker"`

	// URL The issue's page, for a link to open; empty when the tracker gives none.
	URL string `json:"url"`
}

LinkedIssue defines model for LinkedIssue.

type LinkedIssueOrigin added in v0.5.0

type LinkedIssueOrigin string

LinkedIssueOrigin Where the issue was found: the link the branch was given by hand, the branch's name, or the pull request's title or description.

const (
	LinkedIssueOriginBranchName  LinkedIssueOrigin = "branch_name"
	LinkedIssueOriginByHand      LinkedIssueOrigin = "by_hand"
	LinkedIssueOriginPullRequest LinkedIssueOrigin = "pull_request"
)

Defines values for LinkedIssueOrigin.

func (LinkedIssueOrigin) Valid added in v0.5.0

func (e LinkedIssueOrigin) Valid() bool

Valid indicates whether the value is a known member of the LinkedIssueOrigin enum.

type ListChanges200JSONResponse

type ListChanges200JSONResponse ChangeList

func (ListChanges200JSONResponse) VisitListChangesResponse

func (response ListChanges200JSONResponse) VisitListChangesResponse(w http.ResponseWriter) error

type ListChangesRequestObject

type ListChangesRequestObject struct {
}

type ListChangesResponseObject

type ListChangesResponseObject interface {
	VisitListChangesResponse(w http.ResponseWriter) error
}

type ListChangesdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type ListChangesdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ListChangesdefaultApplicationProblemPlusJSONResponse) VisitListChangesResponse added in v0.3.0

type ListHooks200JSONResponse added in v0.10.0

type ListHooks200JSONResponse ConfiguredHooks

func (ListHooks200JSONResponse) VisitListHooksResponse added in v0.10.0

func (response ListHooks200JSONResponse) VisitListHooksResponse(w http.ResponseWriter) error

type ListHooks422ApplicationProblemPlusJSONResponse added in v0.10.0

type ListHooks422ApplicationProblemPlusJSONResponse Problem

func (ListHooks422ApplicationProblemPlusJSONResponse) VisitListHooksResponse added in v0.10.0

func (response ListHooks422ApplicationProblemPlusJSONResponse) VisitListHooksResponse(w http.ResponseWriter) error

type ListHooksRequestObject added in v0.10.0

type ListHooksRequestObject struct {
}

type ListHooksResponseObject added in v0.10.0

type ListHooksResponseObject interface {
	VisitListHooksResponse(w http.ResponseWriter) error
}

type ListHooksdefaultApplicationProblemPlusJSONResponse added in v0.10.0

type ListHooksdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ListHooksdefaultApplicationProblemPlusJSONResponse) VisitListHooksResponse added in v0.10.0

type ListIssues200JSONResponse

type ListIssues200JSONResponse IssuesPage

func (ListIssues200JSONResponse) VisitListIssuesResponse

func (response ListIssues200JSONResponse) VisitListIssuesResponse(w http.ResponseWriter) error

type ListIssues404ApplicationProblemPlusJSONResponse added in v0.3.0

type ListIssues404ApplicationProblemPlusJSONResponse Problem

func (ListIssues404ApplicationProblemPlusJSONResponse) VisitListIssuesResponse added in v0.3.0

func (response ListIssues404ApplicationProblemPlusJSONResponse) VisitListIssuesResponse(w http.ResponseWriter) error

type ListIssuesParams

type ListIssuesParams struct {
	// View The configured view's name; the default view when omitted.
	View *string `form:"view,omitempty" json:"view,omitempty"`

	// StartAt The zero-based index of the first issue to return.
	StartAt *int `form:"start_at,omitempty" json:"start_at,omitempty"`
}

ListIssuesParams defines parameters for ListIssues.

type ListIssuesRequestObject

type ListIssuesRequestObject struct {
	Params ListIssuesParams
}

type ListIssuesResponseObject

type ListIssuesResponseObject interface {
	VisitListIssuesResponse(w http.ResponseWriter) error
}

type ListIssuesdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type ListIssuesdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ListIssuesdefaultApplicationProblemPlusJSONResponse) VisitListIssuesResponse added in v0.3.0

type ListReviews200JSONResponse added in v0.3.0

type ListReviews200JSONResponse ReviewQueue

func (ListReviews200JSONResponse) VisitListReviewsResponse added in v0.3.0

func (response ListReviews200JSONResponse) VisitListReviewsResponse(w http.ResponseWriter) error

type ListReviewsRequestObject added in v0.3.0

type ListReviewsRequestObject struct {
}

type ListReviewsResponseObject added in v0.3.0

type ListReviewsResponseObject interface {
	VisitListReviewsResponse(w http.ResponseWriter) error
}

type ListReviewsdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type ListReviewsdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ListReviewsdefaultApplicationProblemPlusJSONResponse) VisitListReviewsResponse added in v0.3.0

type ListStatusChanges200JSONResponse added in v0.7.0

type ListStatusChanges200JSONResponse []StatusChange

func (ListStatusChanges200JSONResponse) VisitListStatusChangesResponse added in v0.7.0

func (response ListStatusChanges200JSONResponse) VisitListStatusChangesResponse(w http.ResponseWriter) error

type ListStatusChanges404ApplicationProblemPlusJSONResponse added in v0.7.0

type ListStatusChanges404ApplicationProblemPlusJSONResponse Problem

func (ListStatusChanges404ApplicationProblemPlusJSONResponse) VisitListStatusChangesResponse added in v0.7.0

func (response ListStatusChanges404ApplicationProblemPlusJSONResponse) VisitListStatusChangesResponse(w http.ResponseWriter) error

type ListStatusChanges422ApplicationProblemPlusJSONResponse added in v0.7.0

type ListStatusChanges422ApplicationProblemPlusJSONResponse Problem

func (ListStatusChanges422ApplicationProblemPlusJSONResponse) VisitListStatusChangesResponse added in v0.7.0

func (response ListStatusChanges422ApplicationProblemPlusJSONResponse) VisitListStatusChangesResponse(w http.ResponseWriter) error

type ListStatusChangesRequestObject added in v0.7.0

type ListStatusChangesRequestObject struct {
	Key string `json:"key"`
}

type ListStatusChangesResponseObject added in v0.7.0

type ListStatusChangesResponseObject interface {
	VisitListStatusChangesResponse(w http.ResponseWriter) error
}

type ListStatusChangesdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type ListStatusChangesdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ListStatusChangesdefaultApplicationProblemPlusJSONResponse) VisitListStatusChangesResponse added in v0.7.0

func (response ListStatusChangesdefaultApplicationProblemPlusJSONResponse) VisitListStatusChangesResponse(w http.ResponseWriter) error

type ListTasks200JSONResponse added in v0.4.1

type ListTasks200JSONResponse TaskList

func (ListTasks200JSONResponse) VisitListTasksResponse added in v0.4.1

func (response ListTasks200JSONResponse) VisitListTasksResponse(w http.ResponseWriter) error

type ListTasksRequestObject added in v0.4.1

type ListTasksRequestObject struct {
}

type ListTasksResponseObject added in v0.4.1

type ListTasksResponseObject interface {
	VisitListTasksResponse(w http.ResponseWriter) error
}

type ListTasksdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type ListTasksdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ListTasksdefaultApplicationProblemPlusJSONResponse) VisitListTasksResponse added in v0.4.1

type ListViews200JSONResponse

type ListViews200JSONResponse ViewList

func (ListViews200JSONResponse) VisitListViewsResponse

func (response ListViews200JSONResponse) VisitListViewsResponse(w http.ResponseWriter) error

type ListViewsRequestObject

type ListViewsRequestObject struct {
}

type ListViewsResponseObject

type ListViewsResponseObject interface {
	VisitListViewsResponse(w http.ResponseWriter) error
}

type ListViewsdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type ListViewsdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ListViewsdefaultApplicationProblemPlusJSONResponse) VisitListViewsResponse added in v0.3.0

type LocalData added in v0.5.0

type LocalData struct {
	// Consequences What a removal of each scope takes with it, in the words every surface's last look warns with before anything is removed.
	Consequences LocalDataConsequences `json:"consequences"`

	// Dir The directory the store keeps its files in.
	Dir string `json:"dir"`

	// DryRun Whether the server runs with --dry-run, which refuses a removal.
	DryRun *bool `json:"dry_run,omitempty"`

	// Files Each database file there, the cache first; a file not there is left out.
	Files []LocalDataFile `json:"files"`
}

LocalData The store's directory and the database files in it.

type LocalDataConsequences added in v0.9.0

type LocalDataConsequences struct {
	// All What removing everything takes with it.
	All string `json:"all"`

	// Cache What removing the cache takes with it.
	Cache string `json:"cache"`
}

LocalDataConsequences What a removal of each scope takes with it, in the words every surface's last look warns with before anything is removed.

type LocalDataFile added in v0.5.0

type LocalDataFile struct {
	// Bytes Its size with its -wal and -shm companions.
	Bytes int64 `json:"bytes"`

	// Holds How many of each thing it holds; empty when the file could not be read as a database.
	Holds []LocalDataHeld `json:"holds"`

	// Kind cache holds conveniences a session makes again; kept holds what the user decided, which removing all makes workflow ask again.
	Kind LocalDataFileKind `json:"kind"`

	// Name The file's name in the directory, as workflow.db or kept.db.
	Name string `json:"name"`

	// Size The same size as every surface shows it, in bytes, KiB or MiB.
	//
	// Example: 12.0 KiB
	Size string `json:"size"`
}

LocalDataFile One database file, with its companions counted in its size.

type LocalDataFileKind added in v0.5.0

type LocalDataFileKind string

LocalDataFileKind cache holds conveniences a session makes again; kept holds what the user decided, which removing all makes workflow ask again.

const (
	LocalDataFileKindCache LocalDataFileKind = "cache"
	LocalDataFileKindKept  LocalDataFileKind = "kept"
)

Defines values for LocalDataFileKind.

func (LocalDataFileKind) Valid added in v0.5.0

func (e LocalDataFileKind) Valid() bool

Valid indicates whether the value is a known member of the LocalDataFileKind enum.

type LocalDataHeld added in v0.5.0

type LocalDataHeld struct {
	Count int `json:"count"`

	// What What is counted, as scopes or repository groups.
	What string `json:"what"`
}

LocalDataHeld defines model for LocalDataHeld.

type LogWork200JSONResponse added in v0.7.0

type LogWork200JSONResponse LoggedWork

func (LogWork200JSONResponse) VisitLogWorkResponse added in v0.7.0

func (response LogWork200JSONResponse) VisitLogWorkResponse(w http.ResponseWriter) error

type LogWork404ApplicationProblemPlusJSONResponse added in v0.7.0

type LogWork404ApplicationProblemPlusJSONResponse Problem

func (LogWork404ApplicationProblemPlusJSONResponse) VisitLogWorkResponse added in v0.7.0

func (response LogWork404ApplicationProblemPlusJSONResponse) VisitLogWorkResponse(w http.ResponseWriter) error

type LogWork422ApplicationProblemPlusJSONResponse added in v0.7.0

type LogWork422ApplicationProblemPlusJSONResponse Problem

func (LogWork422ApplicationProblemPlusJSONResponse) VisitLogWorkResponse added in v0.7.0

func (response LogWork422ApplicationProblemPlusJSONResponse) VisitLogWorkResponse(w http.ResponseWriter) error

type LogWorkJSONRequestBody added in v0.7.0

type LogWorkJSONRequestBody = WorklogRequest

LogWorkJSONRequestBody defines body for LogWork for application/json ContentType.

type LogWorkRequestObject added in v0.7.0

type LogWorkRequestObject struct {
	Key  string `json:"key"`
	Body *LogWorkJSONRequestBody
}

type LogWorkResponseObject added in v0.7.0

type LogWorkResponseObject interface {
	VisitLogWorkResponse(w http.ResponseWriter) error
}

type LogWorkdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type LogWorkdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (LogWorkdefaultApplicationProblemPlusJSONResponse) VisitLogWorkResponse added in v0.7.0

type LoggedWork added in v0.7.0

type LoggedWork struct {
	// Key Example: PROJ-412
	Key string `json:"key"`

	// TimeSpent The duration as Jira recorded it.
	//
	// Example: 2h
	TimeSpent string `json:"time_spent"`
}

LoggedWork Work just logged on an issue, as Jira recorded it.

type MergeMethod added in v0.7.0

type MergeMethod string

MergeMethod How a pull request is merged — a merge commit, squashed, or rebased.

const (
	MergeMethodMerge  MergeMethod = "merge"
	MergeMethodRebase MergeMethod = "rebase"
	MergeMethodSquash MergeMethod = "squash"
)

Defines values for MergeMethod.

func (MergeMethod) Valid added in v0.7.0

func (e MergeMethod) Valid() bool

Valid indicates whether the value is a known member of the MergeMethod enum.

type MergeOffer added in v0.7.0

type MergeOffer struct {
	Methods []MergeMethod `json:"methods"`
	Pull    PullRequest   `json:"pull"`
}

MergeOffer The pull request a merge would merge, and the methods its repository permits.

type MergePullRequest200JSONResponse added in v0.7.0

type MergePullRequest200JSONResponse PullRequest

func (MergePullRequest200JSONResponse) VisitMergePullRequestResponse added in v0.7.0

func (response MergePullRequest200JSONResponse) VisitMergePullRequestResponse(w http.ResponseWriter) error

type MergePullRequest409ApplicationProblemPlusJSONResponse added in v0.7.0

type MergePullRequest409ApplicationProblemPlusJSONResponse Problem

func (MergePullRequest409ApplicationProblemPlusJSONResponse) VisitMergePullRequestResponse added in v0.7.0

func (response MergePullRequest409ApplicationProblemPlusJSONResponse) VisitMergePullRequestResponse(w http.ResponseWriter) error

type MergePullRequest422ApplicationProblemPlusJSONResponse added in v0.7.0

type MergePullRequest422ApplicationProblemPlusJSONResponse Problem

func (MergePullRequest422ApplicationProblemPlusJSONResponse) VisitMergePullRequestResponse added in v0.7.0

func (response MergePullRequest422ApplicationProblemPlusJSONResponse) VisitMergePullRequestResponse(w http.ResponseWriter) error

type MergePullRequestJSONRequestBody added in v0.7.0

type MergePullRequestJSONRequestBody = MergeRequest

MergePullRequestJSONRequestBody defines body for MergePullRequest for application/json ContentType.

type MergePullRequestRequestObject added in v0.7.0

type MergePullRequestRequestObject struct {
	Body *MergePullRequestJSONRequestBody
}

type MergePullRequestResponseObject added in v0.7.0

type MergePullRequestResponseObject interface {
	VisitMergePullRequestResponse(w http.ResponseWriter) error
}

type MergePullRequestdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type MergePullRequestdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (MergePullRequestdefaultApplicationProblemPlusJSONResponse) VisitMergePullRequestResponse added in v0.7.0

func (response MergePullRequestdefaultApplicationProblemPlusJSONResponse) VisitMergePullRequestResponse(w http.ResponseWriter) error

type MergeRequest added in v0.7.0

type MergeRequest struct {
	// Method How a pull request is merged — a merge commit, squashed, or rebased.
	Method MergeMethod `json:"method"`
}

MergeRequest defines model for MergeRequest.

type MessagingConfig added in v0.1.0

type MessagingConfig struct {
	// AccessToken The user token's current access token (xoxe.xoxp-…), when this file keeps it. workflow replaces it on every refresh. Masked on read; empty or masked on write keeps the stored value. It goes when the client secret or the refresh token is removed.
	AccessToken  *string `json:"access_token,omitempty"`
	Announcement *string `json:"announcement,omitempty"`

	// AutoAnnounce Arm the announcement of a pull request the terminal or --web opens, to post once its CI passes. On by default; false arms nothing, while asking to announce once CI passes still waits.
	AutoAnnounce *bool     `json:"auto_announce,omitempty"`
	Channel      *string   `json:"channel,omitempty"`
	Channels     *[]string `json:"channels,omitempty"`

	// ClientID The Slack app's client ID, which its rotating user token is refreshed with. Slack only; set together with webhook_url it is refused. Not a secret.
	ClientID *string `json:"client_id,omitempty"`

	// ClientSecret The Slack app's client secret, when this file keeps the user token's credentials rather than the macOS keychain. Masked on read, or empty when none is stored; on write, empty or masked keeps the stored value, and null removes it with the access token.
	ClientSecret *string `json:"client_secret"`

	// ExpiresAt When the access token expires, RFC 3339 UTC; written by workflow.
	ExpiresAt *string `json:"expires_at,omitempty"`

	// Kind The service posts go to. Empty is read as slack. It decides the message body and link markup the notifier sends.
	Kind *MessagingConfigKind `json:"kind,omitempty"`

	// RefreshToken The user token's current refresh token (xoxe-1-…), when this file keeps it. workflow replaces it on every refresh. Masked on read, or empty when none is stored; on write, empty or masked keeps the stored value, and null removes it with the access token.
	RefreshToken *string `json:"refresh_token"`

	// WebhookURL A credential: masked on read, or empty when none is stored; on write, empty or masked keeps the stored value and null removes it.
	WebhookURL *string `json:"webhook_url"`
}

MessagingConfig defines model for MessagingConfig.

type MessagingConfigKind added in v0.1.0

type MessagingConfigKind string

MessagingConfigKind The service posts go to. Empty is read as slack. It decides the message body and link markup the notifier sends.

const (
	MessagingConfigKindDiscord MessagingConfigKind = "discord"
	MessagingConfigKindEmpty   MessagingConfigKind = ""
	MessagingConfigKindSlack   MessagingConfigKind = "slack"
	MessagingConfigKindTeams   MessagingConfigKind = "teams"
	MessagingConfigKindWebhook MessagingConfigKind = "webhook"
)

Defines values for MessagingConfigKind.

func (MessagingConfigKind) Valid added in v0.1.0

func (e MessagingConfigKind) Valid() bool

Valid indicates whether the value is a known member of the MessagingConfigKind enum.

type MessagingDestination added in v0.2.0

type MessagingDestination struct {
	// Author Who a post would come from; empty if not resolved.
	Author string `json:"author"`

	// Channel The default channel; empty when a webhook carries its own.
	Channel string `json:"channel"`

	// Channels The default first, then the alternates.
	Channels []string `json:"channels"`

	// Configured Whether a transport is set up to post — a user token or a webhook. A webhook service has no channel, so channel presence cannot stand in for this.
	Configured bool `json:"configured"`

	// Kind The service posts go to, for a client to switch on.
	Kind MessagingDestinationKind `json:"kind"`

	// Service The service's name, for showing — Slack, Teams, Discord or Webhook; kind is what to switch on.
	Service string `json:"service"`
}

MessagingDestination defines model for MessagingDestination.

type MessagingDestinationKind added in v0.9.0

type MessagingDestinationKind string

MessagingDestinationKind The service posts go to, for a client to switch on.

const (
	MessagingDestinationKindDiscord MessagingDestinationKind = "discord"
	MessagingDestinationKindSlack   MessagingDestinationKind = "slack"
	MessagingDestinationKindTeams   MessagingDestinationKind = "teams"
	MessagingDestinationKindWebhook MessagingDestinationKind = "webhook"
)

Defines values for MessagingDestinationKind.

func (MessagingDestinationKind) Valid added in v0.9.0

func (e MessagingDestinationKind) Valid() bool

Valid indicates whether the value is a known member of the MessagingDestinationKind enum.

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type ModifyTask200JSONResponse added in v0.4.1

type ModifyTask200JSONResponse TaskList

func (ModifyTask200JSONResponse) VisitModifyTaskResponse added in v0.4.1

func (response ModifyTask200JSONResponse) VisitModifyTaskResponse(w http.ResponseWriter) error

type ModifyTask409ApplicationProblemPlusJSONResponse added in v0.4.1

type ModifyTask409ApplicationProblemPlusJSONResponse Problem

func (ModifyTask409ApplicationProblemPlusJSONResponse) VisitModifyTaskResponse added in v0.4.1

func (response ModifyTask409ApplicationProblemPlusJSONResponse) VisitModifyTaskResponse(w http.ResponseWriter) error

type ModifyTask422ApplicationProblemPlusJSONResponse added in v0.4.1

type ModifyTask422ApplicationProblemPlusJSONResponse Problem

func (ModifyTask422ApplicationProblemPlusJSONResponse) VisitModifyTaskResponse added in v0.4.1

func (response ModifyTask422ApplicationProblemPlusJSONResponse) VisitModifyTaskResponse(w http.ResponseWriter) error

type ModifyTaskJSONRequestBody added in v0.4.1

type ModifyTaskJSONRequestBody = TaskLine

ModifyTaskJSONRequestBody defines body for ModifyTask for application/json ContentType.

type ModifyTaskRequestObject added in v0.4.1

type ModifyTaskRequestObject struct {
	UUID TaskUUID `json:"uuid"`
	Body *ModifyTaskJSONRequestBody
}

type ModifyTaskResponseObject added in v0.4.1

type ModifyTaskResponseObject interface {
	VisitModifyTaskResponse(w http.ResponseWriter) error
}

type ModifyTaskdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type ModifyTaskdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (ModifyTaskdefaultApplicationProblemPlusJSONResponse) VisitModifyTaskResponse added in v0.4.1

type MovedIssue added in v0.3.0

type MovedIssue struct {
	// Key Example: PROJ-412
	Key string `json:"key"`

	// Status Example: In Review
	Status string `json:"status"`
}

MovedIssue An issue that was just moved, and the status it is now in.

type OpenPullRequest200JSONResponse added in v0.0.7

type OpenPullRequest200JSONResponse OpenedPullRequest

func (OpenPullRequest200JSONResponse) VisitOpenPullRequestResponse added in v0.0.7

func (response OpenPullRequest200JSONResponse) VisitOpenPullRequestResponse(w http.ResponseWriter) error

type OpenPullRequest409ApplicationProblemPlusJSONResponse added in v0.3.0

type OpenPullRequest409ApplicationProblemPlusJSONResponse Problem

func (OpenPullRequest409ApplicationProblemPlusJSONResponse) VisitOpenPullRequestResponse added in v0.3.0

func (response OpenPullRequest409ApplicationProblemPlusJSONResponse) VisitOpenPullRequestResponse(w http.ResponseWriter) error

type OpenPullRequest422ApplicationProblemPlusJSONResponse added in v0.3.0

type OpenPullRequest422ApplicationProblemPlusJSONResponse Problem

func (OpenPullRequest422ApplicationProblemPlusJSONResponse) VisitOpenPullRequestResponse added in v0.3.0

func (response OpenPullRequest422ApplicationProblemPlusJSONResponse) VisitOpenPullRequestResponse(w http.ResponseWriter) error

type OpenPullRequestJSONRequestBody added in v0.0.7

type OpenPullRequestJSONRequestBody = OpenPullRequestRequest

OpenPullRequestJSONRequestBody defines body for OpenPullRequest for application/json ContentType.

type OpenPullRequestRequest added in v0.0.7

type OpenPullRequestRequest struct {
	// Assignees Usernames to assign the pull request to.
	Assignees *[]string `json:"assignees,omitempty"`

	// Base The branch to merge into.
	//
	// Example: main
	Base string `json:"base"`

	// Body The pull request body; may be empty.
	Body *string `json:"body,omitempty"`

	// Draft Whether to open it as a draft.
	Draft *bool `json:"draft,omitempty"`

	// Labels Label names to add to the pull request.
	Labels *[]string `json:"labels,omitempty"`

	// Reviewers Usernames to request a review from. A name holding a slash is a team, org/team, requested as a team on GitHub; on GitLab a group/subgroup stands for its direct members.
	Reviewers *[]string `json:"reviewers,omitempty"`

	// Title The pull request title.
	//
	// Example: fix: redact tokens before they reach the request log
	Title string `json:"title"`
}

OpenPullRequestRequest The pull request to open for the checked-out branch.

type OpenPullRequestRequestObject added in v0.0.7

type OpenPullRequestRequestObject struct {
	Body *OpenPullRequestJSONRequestBody
}

type OpenPullRequestResponseObject added in v0.0.7

type OpenPullRequestResponseObject interface {
	VisitOpenPullRequestResponse(w http.ResponseWriter) error
}

type OpenPullRequestdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type OpenPullRequestdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (OpenPullRequestdefaultApplicationProblemPlusJSONResponse) VisitOpenPullRequestResponse added in v0.3.0

func (response OpenPullRequestdefaultApplicationProblemPlusJSONResponse) VisitOpenPullRequestResponse(w http.ResponseWriter) error

type OpenedPullRequest added in v0.0.7

type OpenedPullRequest struct {
	// Announcement The announcement armed to post once the pull request's CI passes, when messaging is set up and messaging.auto_announce is on; the frame's queued_announcement goes on saying how it stands, and DELETE /api/announce/queued drops it unposted. Left out when none was armed.
	Announcement *QueuedAnnouncement `json:"announcement,omitempty"`

	// FollowUps What the browser can offer now that the pull request is open, in the order the terminal offers them — the link, then the move. Empty when the branch names no Jira issue, or neither applies.
	FollowUps []FollowUp `json:"follow_ups"`

	// NotArmed Why no announcement was armed where one would have been: a draft is not announced until it is ready. Left out otherwise.
	NotArmed *string     `json:"not_armed,omitempty"`
	Pull     PullRequest `json:"pull"`

	// Warning Set only when the pull opened but adding its reviewers, assignees or labels did not fully succeed, so a partial success is not reported as a failure.
	Warning *string `json:"warning,omitempty"`
}

OpenedPullRequest A pull request that was just opened, with a warning when it opened but its reviewers, assignees or labels could not all be added, and what can be offered next.

type OwnerName added in v0.5.0

type OwnerName = string

OwnerName A forge owner as CODEOWNERS names it, without its @ — a user, or org/team.

Example: acme/control-plane

type OwnerTag added in v0.5.0

type OwnerTag struct {
	Kind OwnerTagKind `json:"kind"`

	// Owner A forge owner as CODEOWNERS names it, without its @ — a user, or org/team.
	//
	// Example: acme/control-plane
	Owner OwnerName `json:"owner"`

	// Slack A Slack user or user group, by its ID and the name Slack shows for it.
	Slack *SlackTarget  `json:"slack,omitempty"`
	State OwnerTagState `json:"state"`
}

OwnerTag A code owner and what is known of them on Slack: linked (to a user, or a team to a user group), decided not on Slack, or not asked yet.

type OwnerTagKind added in v0.5.0

type OwnerTagKind string

OwnerTagKind defines model for OwnerTag.Kind.

const (
	OwnerTagKindTeam OwnerTagKind = "team"
	OwnerTagKindUser OwnerTagKind = "user"
)

Defines values for OwnerTagKind.

func (OwnerTagKind) Valid added in v0.5.0

func (e OwnerTagKind) Valid() bool

Valid indicates whether the value is a known member of the OwnerTagKind enum.

type OwnerTagState added in v0.5.0

type OwnerTagState string

OwnerTagState defines model for OwnerTag.State.

const (
	OwnerTagStateLinked     OwnerTagState = "linked"
	OwnerTagStateNotOnSlack OwnerTagState = "not_on_slack"
	OwnerTagStateUnlinked   OwnerTagState = "unlinked"
)

Defines values for OwnerTagState.

func (OwnerTagState) Valid added in v0.5.0

func (e OwnerTagState) Valid() bool

Valid indicates whether the value is a known member of the OwnerTagState enum.

type PaneSection added in v0.9.0

type PaneSection string

PaneSection A section of the page that shows one or more of the terminal's panes.

const (
	PaneSectionBranch       PaneSection = "branch"
	PaneSectionIssues       PaneSection = "issues"
	PaneSectionMessaging    PaneSection = "messaging"
	PaneSectionRepositories PaneSection = "repositories"
	PaneSectionReview       PaneSection = "review"
	PaneSectionReviews      PaneSection = "reviews"
	PaneSectionSummary      PaneSection = "summary"
	PaneSectionTasks        PaneSection = "tasks"
)

Defines values for PaneSection.

func (PaneSection) Valid added in v0.9.0

func (e PaneSection) Valid() bool

Valid indicates whether the value is a known member of the PaneSection enum.

type PanelProblems added in v0.7.0

type PanelProblems struct {
	// Branch Why the checked-out branch could not be read.
	Branch *Problem `json:"branch,omitempty"`

	// Changes Why the working tree's changes could not be read.
	Changes *Problem `json:"changes,omitempty"`

	// Issues Why the view's first page could not be read.
	Issues *Problem `json:"issues,omitempty"`

	// Review Why the branch's pull request could not be read: the forge's refusal, or the branch's when the branch could not be read.
	Review *Problem `json:"review,omitempty"`
}

PanelProblems Why each panel whose read failed was not read, so a failed read is shown as a failure rather than as the panel's empty state; absent when every panel read. A failed panel still carries its empty answer — or, for the review, the answer the forge last gave for the branch at its head — beside its problem. A service that is not set up — no credential, no forge the base remote names — carries a problem whose code is not_set_up, with how to set it up, to be shown as guidance rather than as a failure; no repository is no problem. Each detail is the curated one an error answer carries, never a host, a path or a credential.

type People added in v0.5.0

type People struct {
	Owners []OwnerTag `json:"owners"`
}

People Every code owner decided on this forge host, then the branch's undecided owners.

type PersonLink struct {
	// Channel The channel whose members a user was picked from, so the label is read from there; the configured channel when left out.
	Channel *string `json:"channel,omitempty"`

	// NotOnSlack Mark the owner not on Slack, so they are not asked again.
	NotOnSlack bool `json:"not_on_slack"`

	// Owner A forge owner as CODEOWNERS names it, without its @ — a user, or org/team.
	//
	// Example: acme/control-plane
	Owner OwnerName `json:"owner"`

	// SlackID A user ID for a user owner, a user group ID for a team.
	SlackID *string `json:"slack_id,omitempty"`
}

PersonLink Whom a code owner is on Slack: slack_id, or not_on_slack true — one or the other.

type Place added in v0.6.0

type Place struct {
	// Base The host and path of the repository pull requests merge into, when that is not origin's, as in a fork's clone; absent otherwise.
	Base *string `json:"base,omitempty"`

	// Config The configuration files that apply, each written from your home, the repository's first; empty when the defaults apply.
	Config []string `json:"config"`

	// Dir The directory, as an absolute path.
	Dir string `json:"dir"`

	// Origin Origin's host and path, as github.com/acme/api, or empty when there is none.
	Origin string `json:"origin"`

	// Root The repository's root, or empty outside a repository.
	Root string `json:"root"`

	// RootShown The root written from your home, or empty.
	RootShown string `json:"root_shown"`

	// Shown The directory written from your home.
	Shown string `json:"shown"`

	// Within The path from the root to the directory, or empty at the root or outside a repository.
	Within string `json:"within"`
}

Place A directory the server works in, as it is now. Each path is also written from your home, as ~/src/api, for showing.

type PostActivity200JSONResponse added in v0.7.0

type PostActivity200JSONResponse ActivityPost

func (PostActivity200JSONResponse) VisitPostActivityResponse added in v0.7.0

func (response PostActivity200JSONResponse) VisitPostActivityResponse(w http.ResponseWriter) error

type PostActivity422ApplicationProblemPlusJSONResponse added in v0.7.0

type PostActivity422ApplicationProblemPlusJSONResponse Problem

func (PostActivity422ApplicationProblemPlusJSONResponse) VisitPostActivityResponse added in v0.7.0

func (response PostActivity422ApplicationProblemPlusJSONResponse) VisitPostActivityResponse(w http.ResponseWriter) error

type PostActivityJSONRequestBody added in v0.7.0

type PostActivityJSONRequestBody = ActivityPostRequest

PostActivityJSONRequestBody defines body for PostActivity for application/json ContentType.

type PostActivityRequestObject added in v0.7.0

type PostActivityRequestObject struct {
	Body *PostActivityJSONRequestBody
}

type PostActivityResponseObject added in v0.7.0

type PostActivityResponseObject interface {
	VisitPostActivityResponse(w http.ResponseWriter) error
}

type PostActivitydefaultApplicationProblemPlusJSONResponse added in v0.7.0

type PostActivitydefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (PostActivitydefaultApplicationProblemPlusJSONResponse) VisitPostActivityResponse added in v0.7.0

type PostLength added in v0.7.0

type PostLength struct {
	// Count The text's length, rendered for the service.
	Count int `json:"count"`

	// Limit The most the service takes.
	Limit int `json:"limit"`

	// Service The service the summary would be posted to, such as Discord.
	Service string `json:"service"`

	// Unit What count and limit are counted in: characters, or bytes of the whole payload for Teams, whose limit is put that way.
	Unit PostLengthUnit `json:"unit"`
}

PostLength How long the summary's text is once rendered for the messaging service set up, as that service measures it, against the most it takes. Left out where no messaging is set up, or where the service names no limit (a plain webhook). A post longer than the limit is refused with too_long, and nothing is sent.

type PostLengthUnit added in v0.7.0

type PostLengthUnit string

PostLengthUnit What count and limit are counted in: characters, or bytes of the whole payload for Teams, whose limit is put that way.

const (
	PostLengthUnitBytes      PostLengthUnit = "bytes"
	PostLengthUnitCharacters PostLengthUnit = "characters"
)

Defines values for PostLengthUnit.

func (PostLengthUnit) Valid added in v0.7.0

func (e PostLengthUnit) Valid() bool

Valid indicates whether the value is a known member of the PostLengthUnit enum.

type PreviewBranchIssue200JSONResponse added in v0.5.0

type PreviewBranchIssue200JSONResponse BranchIssuePreview

func (PreviewBranchIssue200JSONResponse) VisitPreviewBranchIssueResponse added in v0.5.0

func (response PreviewBranchIssue200JSONResponse) VisitPreviewBranchIssueResponse(w http.ResponseWriter) error

type PreviewBranchIssue422ApplicationProblemPlusJSONResponse added in v0.5.0

type PreviewBranchIssue422ApplicationProblemPlusJSONResponse Problem

func (PreviewBranchIssue422ApplicationProblemPlusJSONResponse) VisitPreviewBranchIssueResponse added in v0.5.0

func (response PreviewBranchIssue422ApplicationProblemPlusJSONResponse) VisitPreviewBranchIssueResponse(w http.ResponseWriter) error

type PreviewBranchIssueParams added in v0.5.0

type PreviewBranchIssueParams struct {
	// Key A Jira key, or a forge issue number with or without its #.
	Key string `form:"key" json:"key"`
}

PreviewBranchIssueParams defines parameters for PreviewBranchIssue.

type PreviewBranchIssueRequestObject added in v0.5.0

type PreviewBranchIssueRequestObject struct {
	Params PreviewBranchIssueParams
}

type PreviewBranchIssueResponseObject added in v0.5.0

type PreviewBranchIssueResponseObject interface {
	VisitPreviewBranchIssueResponse(w http.ResponseWriter) error
}

type PreviewBranchIssuedefaultApplicationProblemPlusJSONResponse added in v0.5.0

type PreviewBranchIssuedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (PreviewBranchIssuedefaultApplicationProblemPlusJSONResponse) VisitPreviewBranchIssueResponse added in v0.5.0

func (response PreviewBranchIssuedefaultApplicationProblemPlusJSONResponse) VisitPreviewBranchIssueResponse(w http.ResponseWriter) error

type Problem added in v0.3.0

type Problem struct {
	// Code A stable, machine-readable reason. not_set_up is a service with nothing set up to ask — no credential, no forge the base remote names, no Taskwarrior installed, no git user.email — whose detail says how to set it up; unprocessable is a request or a setting that cannot be used as it is; rate_limited is an upstream asking to be asked again later, unreachable one that could not be reached at all; unauthorized is a request that presented no session, or another run's; ci_failed is an announcement refused because a check failed on its pull request.
	Code ProblemCode `json:"code"`

	// Detail A human-readable explanation specific to this occurrence.
	Detail string `json:"detail"`

	// Fields For a configuration save refused as not valid, each setting the validation refused, in the order it validates them, the detail joining the same reasons; absent from any other problem.
	Fields *[]RefusedSetting `json:"fields,omitempty"`

	// RetryAfter For rate_limited, how many seconds the upstream asked to wait, when it said; the answer's Retry-After header says the same.
	RetryAfter *int `json:"retry_after,omitempty"`

	// Status The HTTP status code.
	Status int `json:"status"`

	// Title A short, human-readable summary of the problem type.
	Title string `json:"title"`

	// Type A URI that identifies the problem type.
	//
	// Example: https://jacob-delgado.github.io/workflow/docs/errors/#not-found
	Type string `json:"type"`
}

Problem An RFC 9457 problem details object. The detail is safe to show and never carries a secret; code is a stable, machine-readable reason.

type ProblemApplicationProblemPlusJSONResponse added in v0.3.0

type ProblemApplicationProblemPlusJSONResponse struct {
	Body Problem

	Headers ProblemResponseHeaders
}

type ProblemCode added in v0.3.0

type ProblemCode string

ProblemCode A stable, machine-readable reason. not_set_up is a service with nothing set up to ask — no credential, no forge the base remote names, no Taskwarrior installed, no git user.email — whose detail says how to set it up; unprocessable is a request or a setting that cannot be used as it is; rate_limited is an upstream asking to be asked again later, unreachable one that could not be reached at all; unauthorized is a request that presented no session, or another run's; ci_failed is an announcement refused because a check failed on its pull request.

const (
	ProblemCodeBadRequest           ProblemCode = "bad_request"
	ProblemCodeCheckFailed          ProblemCode = "check_failed"
	ProblemCodeCiFailed             ProblemCode = "ci_failed"
	ProblemCodeConflict             ProblemCode = "conflict"
	ProblemCodeFetchFailed          ProblemCode = "fetch_failed"
	ProblemCodeInternal             ProblemCode = "internal"
	ProblemCodeMethodNotAllowed     ProblemCode = "method_not_allowed"
	ProblemCodeNotFound             ProblemCode = "not_found"
	ProblemCodeNotSetUp             ProblemCode = "not_set_up"
	ProblemCodePreconditionRequired ProblemCode = "precondition_required"
	ProblemCodeRateLimited          ProblemCode = "rate_limited"
	ProblemCodeTooLong              ProblemCode = "too_long"
	ProblemCodeUnauthorized         ProblemCode = "unauthorized"
	ProblemCodeUnprocessable        ProblemCode = "unprocessable"
	ProblemCodeUnreachable          ProblemCode = "unreachable"
)

Defines values for ProblemCode.

func (ProblemCode) Valid added in v0.3.0

func (e ProblemCode) Valid() bool

Valid indicates whether the value is a known member of the ProblemCode enum.

type ProblemResponseHeaders added in v0.9.0

type ProblemResponseHeaders struct {
	RetryAfter *int
}

type PullRequest

type PullRequest struct {
	Approvals        int                  `json:"approvals"`
	ChangesRequested bool                 `json:"changes_requested"`
	Draft            bool                 `json:"draft"`
	Mergeable        PullRequestMergeable `json:"mergeable"`

	// Number The GitHub number or GitLab IID.
	Number int `json:"number"`

	// State Whether it is still open, has merged, or was closed without merging. The branch's pull request is found open or merged; a merged one has no CI to report.
	State PullRequestState `json:"state"`
	Title string           `json:"title"`
	URL   string           `json:"url"`
}

PullRequest defines model for PullRequest.

type PullRequestConfig added in v0.3.0

type PullRequestConfig struct {
	// TitleSource Where a pull request's title comes from: "commit" (the default) takes the branch's oldest commit, "issue" takes the issue it names.
	TitleSource *string `json:"title_source,omitempty"`
}

PullRequestConfig defines model for PullRequestConfig.

type PullRequestDraft added in v0.0.7

type PullRequestDraft struct {
	// Base The branch it would merge into.
	Base string `json:"base"`

	// Body The proposed body, from the template, commits, and issue.
	Body string `json:"body"`

	// Draft Whether it would open as a draft; always false in a fresh draft.
	Draft bool `json:"draft"`

	// Head The branch with the work; the open always uses the checked-out one.
	Head string `json:"head"`

	// NeedsPush Whether the branch must be pushed first; the open pushes it.
	NeedsPush bool `json:"needs_push"`

	// Reviewers The proposed reviewers: the code owners of the paths the branch changes, as CODEOWNERS on the base names them, without the author. People come first, then teams as org/team (a GitLab group as group/subgroup). Empty when no CODEOWNERS covers the changes or it cannot be read.
	//
	// Example: ["ana","acme/control-plane"]
	Reviewers []string `json:"reviewers"`

	// Template The template the body starts from, by name; empty when there is none.
	Template string `json:"template"`

	// Templates The repository's pull request templates by name, in the order the terminal's ctrl+t cycles them; empty when it has none.
	Templates []string `json:"templates"`

	// Title The proposed title, from the first commit or the issue.
	Title string `json:"title"`
}

PullRequestDraft A pull request composed for the branch, editable before opening.

type PullRequestMergeable

type PullRequestMergeable string

PullRequestMergeable defines model for PullRequest.Mergeable.

const (
	PullRequestMergeableClean     PullRequestMergeable = "clean"
	PullRequestMergeableConflicts PullRequestMergeable = "conflicts"
	PullRequestMergeableUnknown   PullRequestMergeable = "unknown"
)

Defines values for PullRequestMergeable.

func (PullRequestMergeable) Valid

func (e PullRequestMergeable) Valid() bool

Valid indicates whether the value is a known member of the PullRequestMergeable enum.

type PullRequestState added in v0.4.0

type PullRequestState string

PullRequestState Whether it is still open, has merged, or was closed without merging. The branch's pull request is found open or merged; a merged one has no CI to report.

const (
	PullRequestStateClosed PullRequestState = "closed"
	PullRequestStateMerged PullRequestState = "merged"
	PullRequestStateOpen   PullRequestState = "open"
)

Defines values for PullRequestState.

func (PullRequestState) Valid added in v0.4.0

func (e PullRequestState) Valid() bool

Valid indicates whether the value is a known member of the PullRequestState enum.

type PullRequestText added in v0.7.0

type PullRequestText struct {
	Body  string `json:"body"`
	Title string `json:"title"`
}

PullRequestText A pull request's title and description.

type Push200JSONResponse added in v0.0.7

type Push200JSONResponse Branch

func (Push200JSONResponse) VisitPushResponse added in v0.0.7

func (response Push200JSONResponse) VisitPushResponse(w http.ResponseWriter) error

type Push409ApplicationProblemPlusJSONResponse added in v0.3.0

type Push409ApplicationProblemPlusJSONResponse Problem

func (Push409ApplicationProblemPlusJSONResponse) VisitPushResponse added in v0.3.0

type Push422ApplicationProblemPlusJSONResponse added in v0.3.0

type Push422ApplicationProblemPlusJSONResponse Problem

func (Push422ApplicationProblemPlusJSONResponse) VisitPushResponse added in v0.3.0

type PushRequestObject added in v0.0.7

type PushRequestObject struct {
}

type PushResponseObject added in v0.0.7

type PushResponseObject interface {
	VisitPushResponse(w http.ResponseWriter) error
}

type PushdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type PushdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (PushdefaultApplicationProblemPlusJSONResponse) VisitPushResponse added in v0.3.0

type QueuedAnnouncement added in v0.7.0

type QueuedAnnouncement struct {
	// Automatic Set true only on one armed as its pull request opened here, rather than asked for with when ci_passes.
	Automatic *bool `json:"automatic,omitempty"`

	// Channel The channel it posts to, or empty for a webhook's own channel.
	Channel string `json:"channel"`

	// Ci How the pull request's CI stood on the last read while it waits; failed means it waits on a fix, none that no check is reported yet. Left out until the CI is read.
	Ci *CIState `json:"ci,omitempty"`

	// Pull The number of the pull request whose CI it waits on.
	Pull int `json:"pull"`

	// Reason Why a dropped announcement was not posted: no check was reported on the pull request within ten minutes, so it is announced by hand; the branch's pull request is another one, or merged before its CI passed; or the post failed. A failed check does not drop it: it waits on, for a run that passes.
	Reason *string                 `json:"reason,omitempty"`
	State  QueuedAnnouncementState `json:"state"`

	// Warning Set only on one announced that the store could not remember, so a later session may offer it again.
	//
	// Example: Posted, but not remembered: it may be offered again.
	Warning *string `json:"warning,omitempty"`
}

QueuedAnnouncement An announcement held until a pull request's CI passes, and how it stands: waiting for the CI, being posted, posted, or dropped unposted with the reason.

type QueuedAnnouncementState added in v0.7.0

type QueuedAnnouncementState string

QueuedAnnouncementState defines model for QueuedAnnouncement.State.

const (
	QueuedAnnouncementStateAnnounced  QueuedAnnouncementState = "announced"
	QueuedAnnouncementStateAnnouncing QueuedAnnouncementState = "announcing"
	QueuedAnnouncementStateDropped    QueuedAnnouncementState = "dropped"
	QueuedAnnouncementStateWaiting    QueuedAnnouncementState = "waiting"
)

Defines values for QueuedAnnouncementState.

func (QueuedAnnouncementState) Valid added in v0.7.0

func (e QueuedAnnouncementState) Valid() bool

Valid indicates whether the value is a known member of the QueuedAnnouncementState enum.

type RefusedSetting added in v0.11.0

type RefusedSetting struct {
	// Detail Why it was refused, safe to show: it quotes the value refused unless that is a credential or carries one, as a Jira address with a login does.
	Detail string `json:"detail"`

	// Key The setting's dotted key, as the configuration file spells it.
	//
	// Example: branch.slug_limit
	Key string `json:"key"`
}

RefusedSetting A setting a configuration save refused, and why.

type RemoveFavorite200JSONResponse added in v0.6.0

type RemoveFavorite200JSONResponse Repositories

func (RemoveFavorite200JSONResponse) VisitRemoveFavoriteResponse added in v0.6.0

func (response RemoveFavorite200JSONResponse) VisitRemoveFavoriteResponse(w http.ResponseWriter) error

type RemoveFavorite422ApplicationProblemPlusJSONResponse added in v0.6.0

type RemoveFavorite422ApplicationProblemPlusJSONResponse Problem

func (RemoveFavorite422ApplicationProblemPlusJSONResponse) VisitRemoveFavoriteResponse added in v0.6.0

func (response RemoveFavorite422ApplicationProblemPlusJSONResponse) VisitRemoveFavoriteResponse(w http.ResponseWriter) error

type RemoveFavoriteParams added in v0.6.0

type RemoveFavoriteParams struct {
	// Dir The directory, as an absolute path.
	Dir string `form:"dir" json:"dir"`
}

RemoveFavoriteParams defines parameters for RemoveFavorite.

type RemoveFavoriteRequestObject added in v0.6.0

type RemoveFavoriteRequestObject struct {
	Params RemoveFavoriteParams
}

type RemoveFavoriteResponseObject added in v0.6.0

type RemoveFavoriteResponseObject interface {
	VisitRemoveFavoriteResponse(w http.ResponseWriter) error
}

type RemoveFavoritedefaultApplicationProblemPlusJSONResponse added in v0.6.0

type RemoveFavoritedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (RemoveFavoritedefaultApplicationProblemPlusJSONResponse) VisitRemoveFavoriteResponse added in v0.6.0

func (response RemoveFavoritedefaultApplicationProblemPlusJSONResponse) VisitRemoveFavoriteResponse(w http.ResponseWriter) error

type RemoveLocalData200JSONResponse added in v0.7.0

type RemoveLocalData200JSONResponse LocalData

func (RemoveLocalData200JSONResponse) VisitRemoveLocalDataResponse added in v0.7.0

func (response RemoveLocalData200JSONResponse) VisitRemoveLocalDataResponse(w http.ResponseWriter) error

type RemoveLocalData409ApplicationProblemPlusJSONResponse added in v0.7.0

type RemoveLocalData409ApplicationProblemPlusJSONResponse Problem

func (RemoveLocalData409ApplicationProblemPlusJSONResponse) VisitRemoveLocalDataResponse added in v0.7.0

func (response RemoveLocalData409ApplicationProblemPlusJSONResponse) VisitRemoveLocalDataResponse(w http.ResponseWriter) error

type RemoveLocalData422ApplicationProblemPlusJSONResponse added in v0.7.0

type RemoveLocalData422ApplicationProblemPlusJSONResponse Problem

func (RemoveLocalData422ApplicationProblemPlusJSONResponse) VisitRemoveLocalDataResponse added in v0.7.0

func (response RemoveLocalData422ApplicationProblemPlusJSONResponse) VisitRemoveLocalDataResponse(w http.ResponseWriter) error

type RemoveLocalDataParams added in v0.7.0

type RemoveLocalDataParams struct {
	// Scope cache removes workflow.db; all also removes kept.db.
	Scope RemoveLocalDataParamsScope `form:"scope" json:"scope"`
}

RemoveLocalDataParams defines parameters for RemoveLocalData.

type RemoveLocalDataParamsScope added in v0.7.0

type RemoveLocalDataParamsScope string

RemoveLocalDataParamsScope defines parameters for RemoveLocalData.

const (
	RemoveLocalDataParamsScopeAll   RemoveLocalDataParamsScope = "all"
	RemoveLocalDataParamsScopeCache RemoveLocalDataParamsScope = "cache"
)

Defines values for RemoveLocalDataParamsScope.

func (RemoveLocalDataParamsScope) Valid added in v0.7.0

func (e RemoveLocalDataParamsScope) Valid() bool

Valid indicates whether the value is a known member of the RemoveLocalDataParamsScope enum.

type RemoveLocalDataRequestObject added in v0.7.0

type RemoveLocalDataRequestObject struct {
	Params RemoveLocalDataParams
}

type RemoveLocalDataResponseObject added in v0.7.0

type RemoveLocalDataResponseObject interface {
	VisitRemoveLocalDataResponse(w http.ResponseWriter) error
}

type RemoveLocalDatadefaultApplicationProblemPlusJSONResponse added in v0.7.0

type RemoveLocalDatadefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (RemoveLocalDatadefaultApplicationProblemPlusJSONResponse) VisitRemoveLocalDataResponse added in v0.7.0

func (response RemoveLocalDatadefaultApplicationProblemPlusJSONResponse) VisitRemoveLocalDataResponse(w http.ResponseWriter) error

type RepoGroups added in v0.5.0

type RepoGroups struct {
	Groups []SlackTarget `json:"groups"`

	// Repository The repository's name, as its forge path or its directory.
	//
	// Example: acme/widgets
	Repository string `json:"repository"`
}

RepoGroups The Slack user groups a repository's announcements may tag.

type RepoGroupsRequest added in v0.5.0

type RepoGroupsRequest struct {
	Ids []string `json:"ids"`
}

RepoGroupsRequest The user groups, by ID, this repository may tag from now on.

type Repositories added in v0.6.0

type Repositories struct {
	// Favorites Your favorites, by path.
	Favorites []Favorite `json:"favorites"`

	// FavoritesKept Whether a favorite can be marked or forgotten here: false when the store keeps nothing, or under --dry-run.
	FavoritesKept bool `json:"favorites_kept"`

	// Here A directory the server works in, as it is now. Each path is also written from your home, as ~/src/api, for showing.
	Here Place `json:"here"`

	// Worktrees The working trees of the repository the server works in, the main one first, as git lists them; empty outside a repository.
	Worktrees []Worktree `json:"worktrees"`

	// WorktreesError Why the worktrees could not be read, in words that never name a path or a host; empty when they were.
	WorktreesError string `json:"worktrees_error"`
}

Repositories Where the server works, the repository's worktrees, and your favorite directories.

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error

func (e *RequiredParamError) Error() string

type Rerun added in v0.7.0

type Rerun struct {
	// Reran Whether the forge re-ran anything; false when the failure had no job to restart.
	Reran bool `json:"reran"`
}

Rerun defines model for Rerun.

type RerunChecks200JSONResponse added in v0.7.0

type RerunChecks200JSONResponse Rerun

func (RerunChecks200JSONResponse) VisitRerunChecksResponse added in v0.7.0

func (response RerunChecks200JSONResponse) VisitRerunChecksResponse(w http.ResponseWriter) error

type RerunChecks409ApplicationProblemPlusJSONResponse added in v0.7.0

type RerunChecks409ApplicationProblemPlusJSONResponse Problem

func (RerunChecks409ApplicationProblemPlusJSONResponse) VisitRerunChecksResponse added in v0.7.0

func (response RerunChecks409ApplicationProblemPlusJSONResponse) VisitRerunChecksResponse(w http.ResponseWriter) error

type RerunChecks422ApplicationProblemPlusJSONResponse added in v0.7.0

type RerunChecks422ApplicationProblemPlusJSONResponse Problem

func (RerunChecks422ApplicationProblemPlusJSONResponse) VisitRerunChecksResponse added in v0.7.0

func (response RerunChecks422ApplicationProblemPlusJSONResponse) VisitRerunChecksResponse(w http.ResponseWriter) error

type RerunChecksRequestObject added in v0.7.0

type RerunChecksRequestObject struct {
}

type RerunChecksResponseObject added in v0.7.0

type RerunChecksResponseObject interface {
	VisitRerunChecksResponse(w http.ResponseWriter) error
}

type RerunChecksdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type RerunChecksdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (RerunChecksdefaultApplicationProblemPlusJSONResponse) VisitRerunChecksResponse added in v0.7.0

type Review

type Review struct {
	// Announced Whether the pull request was already announced at the moment it is at now — ready for review, or merged — from the browser, the terminal or workflow announce, as the store remembers. Always false for one closed without merging, which the loop no longer follows, whatever was announced of it before: it is none to announce, as the announce stage reads it, until one is open again. The store is read at most once every timing.ci_interval, and never under --dry-run, when this is always false.
	Announced bool `json:"announced"`

	// Ci The pull request's CI; absent when none is found, the pull request is not open, or its CI cannot be read — unless the event stream holds the CI last read for the same pull request at the same head.
	Ci *CI `json:"ci,omitempty"`

	// CiError Why the open pull request's CI could not be read; absent when it was, or was not asked about. The detail is curated, never a host or a credential.
	CiError *Problem `json:"ci_error,omitempty"`

	// FinishRefusal Why the merged pull request's branch cannot be finished, in the words that follow "cannot finish BRANCH: " — it holds commits that neither merged nor are on its upstream, there is no base to return to, or it is not a branch of its own — the same check a finish makes before it runs. Absent when the pull request has not merged, and when its branch can be finished.
	FinishRefusal *string `json:"finish_refusal,omitempty"`

	// Found Whether a pull request was found for the branch.
	Found bool `json:"found"`

	// Issue The issue the branch and its pull request are for; absent when none is named.
	Issue *LinkedIssue `json:"issue,omitempty"`

	// Pull The branch's pull request; absent when none is found.
	Pull *PullRequest `json:"pull,omitempty"`
}

Review defines model for Review.

type ReviewFacet added in v0.9.0

type ReviewFacet struct {
	// Kind The facet: the request's repository, how its CI stands, whether it is a draft, or who asks.
	Kind ReviewFacetKind `json:"kind"`

	// Label The value as every surface names it in the filter and in the line saying what the queue is narrowed to.
	//
	// Example: CI failed
	Label string `json:"label"`

	// Value The value held: the repository ("" for none the forge named), the CI state, draft or ready, or the author.
	//
	// Example: example/repo
	Value string `json:"value"`
}

ReviewFacet One value a review request holds in one of the four facets the queue is narrowed by. Values picked in one facet widen the queue, and the facets narrow it together.

type ReviewFacetKind added in v0.9.0

type ReviewFacetKind string

ReviewFacetKind The facet: the request's repository, how its CI stands, whether it is a draft, or who asks.

const (
	ReviewFacetKindAuthor     ReviewFacetKind = "author"
	ReviewFacetKindCi         ReviewFacetKind = "ci"
	ReviewFacetKindDraft      ReviewFacetKind = "draft"
	ReviewFacetKindRepository ReviewFacetKind = "repository"
)

Defines values for ReviewFacetKind.

func (ReviewFacetKind) Valid added in v0.9.0

func (e ReviewFacetKind) Valid() bool

Valid indicates whether the value is a known member of the ReviewFacetKind enum.

type ReviewQueue added in v0.3.0

type ReviewQueue struct {
	// Available Whether there is a forge to ask. False outside a repository, and when the base remote is on no forge workflow can read — not GitHub or GitLab, or a self-hosted one forge.kind and forge.host do not name — and requests is then empty.
	Available bool `json:"available"`

	// FacetOrder Every value the queue's filter offers, in the order it lists them, as the terminal's filter lists them: the repositories the requests are in, by name; every CI state and draft then ready, in a fixed order; then who asks, by name. A name is ordered by its code points. A value no request holds is offered only while it is picked.
	FacetOrder []ReviewFacet `json:"facet_order"`

	// Requests The open pull or merge requests that ask for your review, the longest-waiting first. Empty when none does, or when there is no forge to ask.
	Requests []ReviewRequest `json:"requests"`
}

ReviewQueue defines model for ReviewQueue.

type ReviewRequest added in v0.3.0

type ReviewRequest struct {
	// Author Who opened it, and so who asks for the review.
	Author string  `json:"author"`
	Ci     CIState `json:"ci"`
	Draft  bool    `json:"draft"`

	// Facets The value it holds in each facet the queue is narrowed by, in the order of the facets: its repository, its CI, draft or ready, and who asks.
	Facets []ReviewFacet `json:"facets"`

	// Number The GitHub number or GitLab IID.
	Number int `json:"number"`

	// OpenedAt RFC 3339; when it was opened, which is how long it has waited; left out when the forge did not give one.
	OpenedAt *time.Time `json:"opened_at,omitempty"`

	// Repository The owner/name (GitHub) or group/project (GitLab) it is in, since the queue spans repositories; empty when the forge did not say.
	//
	// Example: jacob-delgado/workflow
	Repository string `json:"repository"`
	Title      string `json:"title"`
	URL        string `json:"url"`
}

ReviewRequest defines model for ReviewRequest.

type Run added in v0.7.0

type Run struct {
	// Kind A git run: a hook lefthook runs by hand, as GET /api/hooks lists it, a rebase onto the base, an amend of the last commit, or a fixup! of an earlier one.
	Kind RunKind `json:"kind"`

	// Lines What the program wrote, standard output and standard error in the order written, with terminal controls taken out. A run the event stream carries holds its last 200 lines.
	Lines []string `json:"lines"`

	// Outcome What the run did, once it has ended — Rebased onto main, the pre-commit hook failed — and empty while it runs.
	Outcome string `json:"outcome"`

	// State How the run stands: in progress, succeeded, refused — the program ended with a failure, a hook that failed or a rebase stopped at a conflict — or stopped by DELETE /api/runs/current.
	State RunState `json:"state"`

	// Title What is running, as the terminal titles it, such as pre-push or git rebase.
	Title string `json:"title"`
}

Run A git run and how it stands: running, or how it ended, with what it wrote.

type RunEvent added in v0.7.0

type RunEvent struct {
	// Line A line the program wrote, with terminal controls taken out.
	Line *string `json:"line,omitempty"`

	// Run A git run and how it stands: running, or how it ended, with what it wrote.
	Run *Run `json:"run,omitempty"`
}

RunEvent One line of a run's stream: the run itself, as it starts and as it ends, or one line of its output.

type RunKind added in v0.7.0

type RunKind string

RunKind A git run: a hook lefthook runs by hand, as GET /api/hooks lists it, a rebase onto the base, an amend of the last commit, or a fixup! of an earlier one.

const (
	RunKindAmend  RunKind = "amend"
	RunKindFixup  RunKind = "fixup"
	RunKindHook   RunKind = "hook"
	RunKindRebase RunKind = "rebase"
)

Defines values for RunKind.

func (RunKind) Valid added in v0.7.0

func (e RunKind) Valid() bool

Valid indicates whether the value is a known member of the RunKind enum.

type RunRequest added in v0.7.0

type RunRequest struct {
	// Commit For fixup, the hash of the commit to record a fixup! of, as the branch lists it; it must be one not yet pushed. Ignored otherwise.
	Commit *string `json:"commit,omitempty"`

	// Hook For hook, the hook to run, one GET /api/hooks lists as runnable, named exactly as it lists it. Ignored otherwise.
	//
	// Example: pre-push
	Hook *string `json:"hook,omitempty"`

	// Kind A git run: a hook lefthook runs by hand, as GET /api/hooks lists it, a rebase onto the base, an amend of the last commit, or a fixup! of an earlier one.
	Kind RunKind `json:"kind"`
}

RunRequest Which run to start, for a hook the hook it runs, and for a fixup the commit it fixes up.

type RunState added in v0.7.0

type RunState string

RunState How the run stands: in progress, succeeded, refused — the program ended with a failure, a hook that failed or a rebase stopped at a conflict — or stopped by DELETE /api/runs/current.

const (
	RunStateInProgress RunState = "in_progress"
	RunStateRefused    RunState = "refused"
	RunStateStopped    RunState = "stopped"
	RunStateSucceeded  RunState = "succeeded"
)

Defines values for RunState.

func (RunState) Valid added in v0.7.0

func (e RunState) Valid() bool

Valid indicates whether the value is a known member of the RunState enum.

type Seed added in v0.10.0

type Seed struct {
	// Issues The view's first page as last kept: Jira's issues only, in Jira's order. total counts only those, start_at is 0 and unavailable is empty; a view kept with no issues is an empty page.
	Issues IssuesPage `json:"issues"`
}

Seed The view's issues as the store last kept them, carried by a "seed" event sent first, at most once, ahead of any snapshot: only when the store holds a list for the view, there is a tracker to ask again, and the server is not under --dry-run. It is read from disk before anything is asked of the network; nothing else of the snapshot is known until the first one lands, which takes its place.

type ServeMux

type ServeMux interface {
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
	http.Handler
}

ServeMux is an abstraction of http.ServeMux.

type ServerInterface

type ServerInterface interface {
	// GetActivity What you did over a period, grouped by year, month, day and hour.
	// (GET /api/activity)
	GetActivity(w http.ResponseWriter, r *http.Request, params GetActivityParams)
	// PostActivity Post the Summary to the configured messaging service.
	// (POST /api/activity/post)
	PostActivity(w http.ResponseWriter, r *http.Request)
	// Announce Post the pull request announcement to the configured service.
	// (POST /api/announce)
	Announce(w http.ResponseWriter, r *http.Request)
	// CancelQueuedAnnouncement Drop the announcement waiting for CI to pass, unposted.
	// (DELETE /api/announce/queued)
	CancelQueuedAnnouncement(w http.ResponseWriter, r *http.Request)
	// GetAnnouncement The announcement message that would be posted, for a preview.
	// (GET /api/announcement)
	GetAnnouncement(w http.ResponseWriter, r *http.Request, params GetAnnouncementParams)
	// GetBranch The current branch and how it stands against its base.
	// (GET /api/branch)
	GetBranch(w http.ResponseWriter, r *http.Request)
	// FinishBranch Finish a merged branch — switch to the base, catch it up, delete the branch.
	// (POST /api/branch/finish)
	FinishBranch(w http.ResponseWriter, r *http.Request)
	// UnlinkBranchIssue Forget the issue the checked-out branch was linked to.
	// (DELETE /api/branch/issue)
	UnlinkBranchIssue(w http.ResponseWriter, r *http.Request)
	// LinkBranchIssue Link the checked-out branch to an issue, for work begun outside workflow.
	// (PUT /api/branch/issue)
	LinkBranchIssue(w http.ResponseWriter, r *http.Request)
	// PreviewBranchIssue What linking the checked-out branch to an issue would write in its pull request.
	// (GET /api/branch/issue/preview)
	PreviewBranchIssue(w http.ResponseWriter, r *http.Request, params PreviewBranchIssueParams)
	// CreateBranch Create and switch to a branch for an issue — start work on it.
	// (POST /api/branches)
	CreateBranch(w http.ResponseWriter, r *http.Request)
	// ListChanges The working tree's changes.
	// (GET /api/changes)
	ListChanges(w http.ResponseWriter, r *http.Request)
	// GetChangeDiff A changed file's diff against HEAD, so it can be read before staging.
	// (GET /api/changes/diff)
	GetChangeDiff(w http.ResponseWriter, r *http.Request, params GetChangeDiffParams)
	// Checkout Check out a local branch, switching the working tree to it.
	// (POST /api/checkout)
	Checkout(w http.ResponseWriter, r *http.Request)
	// Commit Commit the staged changes with a Conventional Commit message.
	// (POST /api/commit)
	Commit(w http.ResponseWriter, r *http.Request)
	// GetConfig The configuration in effect, with secrets masked.
	// (GET /api/config)
	GetConfig(w http.ResponseWriter, r *http.Request)
	// UpdateConfig Write the configuration file.
	// (PUT /api/config)
	UpdateConfig(w http.ResponseWriter, r *http.Request, params UpdateConfigParams)
	// GetSetup Whether a first configuration file is needed here, and where it may go.
	// (GET /api/config/setup)
	GetSetup(w http.ResponseWriter, r *http.Request)
	// SetUp Write a first configuration file, as workflow config init does.
	// (POST /api/config/setup)
	SetUp(w http.ResponseWriter, r *http.Request)
	// GetDirectories The directories in one, to browse for a directory to switch to.
	// (GET /api/directories)
	GetDirectories(w http.ResponseWriter, r *http.Request, params GetDirectoriesParams)
	// Discard Drop a changed file's changes, staged and not.
	// (POST /api/discard)
	Discard(w http.ResponseWriter, r *http.Request)
	// GetHealth Server and build information.
	// (GET /api/health)
	GetHealth(w http.ResponseWriter, r *http.Request)
	// ListHooks The hooks lefthook configures, split by whether a run by hand can run them.
	// (GET /api/hooks)
	ListHooks(w http.ResponseWriter, r *http.Request)
	// GetHookSetup The lefthook configuration offered for hooks lefthook does not manage.
	// (GET /api/hooks/setup)
	GetHookSetup(w http.ResponseWriter, r *http.Request)
	// SetUpHooks Write the offered lefthook.yml and install lefthook.
	// (POST /api/hooks/setup)
	SetUpHooks(w http.ResponseWriter, r *http.Request)
	// ListIssues One page of the issues a view matches.
	// (GET /api/issues)
	ListIssues(w http.ResponseWriter, r *http.Request, params ListIssuesParams)
	// GetIssue One issue in full, with its comments.
	// (GET /api/issues/{key})
	GetIssue(w http.ResponseWriter, r *http.Request, key string)
	// AssignIssue Assign an issue to someone, by username.
	// (PUT /api/issues/{key}/assignee)
	AssignIssue(w http.ResponseWriter, r *http.Request, key string)
	// AddComment Comment on an issue, in Jira or on the forge.
	// (POST /api/issues/{key}/comment)
	AddComment(w http.ResponseWriter, r *http.Request, key string)
	// LinkPullRequest Link the checked-out branch's pull request on its issue.
	// (POST /api/issues/{key}/link)
	LinkPullRequest(w http.ResponseWriter, r *http.Request, key string)
	// TransitionIssue Move an issue to the configured review status.
	// (POST /api/issues/{key}/transition)
	TransitionIssue(w http.ResponseWriter, r *http.Request, key string)
	// ListStatusChanges The status changes the tracker offers an issue, with the fields each needs.
	// (GET /api/issues/{key}/transitions)
	ListStatusChanges(w http.ResponseWriter, r *http.Request, key string)
	// ChangeStatus Change an issue's status, filling the fields the change needs.
	// (POST /api/issues/{key}/transitions)
	ChangeStatus(w http.ResponseWriter, r *http.Request, key string)
	// LogWork Log time spent on a Jira issue.
	// (POST /api/issues/{key}/worklog)
	LogWork(w http.ResponseWriter, r *http.Request, key string)
	// GetKeys The terminal interface's key actions, as its help lists them.
	// (GET /api/keys)
	GetKeys(w http.ResponseWriter, r *http.Request)
	// RemoveLocalData Remove the cache, or with scope all the kept associations too.
	// (DELETE /api/local-data)
	RemoveLocalData(w http.ResponseWriter, r *http.Request, params RemoveLocalDataParams)
	// GetLocalData The local databases workflow keeps, each with its size and what it holds.
	// (GET /api/local-data)
	GetLocalData(w http.ResponseWriter, r *http.Request)
	// GetMessaging The service, channel, its alternates, and who a post would come from.
	// (GET /api/messaging)
	GetMessaging(w http.ResponseWriter, r *http.Request)
	// ForgetPerson Forget what was decided for a code owner, so they are asked again.
	// (DELETE /api/people)
	ForgetPerson(w http.ResponseWriter, r *http.Request, params ForgetPersonParams)
	// GetPeople Whom each code owner is on Slack, on this repository's forge host.
	// (GET /api/people)
	GetPeople(w http.ResponseWriter, r *http.Request)
	// LinkPerson Record whom a code owner is on Slack, or that they are not on it.
	// (PUT /api/people)
	LinkPerson(w http.ResponseWriter, r *http.Request)
	// GetPullRequestText The branch's open pull request's title and description, to edit them.
	// (GET /api/pull-request)
	GetPullRequestText(w http.ResponseWriter, r *http.Request)
	// EditPullRequest Change the branch's open pull request's title and description.
	// (PATCH /api/pull-request)
	EditPullRequest(w http.ResponseWriter, r *http.Request)
	// OpenPullRequest Open a pull request for the current branch, pushing it first if needed.
	// (POST /api/pull-request)
	OpenPullRequest(w http.ResponseWriter, r *http.Request)
	// GetPullRequestDraft The pull request that would be opened for the branch, for a preview.
	// (GET /api/pull-request/draft)
	GetPullRequestDraft(w http.ResponseWriter, r *http.Request, params GetPullRequestDraftParams)
	// GetMergeMethods How the branch's pull request may be merged, for the merge's preview.
	// (GET /api/pull-request/merge)
	GetMergeMethods(w http.ResponseWriter, r *http.Request)
	// MergePullRequest Merge the branch's pull request by a permitted method.
	// (POST /api/pull-request/merge)
	MergePullRequest(w http.ResponseWriter, r *http.Request)
	// Push Push the current branch to its remote, setting upstream.
	// (POST /api/push)
	Push(w http.ResponseWriter, r *http.Request)
	// GetRepoGroups The Slack user groups this repository's announcements may tag.
	// (GET /api/repo-groups)
	GetRepoGroups(w http.ResponseWriter, r *http.Request)
	// SetRepoGroups Replace the Slack user groups this repository may tag.
	// (PUT /api/repo-groups)
	SetRepoGroups(w http.ResponseWriter, r *http.Request)
	// GetRepositories Where the server works, and your favorite directories.
	// (GET /api/repositories)
	GetRepositories(w http.ResponseWriter, r *http.Request)
	// RemoveFavorite Forget a directory as a favorite.
	// (DELETE /api/repositories/favorites)
	RemoveFavorite(w http.ResponseWriter, r *http.Request, params RemoveFavoriteParams)
	// AddFavorite Keep a directory as a favorite.
	// (PUT /api/repositories/favorites)
	AddFavorite(w http.ResponseWriter, r *http.Request)
	// SwitchRepository Switch the directory the server works in.
	// (PUT /api/repositories/here)
	SwitchRepository(w http.ResponseWriter, r *http.Request)
	// GetReview The branch's pull request and its CI, if one is open.
	// (GET /api/review)
	GetReview(w http.ResponseWriter, r *http.Request)
	// GetCheckLog The end of a check's log, read on demand.
	// (GET /api/review/checks/{id}/log)
	GetCheckLog(w http.ResponseWriter, r *http.Request, id string)
	// RerunChecks Re-run the failed CI on the branch's pull request.
	// (POST /api/review/rerun)
	RerunChecks(w http.ResponseWriter, r *http.Request)
	// ListReviews The pull requests on the forge that wait on your review.
	// (GET /api/reviews)
	ListReviews(w http.ResponseWriter, r *http.Request)
	// StopRun Stop the run that is going.
	// (DELETE /api/runs/current)
	StopRun(w http.ResponseWriter, r *http.Request)
	// GetSlackGroups The Slack workspace's user groups, to tag or to link a team to.
	// (GET /api/slack/groups)
	GetSlackGroups(w http.ResponseWriter, r *http.Request)
	// GetSlackMembers The people in a Slack channel, to link a code owner to.
	// (GET /api/slack/members)
	GetSlackMembers(w http.ResponseWriter, r *http.Request, params GetSlackMembersParams)
	// Stage Stage a changed file, or every change the index does not hold yet.
	// (POST /api/stage)
	Stage(w http.ResponseWriter, r *http.Request)
	// ListTasks Your pending Taskwarrior tasks, most urgent first.
	// (GET /api/tasks)
	ListTasks(w http.ResponseWriter, r *http.Request)
	// AddTask Add a task from a line in Taskwarrior's own grammar.
	// (POST /api/tasks)
	AddTask(w http.ResponseWriter, r *http.Request)
	// SyncTasks Sync Taskwarrior with the backend its taskrc names.
	// (POST /api/tasks/sync)
	SyncTasks(w http.ResponseWriter, r *http.Request)
	// TrackIssue Track an issue in Taskwarrior.
	// (POST /api/tasks/track)
	TrackIssue(w http.ResponseWriter, r *http.Request)
	// UndoTasks Revert Taskwarrior's last change.
	// (POST /api/tasks/undo)
	UndoTasks(w http.ResponseWriter, r *http.Request)
	// AnnotateTask Add a note to a task.
	// (POST /api/tasks/{uuid}/annotations)
	AnnotateTask(w http.ResponseWriter, r *http.Request, uuid TaskUUID)
	// CompleteTask Complete a task.
	// (POST /api/tasks/{uuid}/done)
	CompleteTask(w http.ResponseWriter, r *http.Request, uuid TaskUUID)
	// ModifyTask Change a task by a line in Taskwarrior's own grammar.
	// (POST /api/tasks/{uuid}/modify)
	ModifyTask(w http.ResponseWriter, r *http.Request, uuid TaskUUID)
	// StartTask Start a task.
	// (POST /api/tasks/{uuid}/start)
	StartTask(w http.ResponseWriter, r *http.Request, uuid TaskUUID)
	// StopTask Stop a started task.
	// (POST /api/tasks/{uuid}/stop)
	StopTask(w http.ResponseWriter, r *http.Request, uuid TaskUUID)
	// Unstage Take a changed file out of the index, or every staged change.
	// (POST /api/unstage)
	Unstage(w http.ResponseWriter, r *http.Request)
	// ListViews The configured issue views (saved JQL), in order.
	// (GET /api/views)
	ListViews(w http.ResponseWriter, r *http.Request)
	// CreateWorktree Create a branch for an issue in a new worktree — start work on it there.
	// (POST /api/worktrees)
	CreateWorktree(w http.ResponseWriter, r *http.Request)
}

ServerInterface represents all server handlers.

func NewStrictHandler

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

func NewStrictHandlerWithOptions

func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) AddComment added in v0.5.1

func (siw *ServerInterfaceWrapper) AddComment(w http.ResponseWriter, r *http.Request)

AddComment operation middleware

func (*ServerInterfaceWrapper) AddFavorite added in v0.6.0

func (siw *ServerInterfaceWrapper) AddFavorite(w http.ResponseWriter, r *http.Request)

AddFavorite operation middleware

func (*ServerInterfaceWrapper) AddTask added in v0.4.1

AddTask operation middleware

func (*ServerInterfaceWrapper) AnnotateTask added in v0.4.1

func (siw *ServerInterfaceWrapper) AnnotateTask(w http.ResponseWriter, r *http.Request)

AnnotateTask operation middleware

func (*ServerInterfaceWrapper) Announce added in v0.0.7

func (siw *ServerInterfaceWrapper) Announce(w http.ResponseWriter, r *http.Request)

Announce operation middleware

func (*ServerInterfaceWrapper) AssignIssue added in v0.7.0

func (siw *ServerInterfaceWrapper) AssignIssue(w http.ResponseWriter, r *http.Request)

AssignIssue operation middleware

func (*ServerInterfaceWrapper) CancelQueuedAnnouncement added in v0.7.0

func (siw *ServerInterfaceWrapper) CancelQueuedAnnouncement(w http.ResponseWriter, r *http.Request)

CancelQueuedAnnouncement operation middleware

func (*ServerInterfaceWrapper) ChangeStatus added in v0.7.0

func (siw *ServerInterfaceWrapper) ChangeStatus(w http.ResponseWriter, r *http.Request)

ChangeStatus operation middleware

func (*ServerInterfaceWrapper) Checkout

func (siw *ServerInterfaceWrapper) Checkout(w http.ResponseWriter, r *http.Request)

Checkout operation middleware

func (*ServerInterfaceWrapper) Commit added in v0.0.7

Commit operation middleware

func (*ServerInterfaceWrapper) CompleteTask added in v0.4.1

func (siw *ServerInterfaceWrapper) CompleteTask(w http.ResponseWriter, r *http.Request)

CompleteTask operation middleware

func (*ServerInterfaceWrapper) CreateBranch added in v0.0.7

func (siw *ServerInterfaceWrapper) CreateBranch(w http.ResponseWriter, r *http.Request)

CreateBranch operation middleware

func (*ServerInterfaceWrapper) CreateWorktree added in v0.6.0

func (siw *ServerInterfaceWrapper) CreateWorktree(w http.ResponseWriter, r *http.Request)

CreateWorktree operation middleware

func (*ServerInterfaceWrapper) Discard added in v0.7.0

Discard operation middleware

func (*ServerInterfaceWrapper) EditPullRequest added in v0.7.0

func (siw *ServerInterfaceWrapper) EditPullRequest(w http.ResponseWriter, r *http.Request)

EditPullRequest operation middleware

func (*ServerInterfaceWrapper) FinishBranch added in v0.7.0

func (siw *ServerInterfaceWrapper) FinishBranch(w http.ResponseWriter, r *http.Request)

FinishBranch operation middleware

func (*ServerInterfaceWrapper) ForgetPerson added in v0.5.0

func (siw *ServerInterfaceWrapper) ForgetPerson(w http.ResponseWriter, r *http.Request)

ForgetPerson operation middleware

func (*ServerInterfaceWrapper) GetActivity added in v0.6.0

func (siw *ServerInterfaceWrapper) GetActivity(w http.ResponseWriter, r *http.Request)

GetActivity operation middleware

func (*ServerInterfaceWrapper) GetAnnouncement added in v0.0.7

func (siw *ServerInterfaceWrapper) GetAnnouncement(w http.ResponseWriter, r *http.Request)

GetAnnouncement operation middleware

func (*ServerInterfaceWrapper) GetBranch

func (siw *ServerInterfaceWrapper) GetBranch(w http.ResponseWriter, r *http.Request)

GetBranch operation middleware

func (*ServerInterfaceWrapper) GetChangeDiff added in v0.7.0

func (siw *ServerInterfaceWrapper) GetChangeDiff(w http.ResponseWriter, r *http.Request)

GetChangeDiff operation middleware

func (*ServerInterfaceWrapper) GetCheckLog added in v0.5.0

func (siw *ServerInterfaceWrapper) GetCheckLog(w http.ResponseWriter, r *http.Request)

GetCheckLog operation middleware

func (*ServerInterfaceWrapper) GetConfig

func (siw *ServerInterfaceWrapper) GetConfig(w http.ResponseWriter, r *http.Request)

GetConfig operation middleware

func (*ServerInterfaceWrapper) GetDirectories added in v0.6.0

func (siw *ServerInterfaceWrapper) GetDirectories(w http.ResponseWriter, r *http.Request)

GetDirectories operation middleware

func (*ServerInterfaceWrapper) GetHealth

func (siw *ServerInterfaceWrapper) GetHealth(w http.ResponseWriter, r *http.Request)

GetHealth operation middleware

func (*ServerInterfaceWrapper) GetHookSetup added in v0.7.0

func (siw *ServerInterfaceWrapper) GetHookSetup(w http.ResponseWriter, r *http.Request)

GetHookSetup operation middleware

func (*ServerInterfaceWrapper) GetIssue

func (siw *ServerInterfaceWrapper) GetIssue(w http.ResponseWriter, r *http.Request)

GetIssue operation middleware

func (*ServerInterfaceWrapper) GetKeys added in v0.7.0

GetKeys operation middleware

func (*ServerInterfaceWrapper) GetLocalData added in v0.5.0

func (siw *ServerInterfaceWrapper) GetLocalData(w http.ResponseWriter, r *http.Request)

GetLocalData operation middleware

func (*ServerInterfaceWrapper) GetMergeMethods added in v0.7.0

func (siw *ServerInterfaceWrapper) GetMergeMethods(w http.ResponseWriter, r *http.Request)

GetMergeMethods operation middleware

func (*ServerInterfaceWrapper) GetMessaging added in v0.2.0

func (siw *ServerInterfaceWrapper) GetMessaging(w http.ResponseWriter, r *http.Request)

GetMessaging operation middleware

func (*ServerInterfaceWrapper) GetPeople added in v0.5.0

func (siw *ServerInterfaceWrapper) GetPeople(w http.ResponseWriter, r *http.Request)

GetPeople operation middleware

func (*ServerInterfaceWrapper) GetPullRequestDraft added in v0.0.7

func (siw *ServerInterfaceWrapper) GetPullRequestDraft(w http.ResponseWriter, r *http.Request)

GetPullRequestDraft operation middleware

func (*ServerInterfaceWrapper) GetPullRequestText added in v0.7.0

func (siw *ServerInterfaceWrapper) GetPullRequestText(w http.ResponseWriter, r *http.Request)

GetPullRequestText operation middleware

func (*ServerInterfaceWrapper) GetRepoGroups added in v0.5.0

func (siw *ServerInterfaceWrapper) GetRepoGroups(w http.ResponseWriter, r *http.Request)

GetRepoGroups operation middleware

func (*ServerInterfaceWrapper) GetRepositories added in v0.6.0

func (siw *ServerInterfaceWrapper) GetRepositories(w http.ResponseWriter, r *http.Request)

GetRepositories operation middleware

func (*ServerInterfaceWrapper) GetReview

func (siw *ServerInterfaceWrapper) GetReview(w http.ResponseWriter, r *http.Request)

GetReview operation middleware

func (*ServerInterfaceWrapper) GetSetup added in v0.7.0

func (siw *ServerInterfaceWrapper) GetSetup(w http.ResponseWriter, r *http.Request)

GetSetup operation middleware

func (*ServerInterfaceWrapper) GetSlackGroups added in v0.5.0

func (siw *ServerInterfaceWrapper) GetSlackGroups(w http.ResponseWriter, r *http.Request)

GetSlackGroups operation middleware

func (*ServerInterfaceWrapper) GetSlackMembers added in v0.5.0

func (siw *ServerInterfaceWrapper) GetSlackMembers(w http.ResponseWriter, r *http.Request)

GetSlackMembers operation middleware

func (*ServerInterfaceWrapper) LinkBranchIssue added in v0.5.0

func (siw *ServerInterfaceWrapper) LinkBranchIssue(w http.ResponseWriter, r *http.Request)

LinkBranchIssue operation middleware

func (*ServerInterfaceWrapper) LinkPerson added in v0.5.0

func (siw *ServerInterfaceWrapper) LinkPerson(w http.ResponseWriter, r *http.Request)

LinkPerson operation middleware

func (*ServerInterfaceWrapper) LinkPullRequest added in v0.3.0

func (siw *ServerInterfaceWrapper) LinkPullRequest(w http.ResponseWriter, r *http.Request)

LinkPullRequest operation middleware

func (*ServerInterfaceWrapper) ListChanges

func (siw *ServerInterfaceWrapper) ListChanges(w http.ResponseWriter, r *http.Request)

ListChanges operation middleware

func (*ServerInterfaceWrapper) ListHooks added in v0.10.0

func (siw *ServerInterfaceWrapper) ListHooks(w http.ResponseWriter, r *http.Request)

ListHooks operation middleware

func (*ServerInterfaceWrapper) ListIssues

func (siw *ServerInterfaceWrapper) ListIssues(w http.ResponseWriter, r *http.Request)

ListIssues operation middleware

func (*ServerInterfaceWrapper) ListReviews added in v0.3.0

func (siw *ServerInterfaceWrapper) ListReviews(w http.ResponseWriter, r *http.Request)

ListReviews operation middleware

func (*ServerInterfaceWrapper) ListStatusChanges added in v0.7.0

func (siw *ServerInterfaceWrapper) ListStatusChanges(w http.ResponseWriter, r *http.Request)

ListStatusChanges operation middleware

func (*ServerInterfaceWrapper) ListTasks added in v0.4.1

func (siw *ServerInterfaceWrapper) ListTasks(w http.ResponseWriter, r *http.Request)

ListTasks operation middleware

func (*ServerInterfaceWrapper) ListViews

func (siw *ServerInterfaceWrapper) ListViews(w http.ResponseWriter, r *http.Request)

ListViews operation middleware

func (*ServerInterfaceWrapper) LogWork added in v0.7.0

LogWork operation middleware

func (*ServerInterfaceWrapper) MergePullRequest added in v0.7.0

func (siw *ServerInterfaceWrapper) MergePullRequest(w http.ResponseWriter, r *http.Request)

MergePullRequest operation middleware

func (*ServerInterfaceWrapper) ModifyTask added in v0.4.1

func (siw *ServerInterfaceWrapper) ModifyTask(w http.ResponseWriter, r *http.Request)

ModifyTask operation middleware

func (*ServerInterfaceWrapper) OpenPullRequest added in v0.0.7

func (siw *ServerInterfaceWrapper) OpenPullRequest(w http.ResponseWriter, r *http.Request)

OpenPullRequest operation middleware

func (*ServerInterfaceWrapper) PostActivity added in v0.7.0

func (siw *ServerInterfaceWrapper) PostActivity(w http.ResponseWriter, r *http.Request)

PostActivity operation middleware

func (*ServerInterfaceWrapper) PreviewBranchIssue added in v0.5.0

func (siw *ServerInterfaceWrapper) PreviewBranchIssue(w http.ResponseWriter, r *http.Request)

PreviewBranchIssue operation middleware

func (*ServerInterfaceWrapper) Push added in v0.0.7

Push operation middleware

func (*ServerInterfaceWrapper) RemoveFavorite added in v0.6.0

func (siw *ServerInterfaceWrapper) RemoveFavorite(w http.ResponseWriter, r *http.Request)

RemoveFavorite operation middleware

func (*ServerInterfaceWrapper) RemoveLocalData added in v0.7.0

func (siw *ServerInterfaceWrapper) RemoveLocalData(w http.ResponseWriter, r *http.Request)

RemoveLocalData operation middleware

func (*ServerInterfaceWrapper) RerunChecks added in v0.7.0

func (siw *ServerInterfaceWrapper) RerunChecks(w http.ResponseWriter, r *http.Request)

RerunChecks operation middleware

func (*ServerInterfaceWrapper) SetRepoGroups added in v0.5.0

func (siw *ServerInterfaceWrapper) SetRepoGroups(w http.ResponseWriter, r *http.Request)

SetRepoGroups operation middleware

func (*ServerInterfaceWrapper) SetUp added in v0.7.0

SetUp operation middleware

func (*ServerInterfaceWrapper) SetUpHooks added in v0.7.0

func (siw *ServerInterfaceWrapper) SetUpHooks(w http.ResponseWriter, r *http.Request)

SetUpHooks operation middleware

func (*ServerInterfaceWrapper) Stage added in v0.3.0

Stage operation middleware

func (*ServerInterfaceWrapper) StartTask added in v0.4.1

func (siw *ServerInterfaceWrapper) StartTask(w http.ResponseWriter, r *http.Request)

StartTask operation middleware

func (*ServerInterfaceWrapper) StopRun added in v0.7.0

StopRun operation middleware

func (*ServerInterfaceWrapper) StopTask added in v0.4.1

func (siw *ServerInterfaceWrapper) StopTask(w http.ResponseWriter, r *http.Request)

StopTask operation middleware

func (*ServerInterfaceWrapper) SwitchRepository added in v0.6.0

func (siw *ServerInterfaceWrapper) SwitchRepository(w http.ResponseWriter, r *http.Request)

SwitchRepository operation middleware

func (*ServerInterfaceWrapper) SyncTasks added in v0.4.1

func (siw *ServerInterfaceWrapper) SyncTasks(w http.ResponseWriter, r *http.Request)

SyncTasks operation middleware

func (*ServerInterfaceWrapper) TrackIssue added in v0.4.1

func (siw *ServerInterfaceWrapper) TrackIssue(w http.ResponseWriter, r *http.Request)

TrackIssue operation middleware

func (*ServerInterfaceWrapper) TransitionIssue added in v0.3.0

func (siw *ServerInterfaceWrapper) TransitionIssue(w http.ResponseWriter, r *http.Request)

TransitionIssue operation middleware

func (*ServerInterfaceWrapper) UndoTasks added in v0.4.1

func (siw *ServerInterfaceWrapper) UndoTasks(w http.ResponseWriter, r *http.Request)

UndoTasks operation middleware

func (*ServerInterfaceWrapper) UnlinkBranchIssue added in v0.5.0

func (siw *ServerInterfaceWrapper) UnlinkBranchIssue(w http.ResponseWriter, r *http.Request)

UnlinkBranchIssue operation middleware

func (*ServerInterfaceWrapper) Unstage added in v0.3.0

Unstage operation middleware

func (*ServerInterfaceWrapper) UpdateConfig

func (siw *ServerInterfaceWrapper) UpdateConfig(w http.ResponseWriter, r *http.Request)

UpdateConfig operation middleware

type SetRepoGroups200JSONResponse added in v0.5.0

type SetRepoGroups200JSONResponse RepoGroups

func (SetRepoGroups200JSONResponse) VisitSetRepoGroupsResponse added in v0.5.0

func (response SetRepoGroups200JSONResponse) VisitSetRepoGroupsResponse(w http.ResponseWriter) error

type SetRepoGroups422ApplicationProblemPlusJSONResponse added in v0.5.0

type SetRepoGroups422ApplicationProblemPlusJSONResponse Problem

func (SetRepoGroups422ApplicationProblemPlusJSONResponse) VisitSetRepoGroupsResponse added in v0.5.0

func (response SetRepoGroups422ApplicationProblemPlusJSONResponse) VisitSetRepoGroupsResponse(w http.ResponseWriter) error

type SetRepoGroupsJSONRequestBody added in v0.5.0

type SetRepoGroupsJSONRequestBody = RepoGroupsRequest

SetRepoGroupsJSONRequestBody defines body for SetRepoGroups for application/json ContentType.

type SetRepoGroupsRequestObject added in v0.5.0

type SetRepoGroupsRequestObject struct {
	Body *SetRepoGroupsJSONRequestBody
}

type SetRepoGroupsResponseObject added in v0.5.0

type SetRepoGroupsResponseObject interface {
	VisitSetRepoGroupsResponse(w http.ResponseWriter) error
}

type SetRepoGroupsdefaultApplicationProblemPlusJSONResponse added in v0.5.0

type SetRepoGroupsdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (SetRepoGroupsdefaultApplicationProblemPlusJSONResponse) VisitSetRepoGroupsResponse added in v0.5.0

type SetUp200JSONResponse added in v0.7.0

type SetUp200JSONResponse SetupResult

func (SetUp200JSONResponse) VisitSetUpResponse added in v0.7.0

func (response SetUp200JSONResponse) VisitSetUpResponse(w http.ResponseWriter) error

type SetUp409ApplicationProblemPlusJSONResponse added in v0.7.0

type SetUp409ApplicationProblemPlusJSONResponse Problem

func (SetUp409ApplicationProblemPlusJSONResponse) VisitSetUpResponse added in v0.7.0

type SetUp422ApplicationProblemPlusJSONResponse added in v0.7.0

type SetUp422ApplicationProblemPlusJSONResponse Problem

func (SetUp422ApplicationProblemPlusJSONResponse) VisitSetUpResponse added in v0.7.0

type SetUpHooks200JSONResponse added in v0.7.0

type SetUpHooks200JSONResponse HookSetupWritten

func (SetUpHooks200JSONResponse) VisitSetUpHooksResponse added in v0.7.0

func (response SetUpHooks200JSONResponse) VisitSetUpHooksResponse(w http.ResponseWriter) error

type SetUpHooks409ApplicationProblemPlusJSONResponse added in v0.7.0

type SetUpHooks409ApplicationProblemPlusJSONResponse Problem

func (SetUpHooks409ApplicationProblemPlusJSONResponse) VisitSetUpHooksResponse added in v0.7.0

func (response SetUpHooks409ApplicationProblemPlusJSONResponse) VisitSetUpHooksResponse(w http.ResponseWriter) error

type SetUpHooks422ApplicationProblemPlusJSONResponse added in v0.7.0

type SetUpHooks422ApplicationProblemPlusJSONResponse Problem

func (SetUpHooks422ApplicationProblemPlusJSONResponse) VisitSetUpHooksResponse added in v0.7.0

func (response SetUpHooks422ApplicationProblemPlusJSONResponse) VisitSetUpHooksResponse(w http.ResponseWriter) error

type SetUpHooksJSONRequestBody added in v0.7.0

type SetUpHooksJSONRequestBody = HookSetupRequest

SetUpHooksJSONRequestBody defines body for SetUpHooks for application/json ContentType.

type SetUpHooksRequestObject added in v0.7.0

type SetUpHooksRequestObject struct {
	Body *SetUpHooksJSONRequestBody
}

type SetUpHooksResponseObject added in v0.7.0

type SetUpHooksResponseObject interface {
	VisitSetUpHooksResponse(w http.ResponseWriter) error
}

type SetUpHooksdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type SetUpHooksdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (SetUpHooksdefaultApplicationProblemPlusJSONResponse) VisitSetUpHooksResponse added in v0.7.0

type SetUpJSONRequestBody added in v0.7.0

type SetUpJSONRequestBody = SetupRequest

SetUpJSONRequestBody defines body for SetUp for application/json ContentType.

type SetUpRequestObject added in v0.7.0

type SetUpRequestObject struct {
	Body *SetUpJSONRequestBody
}

type SetUpResponseObject added in v0.7.0

type SetUpResponseObject interface {
	VisitSetUpResponse(w http.ResponseWriter) error
}

type SetUpdefaultApplicationProblemPlusJSONResponse added in v0.7.0

type SetUpdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (SetUpdefaultApplicationProblemPlusJSONResponse) VisitSetUpResponse added in v0.7.0

type SetupOffer added in v0.7.0

type SetupOffer struct {
	// Needed No configuration file applies where the server works, so one can be set up.
	Needed bool `json:"needed"`

	// Places Where the file may go, the repository first.
	Places []SetupPlace `json:"places"`
}

SetupOffer The first-run setup offered where the server works.

type SetupPlace added in v0.7.0

type SetupPlace struct {
	// Keychain The OS keychain can keep the Jira token out of this file, in the item for Jira's address, which any file may read: one is wired.
	Keychain bool `json:"keychain"`

	// Path The file it would be, as an absolute path.
	Path string `json:"path"`

	// Place repository is the repository's root, or the working directory outside a repository; home is the home directory.
	Place SetupPlaceName `json:"place"`

	// Shown The file written from your home.
	Shown string `json:"shown"`
}

SetupPlace defines model for SetupPlace.

type SetupPlaceName added in v0.7.0

type SetupPlaceName string

SetupPlaceName repository is the repository's root, or the working directory outside a repository; home is the home directory.

const (
	SetupPlaceNameHome       SetupPlaceName = "home"
	SetupPlaceNameRepository SetupPlaceName = "repository"
)

Defines values for SetupPlaceName.

func (SetupPlaceName) Valid added in v0.7.0

func (e SetupPlaceName) Valid() bool

Valid indicates whether the value is a known member of the SetupPlaceName enum.

type SetupRequest added in v0.7.0

type SetupRequest struct {
	// JiraBaseURL Jira's address; empty leaves Jira out, and the forge's issues are the tracker.
	JiraBaseURL string `json:"jira_base_url"`

	// JiraToken The Jira personal access token. Never echoed back.
	JiraToken string `json:"jira_token"`

	// KeepUnchecked Write Jira's address and token even when Jira does not accept them, or cannot be asked. An address that is not an https address, or http to this machine, or that carries a username and password, is never kept.
	KeepUnchecked bool `json:"keep_unchecked"`

	// Keychain Keep the Jira token in the OS keychain rather than in the file.
	Keychain bool `json:"keychain"`

	// Place repository is the repository's root, or the working directory outside a repository; home is the home directory.
	Place SetupPlaceName `json:"place"`

	// WebhookURL A Slack incoming webhook, saved unchecked; empty posts with the Slack user token.
	WebhookURL string `json:"webhook_url"`
}

SetupRequest defines model for SetupRequest.

type SetupResult added in v0.7.0

type SetupResult struct {
	// JiraUser Whom the token authenticates as; empty when Jira was left out or kept unchecked.
	JiraUser string `json:"jira_user"`

	// Keychain The OS keychain keeps the token, in the item for Jira's address, and the file reads it from there (jira.keychain).
	Keychain bool `json:"keychain"`

	// NotIgnored The file is in a repository that does not ignore it, so it could be committed.
	NotIgnored bool `json:"not_ignored"`

	// Path The file written, as an absolute path.
	Path string `json:"path"`

	// Reopened The server works with the file now. False when it could not take it up, which a restart of workflow --web does.
	Reopened bool `json:"reopened"`

	// Shown The file written from your home.
	Shown string `json:"shown"`
}

SetupResult defines model for SetupResult.

type SlackDirectory added in v0.5.0

type SlackDirectory struct {
	Entries []SlackTarget `json:"entries"`

	// MissingScope The scope to add to the Slack token for this read; entries are empty then.
	//
	// Example: users:read
	MissingScope *string `json:"missing_scope,omitempty"`
}

SlackDirectory People or user groups read from Slack, or the scope the token lacks to read them.

type SlackTarget added in v0.5.0

type SlackTarget struct {
	// ID A user ID (U or W…) or a user group ID (S…).
	//
	// Example: U024BE7LH
	ID string `json:"id"`

	// Label The name to show for it.
	Label string `json:"label"`
}

SlackTarget A Slack user or user group, by its ID and the name Slack shows for it.

type Snapshot

type Snapshot struct {
	Branch Branch `json:"branch"`

	// Branches The branches named for one of your issues, local ones and those only the remote has — the record of what is in flight. The detail panels (branch, changes, review) describe the checked-out branch alone; this lists every issue of yours that has a branch, so the issues list can mark them all in flight, not the one on HEAD. An issue is yours when the tracker says it is assigned to you and not done; with no tracker to ask, every branch that names an issue is listed.
	Branches []TaskBranch `json:"branches"`
	Changes  ChangeList   `json:"changes"`

	// CommitTypes The commit types a new commit may take, in the order to offer them — the terminal composer's list: commit.types, trimmed, when the configuration names any, else the built-in Conventional Commit types. A commit whose type is not among them is refused.
	//
	// Example: ["feat","fix","docs"]
	CommitTypes []string `json:"commit_types"`

	// Here The directory the server works in, as an absolute path, so a page notices a switch made elsewhere and reads again.
	Here string `json:"here"`

	// HooksUnmanaged How many git hooks the repository's hooks directory holds that lefthook does not manage, while the repository configures no lefthook — which GET /api/hooks/setup offers to set up; 0 otherwise.
	HooksUnmanaged int                  `json:"hooks_unmanaged"`
	Issues         IssuesPage           `json:"issues"`
	Messaging      MessagingDestination `json:"messaging"`

	// Problems Why each panel whose read failed was not read, so a failed read is shown as a failure rather than as the panel's empty state; absent when every panel read. A failed panel still carries its empty answer — or, for the review, the answer the forge last gave for the branch at its head — beside its problem. A service that is not set up — no credential, no forge the base remote names — carries a problem whose code is not_set_up, with how to set it up, to be shown as guidance rather than as a failure; no repository is no problem. Each detail is the curated one an error answer carries, never a host, a path or a credential.
	Problems *PanelProblems `json:"problems,omitempty"`

	// QueuedAnnouncement An announcement held until a pull request's CI passes, and how it stands: waiting for the CI, being posted, posted, or dropped unposted with the reason.
	QueuedAnnouncement *QueuedAnnouncement `json:"queued_announcement,omitempty"`
	Review             Review              `json:"review"`

	// Run The git run going now (POST /api/runs), with its last 200 lines, so a page opened while it runs sees it; absent when none is going.
	Run *Run `json:"run,omitempty"`

	// Stages The loop's stages for the checked-out branch, in order — its issue, the branch, its commits, its pull request's review and the announcement — each named as the terminal's spine and `workflow status` name it and in the state their rules give it, so every surface shows the same stages, by the same names, in the same states. They are read from what the frame holds: the review from the pull request and CI the review panel shows, and a working tree that could not be read as nothing to commit.
	Stages []Stage `json:"stages"`

	// SubjectLimit The longest a new commit's header may be, in characters, counted as the terminal composer counts it — the type, scope, breaking mark and subject together: commit.subject_limit when the configuration sets one, else the built-in 72. A commit whose header is longer is refused.
	//
	// Example: 72
	SubjectLimit int `json:"subject_limit"`

	// SuggestedScope The scope a new commit opens on — the terminal composer's rule: the scope last committed with in this repository, else commit.default_scope, else empty. The server reads the learned one from its store once, and once more after a commit here records one, not on every message, and never under --dry-run, when the default alone applies.
	//
	// Example: api
	SuggestedScope string `json:"suggested_scope"`

	// Tasks What the event stream carries of your Taskwarrior tasks: the started one, as active — absent when none is started — and every task linked to an issue. Until Taskwarrior has answered both reads the summary makes, it is not available, with no active task and no linked one.
	Tasks TasksSummary `json:"tasks"`

	// UnstartedStages The loop's stages for an issue with no branch yet, as its work story shows them while it is open: the issue picked but not yet branched for, as the terminal's spine reads an issue selected, and nothing after it begun. An issue with a branch has that branch's stages instead (TaskBranch.stages).
	UnstartedStages []Stage `json:"unstarted_stages"`
}

Snapshot The full read state carried by one event-stream message: everything the cockpit shows, together.

type Stage added in v0.9.0

type Stage struct {
	// Name The stage as every surface titles it, as the terminal's spine and `workflow status` name it: Issue, Branch, Commits, Review, and the messaging service the work is announced on, as the configuration names it.
	//
	// Example: Review
	Name string `json:"name"`

	// State How far it has got: not begun, under way, complete, or failed — a CI failure or changes asked for, something to go back to.
	State StageState `json:"state"`

	// Step Which stage of the loop this is, whatever it is named.
	Step StageStep `json:"step"`
}

Stage One stage of the loop for an issue's work: the checked-out branch's (Snapshot.stages), another branch's as the server knows it without checking it out (TaskBranch.stages), or an issue's not yet branched for (Snapshot.unstarted_stages).

type Stage200JSONResponse added in v0.3.0

type Stage200JSONResponse ChangeList

func (Stage200JSONResponse) VisitStageResponse added in v0.3.0

func (response Stage200JSONResponse) VisitStageResponse(w http.ResponseWriter) error

type Stage404ApplicationProblemPlusJSONResponse added in v0.3.0

type Stage404ApplicationProblemPlusJSONResponse Problem

func (Stage404ApplicationProblemPlusJSONResponse) VisitStageResponse added in v0.3.0

type Stage422ApplicationProblemPlusJSONResponse added in v0.3.0

type Stage422ApplicationProblemPlusJSONResponse Problem

func (Stage422ApplicationProblemPlusJSONResponse) VisitStageResponse added in v0.3.0

type StageJSONRequestBody added in v0.3.0

type StageJSONRequestBody = StagingRequest

StageJSONRequestBody defines body for Stage for application/json ContentType.

type StageRequestObject added in v0.3.0

type StageRequestObject struct {
	Body *StageJSONRequestBody
}

type StageResponseObject added in v0.3.0

type StageResponseObject interface {
	VisitStageResponse(w http.ResponseWriter) error
}

type StageState added in v0.9.0

type StageState string

StageState How far it has got: not begun, under way, complete, or failed — a CI failure or changes asked for, something to go back to.

const (
	StageStateDone       StageState = "done"
	StageStateFailed     StageState = "failed"
	StageStateInFlight   StageState = "in_flight"
	StageStateNotStarted StageState = "not_started"
)

Defines values for StageState.

func (StageState) Valid added in v0.9.0

func (e StageState) Valid() bool

Valid indicates whether the value is a known member of the StageState enum.

type StageStep added in v0.9.0

type StageStep string

StageStep Which stage of the loop this is, whatever it is named.

const (
	StageStepAnnounce StageStep = "announce"
	StageStepBranch   StageStep = "branch"
	StageStepCommits  StageStep = "commits"
	StageStepIssue    StageStep = "issue"
	StageStepReview   StageStep = "review"
)

Defines values for StageStep.

func (StageStep) Valid added in v0.9.0

func (e StageStep) Valid() bool

Valid indicates whether the value is a known member of the StageStep enum.

type StagedefaultApplicationProblemPlusJSONResponse added in v0.3.0

type StagedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (StagedefaultApplicationProblemPlusJSONResponse) VisitStageResponse added in v0.3.0

type StagingRequest added in v0.3.0

type StagingRequest struct {
	// All Every change: for staging, each one the index does not hold yet; for unstaging, each staged one.
	All *bool `json:"all,omitempty"`

	// Path A changed file, by the path the working tree's changes list it under (a rename's new path).
	//
	// Example: internal/config/config.go
	Path *string `json:"path,omitempty"`
}

StagingRequest What to stage or unstage: one changed file, or all of them — one or the other, never both.

type StartRunJSONRequestBody added in v0.7.0

type StartRunJSONRequestBody = RunRequest

StartRunJSONRequestBody defines body for StartRun for application/json ContentType.

type StartTask200JSONResponse added in v0.4.1

type StartTask200JSONResponse TaskList

func (StartTask200JSONResponse) VisitStartTaskResponse added in v0.4.1

func (response StartTask200JSONResponse) VisitStartTaskResponse(w http.ResponseWriter) error

type StartTask409ApplicationProblemPlusJSONResponse added in v0.4.1

type StartTask409ApplicationProblemPlusJSONResponse Problem

func (StartTask409ApplicationProblemPlusJSONResponse) VisitStartTaskResponse added in v0.4.1

func (response StartTask409ApplicationProblemPlusJSONResponse) VisitStartTaskResponse(w http.ResponseWriter) error

type StartTask422ApplicationProblemPlusJSONResponse added in v0.4.1

type StartTask422ApplicationProblemPlusJSONResponse Problem

func (StartTask422ApplicationProblemPlusJSONResponse) VisitStartTaskResponse added in v0.4.1

func (response StartTask422ApplicationProblemPlusJSONResponse) VisitStartTaskResponse(w http.ResponseWriter) error

type StartTaskRequestObject added in v0.4.1

type StartTaskRequestObject struct {
	UUID TaskUUID `json:"uuid"`
}

type StartTaskResponseObject added in v0.4.1

type StartTaskResponseObject interface {
	VisitStartTaskResponse(w http.ResponseWriter) error
}

type StartTaskdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type StartTaskdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (StartTaskdefaultApplicationProblemPlusJSONResponse) VisitStartTaskResponse added in v0.4.1

type StatusCategory

type StatusCategory string

StatusCategory defines model for StatusCategory.

const (
	StatusCategoryDone          StatusCategory = "done"
	StatusCategoryIndeterminate StatusCategory = "indeterminate"
	StatusCategoryNew           StatusCategory = "new"
)

Defines values for StatusCategory.

func (StatusCategory) Valid

func (e StatusCategory) Valid() bool

Valid indicates whether the value is a known member of the StatusCategory enum.

type StatusChange added in v0.7.0

type StatusChange struct {
	// Fields The fields the tracker refuses the change without, ordered by name.
	Fields []StatusChangeField `json:"fields"`

	// ID The change's id, which applying it names.
	//
	// Example: 5
	ID string `json:"id"`

	// Name The change's own name, which can differ from where it leads.
	//
	// Example: Resolve Issue
	Name string `json:"name"`

	// ToStatus Example: Resolved
	ToStatus         string         `json:"to_status"`
	ToStatusCategory StatusCategory `json:"to_status_category"`
}

StatusChange A status change the tracker offers an issue, and the fields it cannot be made without.

type StatusChangeField added in v0.7.0

type StatusChangeField struct {
	// ID Example: resolution
	ID string `json:"id"`

	// Kind How the field is filled: one of its options, any number of them, free text, a username, a date as 2026-09-21, or only_jira for one only Jira's own screen can fill, such as a cascading select, which keeps the change out of reach here.
	Kind StatusChangeFieldKind `json:"kind"`

	// Name Example: Resolution
	Name string `json:"name"`

	// Options The values an option or option_list field allows; empty for the others.
	Options []FieldOption `json:"options"`
}

StatusChangeField A field a status change needs, and how it is filled.

type StatusChangeFieldKind added in v0.7.0

type StatusChangeFieldKind string

StatusChangeFieldKind How the field is filled: one of its options, any number of them, free text, a username, a date as 2026-09-21, or only_jira for one only Jira's own screen can fill, such as a cascading select, which keeps the change out of reach here.

const (
	StatusChangeFieldKindDate       StatusChangeFieldKind = "date"
	StatusChangeFieldKindOnlyJira   StatusChangeFieldKind = "only_jira"
	StatusChangeFieldKindOption     StatusChangeFieldKind = "option"
	StatusChangeFieldKindOptionList StatusChangeFieldKind = "option_list"
	StatusChangeFieldKindText       StatusChangeFieldKind = "text"
	StatusChangeFieldKindUser       StatusChangeFieldKind = "user"
)

Defines values for StatusChangeFieldKind.

func (StatusChangeFieldKind) Valid added in v0.7.0

func (e StatusChangeFieldKind) Valid() bool

Valid indicates whether the value is a known member of the StatusChangeFieldKind enum.

type StatusChangeRequest added in v0.7.0

type StatusChangeRequest struct {
	// Fields A value for each field the change needs, and no other.
	Fields []FieldEntry `json:"fields"`

	// TransitionID The change's id, as GET /api/issues/{key}/transitions lists it.
	TransitionID string `json:"transition_id"`
}

StatusChangeRequest The status change to make, and a value for each field it needs.

type StdHTTPServerOptions

type StdHTTPServerOptions struct {
	BaseURL          string
	BaseRouter       ServeMux
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StopRun204Response added in v0.7.0

type StopRun204Response struct {
}

func (StopRun204Response) VisitStopRunResponse added in v0.7.0

func (response StopRun204Response) VisitStopRunResponse(w http.ResponseWriter) error

type StopRun404ApplicationProblemPlusJSONResponse added in v0.7.0

type StopRun404ApplicationProblemPlusJSONResponse Problem

func (StopRun404ApplicationProblemPlusJSONResponse) VisitStopRunResponse added in v0.7.0

func (response StopRun404ApplicationProblemPlusJSONResponse) VisitStopRunResponse(w http.ResponseWriter) error

type StopRunRequestObject added in v0.7.0

type StopRunRequestObject struct {
}

type StopRunResponseObject added in v0.7.0

type StopRunResponseObject interface {
	VisitStopRunResponse(w http.ResponseWriter) error
}

type StopRundefaultApplicationProblemPlusJSONResponse added in v0.7.0

type StopRundefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (StopRundefaultApplicationProblemPlusJSONResponse) VisitStopRunResponse added in v0.7.0

type StopTask200JSONResponse added in v0.4.1

type StopTask200JSONResponse TaskList

func (StopTask200JSONResponse) VisitStopTaskResponse added in v0.4.1

func (response StopTask200JSONResponse) VisitStopTaskResponse(w http.ResponseWriter) error

type StopTask409ApplicationProblemPlusJSONResponse added in v0.4.1

type StopTask409ApplicationProblemPlusJSONResponse Problem

func (StopTask409ApplicationProblemPlusJSONResponse) VisitStopTaskResponse added in v0.4.1

func (response StopTask409ApplicationProblemPlusJSONResponse) VisitStopTaskResponse(w http.ResponseWriter) error

type StopTask422ApplicationProblemPlusJSONResponse added in v0.4.1

type StopTask422ApplicationProblemPlusJSONResponse Problem

func (StopTask422ApplicationProblemPlusJSONResponse) VisitStopTaskResponse added in v0.4.1

func (response StopTask422ApplicationProblemPlusJSONResponse) VisitStopTaskResponse(w http.ResponseWriter) error

type StopTaskRequestObject added in v0.4.1

type StopTaskRequestObject struct {
	UUID TaskUUID `json:"uuid"`
}

type StopTaskResponseObject added in v0.4.1

type StopTaskResponseObject interface {
	VisitStopTaskResponse(w http.ResponseWriter) error
}

type StopTaskdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type StopTaskdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (StopTaskdefaultApplicationProblemPlusJSONResponse) VisitStopTaskResponse added in v0.4.1

type StoreConfig added in v0.3.0

type StoreConfig struct {
	// Disabled Turn off the on-disk store, keeping nothing between sessions. Off by default: the store is on and never holds a secret.
	Disabled *bool `json:"disabled,omitempty"`
}

StoreConfig defines model for StoreConfig.

type StreamEventsParams

type StreamEventsParams struct {
	// View The configured view's name whose issues to include; the default view when omitted.
	View *string `form:"view,omitempty" json:"view,omitempty"`
}

StreamEventsParams defines parameters for StreamEvents.

type StrictHTTPServerOptions

type StrictHTTPServerOptions struct {
	RequestErrorHandlerFunc  func(w http.ResponseWriter, r *http.Request, err error)
	ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHandlerFunc

type StrictHandlerFunc func(ctx context.Context, w http.ResponseWriter, r *http.Request, request any) (any, error)

type StrictMiddlewareFunc

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServerInterface

type StrictServerInterface interface {
	// GetActivity What you did over a period, grouped by year, month, day and hour.
	// (GET /api/activity)
	GetActivity(ctx context.Context, request GetActivityRequestObject) (GetActivityResponseObject, error)
	// PostActivity Post the Summary to the configured messaging service.
	// (POST /api/activity/post)
	PostActivity(ctx context.Context, request PostActivityRequestObject) (PostActivityResponseObject, error)
	// Announce Post the pull request announcement to the configured service.
	// (POST /api/announce)
	Announce(ctx context.Context, request AnnounceRequestObject) (AnnounceResponseObject, error)
	// CancelQueuedAnnouncement Drop the announcement waiting for CI to pass, unposted.
	// (DELETE /api/announce/queued)
	CancelQueuedAnnouncement(ctx context.Context, request CancelQueuedAnnouncementRequestObject) (CancelQueuedAnnouncementResponseObject, error)
	// GetAnnouncement The announcement message that would be posted, for a preview.
	// (GET /api/announcement)
	GetAnnouncement(ctx context.Context, request GetAnnouncementRequestObject) (GetAnnouncementResponseObject, error)
	// GetBranch The current branch and how it stands against its base.
	// (GET /api/branch)
	GetBranch(ctx context.Context, request GetBranchRequestObject) (GetBranchResponseObject, error)
	// FinishBranch Finish a merged branch — switch to the base, catch it up, delete the branch.
	// (POST /api/branch/finish)
	FinishBranch(ctx context.Context, request FinishBranchRequestObject) (FinishBranchResponseObject, error)
	// UnlinkBranchIssue Forget the issue the checked-out branch was linked to.
	// (DELETE /api/branch/issue)
	UnlinkBranchIssue(ctx context.Context, request UnlinkBranchIssueRequestObject) (UnlinkBranchIssueResponseObject, error)
	// LinkBranchIssue Link the checked-out branch to an issue, for work begun outside workflow.
	// (PUT /api/branch/issue)
	LinkBranchIssue(ctx context.Context, request LinkBranchIssueRequestObject) (LinkBranchIssueResponseObject, error)
	// PreviewBranchIssue What linking the checked-out branch to an issue would write in its pull request.
	// (GET /api/branch/issue/preview)
	PreviewBranchIssue(ctx context.Context, request PreviewBranchIssueRequestObject) (PreviewBranchIssueResponseObject, error)
	// CreateBranch Create and switch to a branch for an issue — start work on it.
	// (POST /api/branches)
	CreateBranch(ctx context.Context, request CreateBranchRequestObject) (CreateBranchResponseObject, error)
	// ListChanges The working tree's changes.
	// (GET /api/changes)
	ListChanges(ctx context.Context, request ListChangesRequestObject) (ListChangesResponseObject, error)
	// GetChangeDiff A changed file's diff against HEAD, so it can be read before staging.
	// (GET /api/changes/diff)
	GetChangeDiff(ctx context.Context, request GetChangeDiffRequestObject) (GetChangeDiffResponseObject, error)
	// Checkout Check out a local branch, switching the working tree to it.
	// (POST /api/checkout)
	Checkout(ctx context.Context, request CheckoutRequestObject) (CheckoutResponseObject, error)
	// Commit Commit the staged changes with a Conventional Commit message.
	// (POST /api/commit)
	Commit(ctx context.Context, request CommitRequestObject) (CommitResponseObject, error)
	// GetConfig The configuration in effect, with secrets masked.
	// (GET /api/config)
	GetConfig(ctx context.Context, request GetConfigRequestObject) (GetConfigResponseObject, error)
	// UpdateConfig Write the configuration file.
	// (PUT /api/config)
	UpdateConfig(ctx context.Context, request UpdateConfigRequestObject) (UpdateConfigResponseObject, error)
	// GetSetup Whether a first configuration file is needed here, and where it may go.
	// (GET /api/config/setup)
	GetSetup(ctx context.Context, request GetSetupRequestObject) (GetSetupResponseObject, error)
	// SetUp Write a first configuration file, as workflow config init does.
	// (POST /api/config/setup)
	SetUp(ctx context.Context, request SetUpRequestObject) (SetUpResponseObject, error)
	// GetDirectories The directories in one, to browse for a directory to switch to.
	// (GET /api/directories)
	GetDirectories(ctx context.Context, request GetDirectoriesRequestObject) (GetDirectoriesResponseObject, error)
	// Discard Drop a changed file's changes, staged and not.
	// (POST /api/discard)
	Discard(ctx context.Context, request DiscardRequestObject) (DiscardResponseObject, error)
	// GetHealth Server and build information.
	// (GET /api/health)
	GetHealth(ctx context.Context, request GetHealthRequestObject) (GetHealthResponseObject, error)
	// ListHooks The hooks lefthook configures, split by whether a run by hand can run them.
	// (GET /api/hooks)
	ListHooks(ctx context.Context, request ListHooksRequestObject) (ListHooksResponseObject, error)
	// GetHookSetup The lefthook configuration offered for hooks lefthook does not manage.
	// (GET /api/hooks/setup)
	GetHookSetup(ctx context.Context, request GetHookSetupRequestObject) (GetHookSetupResponseObject, error)
	// SetUpHooks Write the offered lefthook.yml and install lefthook.
	// (POST /api/hooks/setup)
	SetUpHooks(ctx context.Context, request SetUpHooksRequestObject) (SetUpHooksResponseObject, error)
	// ListIssues One page of the issues a view matches.
	// (GET /api/issues)
	ListIssues(ctx context.Context, request ListIssuesRequestObject) (ListIssuesResponseObject, error)
	// GetIssue One issue in full, with its comments.
	// (GET /api/issues/{key})
	GetIssue(ctx context.Context, request GetIssueRequestObject) (GetIssueResponseObject, error)
	// AssignIssue Assign an issue to someone, by username.
	// (PUT /api/issues/{key}/assignee)
	AssignIssue(ctx context.Context, request AssignIssueRequestObject) (AssignIssueResponseObject, error)
	// AddComment Comment on an issue, in Jira or on the forge.
	// (POST /api/issues/{key}/comment)
	AddComment(ctx context.Context, request AddCommentRequestObject) (AddCommentResponseObject, error)
	// LinkPullRequest Link the checked-out branch's pull request on its issue.
	// (POST /api/issues/{key}/link)
	LinkPullRequest(ctx context.Context, request LinkPullRequestRequestObject) (LinkPullRequestResponseObject, error)
	// TransitionIssue Move an issue to the configured review status.
	// (POST /api/issues/{key}/transition)
	TransitionIssue(ctx context.Context, request TransitionIssueRequestObject) (TransitionIssueResponseObject, error)
	// ListStatusChanges The status changes the tracker offers an issue, with the fields each needs.
	// (GET /api/issues/{key}/transitions)
	ListStatusChanges(ctx context.Context, request ListStatusChangesRequestObject) (ListStatusChangesResponseObject, error)
	// ChangeStatus Change an issue's status, filling the fields the change needs.
	// (POST /api/issues/{key}/transitions)
	ChangeStatus(ctx context.Context, request ChangeStatusRequestObject) (ChangeStatusResponseObject, error)
	// LogWork Log time spent on a Jira issue.
	// (POST /api/issues/{key}/worklog)
	LogWork(ctx context.Context, request LogWorkRequestObject) (LogWorkResponseObject, error)
	// GetKeys The terminal interface's key actions, as its help lists them.
	// (GET /api/keys)
	GetKeys(ctx context.Context, request GetKeysRequestObject) (GetKeysResponseObject, error)
	// RemoveLocalData Remove the cache, or with scope all the kept associations too.
	// (DELETE /api/local-data)
	RemoveLocalData(ctx context.Context, request RemoveLocalDataRequestObject) (RemoveLocalDataResponseObject, error)
	// GetLocalData The local databases workflow keeps, each with its size and what it holds.
	// (GET /api/local-data)
	GetLocalData(ctx context.Context, request GetLocalDataRequestObject) (GetLocalDataResponseObject, error)
	// GetMessaging The service, channel, its alternates, and who a post would come from.
	// (GET /api/messaging)
	GetMessaging(ctx context.Context, request GetMessagingRequestObject) (GetMessagingResponseObject, error)
	// ForgetPerson Forget what was decided for a code owner, so they are asked again.
	// (DELETE /api/people)
	ForgetPerson(ctx context.Context, request ForgetPersonRequestObject) (ForgetPersonResponseObject, error)
	// GetPeople Whom each code owner is on Slack, on this repository's forge host.
	// (GET /api/people)
	GetPeople(ctx context.Context, request GetPeopleRequestObject) (GetPeopleResponseObject, error)
	// LinkPerson Record whom a code owner is on Slack, or that they are not on it.
	// (PUT /api/people)
	LinkPerson(ctx context.Context, request LinkPersonRequestObject) (LinkPersonResponseObject, error)
	// GetPullRequestText The branch's open pull request's title and description, to edit them.
	// (GET /api/pull-request)
	GetPullRequestText(ctx context.Context, request GetPullRequestTextRequestObject) (GetPullRequestTextResponseObject, error)
	// EditPullRequest Change the branch's open pull request's title and description.
	// (PATCH /api/pull-request)
	EditPullRequest(ctx context.Context, request EditPullRequestRequestObject) (EditPullRequestResponseObject, error)
	// OpenPullRequest Open a pull request for the current branch, pushing it first if needed.
	// (POST /api/pull-request)
	OpenPullRequest(ctx context.Context, request OpenPullRequestRequestObject) (OpenPullRequestResponseObject, error)
	// GetPullRequestDraft The pull request that would be opened for the branch, for a preview.
	// (GET /api/pull-request/draft)
	GetPullRequestDraft(ctx context.Context, request GetPullRequestDraftRequestObject) (GetPullRequestDraftResponseObject, error)
	// GetMergeMethods How the branch's pull request may be merged, for the merge's preview.
	// (GET /api/pull-request/merge)
	GetMergeMethods(ctx context.Context, request GetMergeMethodsRequestObject) (GetMergeMethodsResponseObject, error)
	// MergePullRequest Merge the branch's pull request by a permitted method.
	// (POST /api/pull-request/merge)
	MergePullRequest(ctx context.Context, request MergePullRequestRequestObject) (MergePullRequestResponseObject, error)
	// Push Push the current branch to its remote, setting upstream.
	// (POST /api/push)
	Push(ctx context.Context, request PushRequestObject) (PushResponseObject, error)
	// GetRepoGroups The Slack user groups this repository's announcements may tag.
	// (GET /api/repo-groups)
	GetRepoGroups(ctx context.Context, request GetRepoGroupsRequestObject) (GetRepoGroupsResponseObject, error)
	// SetRepoGroups Replace the Slack user groups this repository may tag.
	// (PUT /api/repo-groups)
	SetRepoGroups(ctx context.Context, request SetRepoGroupsRequestObject) (SetRepoGroupsResponseObject, error)
	// GetRepositories Where the server works, and your favorite directories.
	// (GET /api/repositories)
	GetRepositories(ctx context.Context, request GetRepositoriesRequestObject) (GetRepositoriesResponseObject, error)
	// RemoveFavorite Forget a directory as a favorite.
	// (DELETE /api/repositories/favorites)
	RemoveFavorite(ctx context.Context, request RemoveFavoriteRequestObject) (RemoveFavoriteResponseObject, error)
	// AddFavorite Keep a directory as a favorite.
	// (PUT /api/repositories/favorites)
	AddFavorite(ctx context.Context, request AddFavoriteRequestObject) (AddFavoriteResponseObject, error)
	// SwitchRepository Switch the directory the server works in.
	// (PUT /api/repositories/here)
	SwitchRepository(ctx context.Context, request SwitchRepositoryRequestObject) (SwitchRepositoryResponseObject, error)
	// GetReview The branch's pull request and its CI, if one is open.
	// (GET /api/review)
	GetReview(ctx context.Context, request GetReviewRequestObject) (GetReviewResponseObject, error)
	// GetCheckLog The end of a check's log, read on demand.
	// (GET /api/review/checks/{id}/log)
	GetCheckLog(ctx context.Context, request GetCheckLogRequestObject) (GetCheckLogResponseObject, error)
	// RerunChecks Re-run the failed CI on the branch's pull request.
	// (POST /api/review/rerun)
	RerunChecks(ctx context.Context, request RerunChecksRequestObject) (RerunChecksResponseObject, error)
	// ListReviews The pull requests on the forge that wait on your review.
	// (GET /api/reviews)
	ListReviews(ctx context.Context, request ListReviewsRequestObject) (ListReviewsResponseObject, error)
	// StopRun Stop the run that is going.
	// (DELETE /api/runs/current)
	StopRun(ctx context.Context, request StopRunRequestObject) (StopRunResponseObject, error)
	// GetSlackGroups The Slack workspace's user groups, to tag or to link a team to.
	// (GET /api/slack/groups)
	GetSlackGroups(ctx context.Context, request GetSlackGroupsRequestObject) (GetSlackGroupsResponseObject, error)
	// GetSlackMembers The people in a Slack channel, to link a code owner to.
	// (GET /api/slack/members)
	GetSlackMembers(ctx context.Context, request GetSlackMembersRequestObject) (GetSlackMembersResponseObject, error)
	// Stage Stage a changed file, or every change the index does not hold yet.
	// (POST /api/stage)
	Stage(ctx context.Context, request StageRequestObject) (StageResponseObject, error)
	// ListTasks Your pending Taskwarrior tasks, most urgent first.
	// (GET /api/tasks)
	ListTasks(ctx context.Context, request ListTasksRequestObject) (ListTasksResponseObject, error)
	// AddTask Add a task from a line in Taskwarrior's own grammar.
	// (POST /api/tasks)
	AddTask(ctx context.Context, request AddTaskRequestObject) (AddTaskResponseObject, error)
	// SyncTasks Sync Taskwarrior with the backend its taskrc names.
	// (POST /api/tasks/sync)
	SyncTasks(ctx context.Context, request SyncTasksRequestObject) (SyncTasksResponseObject, error)
	// TrackIssue Track an issue in Taskwarrior.
	// (POST /api/tasks/track)
	TrackIssue(ctx context.Context, request TrackIssueRequestObject) (TrackIssueResponseObject, error)
	// UndoTasks Revert Taskwarrior's last change.
	// (POST /api/tasks/undo)
	UndoTasks(ctx context.Context, request UndoTasksRequestObject) (UndoTasksResponseObject, error)
	// AnnotateTask Add a note to a task.
	// (POST /api/tasks/{uuid}/annotations)
	AnnotateTask(ctx context.Context, request AnnotateTaskRequestObject) (AnnotateTaskResponseObject, error)
	// CompleteTask Complete a task.
	// (POST /api/tasks/{uuid}/done)
	CompleteTask(ctx context.Context, request CompleteTaskRequestObject) (CompleteTaskResponseObject, error)
	// ModifyTask Change a task by a line in Taskwarrior's own grammar.
	// (POST /api/tasks/{uuid}/modify)
	ModifyTask(ctx context.Context, request ModifyTaskRequestObject) (ModifyTaskResponseObject, error)
	// StartTask Start a task.
	// (POST /api/tasks/{uuid}/start)
	StartTask(ctx context.Context, request StartTaskRequestObject) (StartTaskResponseObject, error)
	// StopTask Stop a started task.
	// (POST /api/tasks/{uuid}/stop)
	StopTask(ctx context.Context, request StopTaskRequestObject) (StopTaskResponseObject, error)
	// Unstage Take a changed file out of the index, or every staged change.
	// (POST /api/unstage)
	Unstage(ctx context.Context, request UnstageRequestObject) (UnstageResponseObject, error)
	// ListViews The configured issue views (saved JQL), in order.
	// (GET /api/views)
	ListViews(ctx context.Context, request ListViewsRequestObject) (ListViewsResponseObject, error)
	// CreateWorktree Create a branch for an issue in a new worktree — start work on it there.
	// (POST /api/worktrees)
	CreateWorktree(ctx context.Context, request CreateWorktreeRequestObject) (CreateWorktreeResponseObject, error)
}

StrictServerInterface represents all server handlers.

type SwitchRepository200JSONResponse added in v0.6.0

type SwitchRepository200JSONResponse Repositories

func (SwitchRepository200JSONResponse) VisitSwitchRepositoryResponse added in v0.6.0

func (response SwitchRepository200JSONResponse) VisitSwitchRepositoryResponse(w http.ResponseWriter) error

type SwitchRepository404ApplicationProblemPlusJSONResponse added in v0.6.0

type SwitchRepository404ApplicationProblemPlusJSONResponse Problem

func (SwitchRepository404ApplicationProblemPlusJSONResponse) VisitSwitchRepositoryResponse added in v0.6.0

func (response SwitchRepository404ApplicationProblemPlusJSONResponse) VisitSwitchRepositoryResponse(w http.ResponseWriter) error

type SwitchRepository409ApplicationProblemPlusJSONResponse added in v0.6.0

type SwitchRepository409ApplicationProblemPlusJSONResponse Problem

func (SwitchRepository409ApplicationProblemPlusJSONResponse) VisitSwitchRepositoryResponse added in v0.6.0

func (response SwitchRepository409ApplicationProblemPlusJSONResponse) VisitSwitchRepositoryResponse(w http.ResponseWriter) error

type SwitchRepository422ApplicationProblemPlusJSONResponse added in v0.6.0

type SwitchRepository422ApplicationProblemPlusJSONResponse Problem

func (SwitchRepository422ApplicationProblemPlusJSONResponse) VisitSwitchRepositoryResponse added in v0.6.0

func (response SwitchRepository422ApplicationProblemPlusJSONResponse) VisitSwitchRepositoryResponse(w http.ResponseWriter) error

type SwitchRepositoryJSONRequestBody added in v0.6.0

type SwitchRepositoryJSONRequestBody = DirectoryChoice

SwitchRepositoryJSONRequestBody defines body for SwitchRepository for application/json ContentType.

type SwitchRepositoryRequestObject added in v0.6.0

type SwitchRepositoryRequestObject struct {
	Body *SwitchRepositoryJSONRequestBody
}

type SwitchRepositoryResponseObject added in v0.6.0

type SwitchRepositoryResponseObject interface {
	VisitSwitchRepositoryResponse(w http.ResponseWriter) error
}

type SwitchRepositorydefaultApplicationProblemPlusJSONResponse added in v0.6.0

type SwitchRepositorydefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (SwitchRepositorydefaultApplicationProblemPlusJSONResponse) VisitSwitchRepositoryResponse added in v0.6.0

func (response SwitchRepositorydefaultApplicationProblemPlusJSONResponse) VisitSwitchRepositoryResponse(w http.ResponseWriter) error

type SyncTasks200JSONResponse added in v0.4.1

type SyncTasks200JSONResponse TaskList

func (SyncTasks200JSONResponse) VisitSyncTasksResponse added in v0.4.1

func (response SyncTasks200JSONResponse) VisitSyncTasksResponse(w http.ResponseWriter) error

type SyncTasks422ApplicationProblemPlusJSONResponse added in v0.4.1

type SyncTasks422ApplicationProblemPlusJSONResponse Problem

func (SyncTasks422ApplicationProblemPlusJSONResponse) VisitSyncTasksResponse added in v0.4.1

func (response SyncTasks422ApplicationProblemPlusJSONResponse) VisitSyncTasksResponse(w http.ResponseWriter) error

type SyncTasksRequestObject added in v0.4.1

type SyncTasksRequestObject struct {
}

type SyncTasksResponseObject added in v0.4.1

type SyncTasksResponseObject interface {
	VisitSyncTasksResponse(w http.ResponseWriter) error
}

type SyncTasksdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type SyncTasksdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (SyncTasksdefaultApplicationProblemPlusJSONResponse) VisitSyncTasksResponse added in v0.4.1

type Task added in v0.4.1

type Task struct {
	// Annotations The notes on the task, oldest first.
	Annotations []TaskAnnotation `json:"annotations"`
	Description string           `json:"description"`
	Due         *time.Time       `json:"due,omitempty"`

	// End When the task was completed or deleted.
	End *time.Time `json:"end,omitempty"`

	// Entry When the task was created.
	Entry time.Time `json:"entry"`

	// Facets Every value the task holds, one or more in each kind the list is narrowed by: its state, priority, project and issue, then each of its tags, or no tag.
	Facets []TaskFacet `json:"facets"`

	// ID The working-set number; 0 for a task not in the working set.
	ID int `json:"id"`

	// IssueKey The issue the task is linked to, from its jiraid attribute; empty when it tracks none.
	//
	// Example: PROJ-412
	IssueKey string `json:"issue_key"`

	// IssueURL The issue's page: the tracker's, for a task naming an issue where the tracker builds issue pages (Jira); otherwise (the forge's issues as the tracker, or a task naming no issue) the task's jiraurl attribute when it is an http or https address; empty otherwise.
	IssueURL string `json:"issue_url"`

	// Modified When the task last changed.
	Modified time.Time `json:"modified"`

	// Priority H, M, L or empty.
	Priority string `json:"priority"`

	// Project Empty when the task has none.
	Project string `json:"project"`

	// Ranks A task's place in each order the Tasks list sorts by, 0 first, among the tasks of the list that carries it, every tie broken down to the uuid, so a narrowed list keeps the same order.
	Ranks     TaskRanks  `json:"ranks"`
	Scheduled *time.Time `json:"scheduled,omitempty"`

	// Searchable The fields text typed to narrow the list is matched against, each lower-cased: the description, the project, the issue key, each tag written +tag, and the id written #id when the task has one. Typed text matches a task when one field holds it, lower-cased letter by letter; a match never spans two fields.
	Searchable []string `json:"searchable"`

	// Start When the task was started; present only while it is.
	Start *time.Time `json:"start,omitempty"`

	// State Where the task stands as the list words it, when the server read it: started for a pending task begun, waiting for a pending one whose wait is still ahead, else its status. A wait passing changes it with no write, so a page holding the list reads it again once the earliest wait still ahead has passed.
	State  TaskState  `json:"state"`
	Status TaskStatus `json:"status"`
	Tags   []string   `json:"tags"`

	// Until When Taskwarrior deletes the task.
	Until *time.Time `json:"until,omitempty"`

	// Urgency Taskwarrior's own urgency; the list is ordered by it.
	Urgency float64 `json:"urgency"`

	// UUID Example: 5f3c9a1e-8b2d-4c6f-9e7a-1d2b3c4d5e6f
	UUID string `json:"uuid"`

	// Wait Until when the task is hidden from the list's usual reports.
	Wait *time.Time `json:"wait,omitempty"`
}

Task One task as Taskwarrior holds it. A date the task does not have is absent, never the zero time.

type TaskAnnotation added in v0.4.1

type TaskAnnotation struct {
	Description string    `json:"description"`
	Entry       time.Time `json:"entry"`
}

TaskAnnotation A note on a task, and when it was written.

type TaskBranch

type TaskBranch struct {
	// Current Whether this is the checked-out branch.
	Current bool `json:"current"`

	// IssueKey The issue the branch is named for — a Jira key or a forge issue number, per the branch-name convention.
	//
	// Example: PROJ-412
	IssueKey string `json:"issue_key"`

	// Name The local branch name.
	//
	// Example: fix/PROJ-412-redact-tokens
	Name string `json:"name"`

	// Remote Whether only the remote has the branch.
	Remote *bool `json:"remote,omitempty"`

	// Stages The loop's stages for the issue the branch is named for, named and ordered as the snapshot's stages are. The checked-out branch's are the snapshot's stages. Another branch's are what the server knows without checking it out: the issue picked up and the branch made, and nothing after them begun, since the working tree, the pull request and the announcement are read for the checked-out branch alone.
	Stages []Stage `json:"stages"`

	// Worktree The directory of another worktree of the repository that has the branch checked out, as an absolute path; empty when none does. git will not check such a branch out here, so it is switched to there instead.
	Worktree *string `json:"worktree,omitempty"`

	// WorktreeMissing Whether that worktree's directory is gone: git holds the branch for it until it is pruned, so it can be neither checked out nor switched to.
	WorktreeMissing *bool `json:"worktree_missing,omitempty"`

	// WorktreeShown That worktree's directory written from your home; empty when none.
	WorktreeShown *string `json:"worktree_shown,omitempty"`
}

TaskBranch A branch named for an issue, by the branch-name convention: a local one, or one only the remote has, which checking out creates here.

type TaskFacet added in v0.9.0

type TaskFacet struct {
	// Kind The kind: the task's state as the list words it, its priority, its project, a tag, or whether it is linked to an issue.
	Kind TaskFacetKind `json:"kind"`

	// Label The value as every surface names it, in the filter and where a row shows what the list is sorted by.
	//
	// Example: priority H
	Label string `json:"label"`

	// Value The value held: the state, the priority, the project or the tag, "" for none of each, or linked or unlinked.
	//
	// Example: H
	Value string `json:"value"`
}

TaskFacet One value a task holds in one of the five kinds the Tasks list is narrowed by. Values picked in one kind widen the list, and the kinds narrow it together.

type TaskFacetKind added in v0.9.0

type TaskFacetKind string

TaskFacetKind The kind: the task's state as the list words it, its priority, its project, a tag, or whether it is linked to an issue.

const (
	TaskFacetKindIssue    TaskFacetKind = "issue"
	TaskFacetKindPriority TaskFacetKind = "priority"
	TaskFacetKindProject  TaskFacetKind = "project"
	TaskFacetKindState    TaskFacetKind = "state"
	TaskFacetKindTag      TaskFacetKind = "tag"
)

Defines values for TaskFacetKind.

func (TaskFacetKind) Valid added in v0.9.0

func (e TaskFacetKind) Valid() bool

Valid indicates whether the value is a known member of the TaskFacetKind enum.

type TaskLine added in v0.4.1

type TaskLine struct {
	// Line The line, as it would follow `task add` or `task <id> modify`.
	//
	// Example: Write the release notes project:workflow due:friday
	Line string `json:"line"`
}

TaskLine A line in Taskwarrior's own grammar: words, with attributes such as project:web, due:friday or +tag among them.

type TaskList added in v0.4.1

type TaskList struct {
	// Added The uuid of the task the write this list answers added — an add or a track — so the page can name it even when the active context leaves it out of tasks. Absent after any other write, and on a read.
	Added *string `json:"added,omitempty"`

	// Available Whether there is a Taskwarrior to ask: false when it is turned off by taskwarrior.disabled, not installed, not Taskwarrior (go-task is also called task), too old, never run, or its taskrc has a malformed line. Also false in the answer to a write that was made when the list after it could not be read: reason says so, the write stands, and a read of the list asks again.
	Available bool `json:"available"`

	// Context The name of Taskwarrior's active context, whose filter the list applies; empty for none.
	Context string `json:"context"`

	// Done The task the done this list answers marked, as Taskwarrior holds it once the write has landed, described and ranked as the event stream's linked tasks will describe it: tasks no longer holds it, and the issue's Tasks card shows it done before the stream catches up. Absent for a task linked to no issue, when the linked tasks could not be read after the write, after any other write, and on a read.
	Done *Task `json:"done,omitempty"`

	// FacetOrder Every value the list's filter offers, in the order it lists them, as the terminal's filter lists them: the states as the state order ranks them; priorities H, M, L, any other the tasks hold by name, then none; the projects and the tags the tasks hold, by name, none last; with an issue, then without. A value only a waiting task holds is offered for its state alone. A value no task holds is offered only while it is picked. Empty when Taskwarrior is not available.
	FacetOrder []TaskFacet `json:"facet_order"`

	// Reason Why Taskwarrior is not available, safe to show; empty when it is.
	Reason string `json:"reason"`

	// ReasonCode Why Taskwarrior is not available, as a code the page can act on without reading reason: not installed, a task program that is not Taskwarrior (go-task, most likely), too old, never run, turned off by taskwarrior.disabled, a taskrc with a malformed line, or unavailable for a reason workflow doctor explains, or taskwarrior settings saved since workflow started in or switched to this directory, which apply once it restarts or switches directory, or the list after a write that was made could not be read. Absent when Taskwarrior is available.
	ReasonCode *TaskListReasonCode `json:"reason_code,omitempty"`

	// Said What the write this list answers has to add: how many operations an undo reverted, what a sync printed, or that a tracked issue's task was created but not annotated. Empty otherwise.
	Said string `json:"said"`

	// SyncAvailable Whether the taskrc names a sync backend, so a sync has somewhere to go.
	SyncAvailable bool `json:"sync_available"`

	// Tasks The pending tasks of the active context, most urgent first, waiting ones included. Empty when Taskwarrior is not available.
	Tasks []Task `json:"tasks"`
}

TaskList Your pending Taskwarrior tasks, and what the server knows of the Taskwarrior that answered.

type TaskListReasonCode added in v0.4.1

type TaskListReasonCode string

TaskListReasonCode Why Taskwarrior is not available, as a code the page can act on without reading reason: not installed, a task program that is not Taskwarrior (go-task, most likely), too old, never run, turned off by taskwarrior.disabled, a taskrc with a malformed line, or unavailable for a reason workflow doctor explains, or taskwarrior settings saved since workflow started in or switched to this directory, which apply once it restarts or switches directory, or the list after a write that was made could not be read. Absent when Taskwarrior is available.

const (
	TaskListReasonCodeMalformedTaskrc TaskListReasonCode = "malformed_taskrc"
	TaskListReasonCodeNeverRun        TaskListReasonCode = "never_run"
	TaskListReasonCodeNotInstalled    TaskListReasonCode = "not_installed"
	TaskListReasonCodeNotTaskwarrior  TaskListReasonCode = "not_taskwarrior"
	TaskListReasonCodeTooOld          TaskListReasonCode = "too_old"
	TaskListReasonCodeTurnedOff       TaskListReasonCode = "turned_off"
	TaskListReasonCodeUnavailable     TaskListReasonCode = "unavailable"
)

Defines values for TaskListReasonCode.

func (TaskListReasonCode) Valid added in v0.4.1

func (e TaskListReasonCode) Valid() bool

Valid indicates whether the value is a known member of the TaskListReasonCode enum.

type TaskRanks added in v0.9.0

type TaskRanks struct {
	// ID By working-set id, a task outside the working set last.
	ID int `json:"id"`

	// Issue Linked tasks by issue key in natural order, so PROJ-2 before PROJ-10, unlinked last.
	Issue int `json:"issue"`

	// Priority High, medium and low, then any other priority, then none.
	Priority int `json:"priority"`

	// State Started, then pending, waiting, recurring, completed and deleted.
	State int `json:"state"`

	// Tag By the tags taken in order, untagged last.
	Tag int `json:"tag"`

	// Urgency Most urgent first, by Taskwarrior's urgency.
	Urgency int `json:"urgency"`
}

TaskRanks A task's place in each order the Tasks list sorts by, 0 first, among the tasks of the list that carries it, every tie broken down to the uuid, so a narrowed list keeps the same order.

type TaskState added in v0.9.0

type TaskState string

TaskState Where the task stands as the list words it, when the server read it: started for a pending task begun, waiting for a pending one whose wait is still ahead, else its status. A wait passing changes it with no write, so a page holding the list reads it again once the earliest wait still ahead has passed.

const (
	TaskStateCompleted TaskState = "completed"
	TaskStateDeleted   TaskState = "deleted"
	TaskStatePending   TaskState = "pending"
	TaskStateRecurring TaskState = "recurring"
	TaskStateStarted   TaskState = "started"
	TaskStateUnknown   TaskState = "unknown"
	TaskStateWaiting   TaskState = "waiting"
)

Defines values for TaskState.

func (TaskState) Valid added in v0.9.0

func (e TaskState) Valid() bool

Valid indicates whether the value is a known member of the TaskState enum.

type TaskStatus added in v0.4.1

type TaskStatus string

TaskStatus defines model for Task.Status.

const (
	TaskStatusCompleted TaskStatus = "completed"
	TaskStatusDeleted   TaskStatus = "deleted"
	TaskStatusPending   TaskStatus = "pending"
	TaskStatusRecurring TaskStatus = "recurring"
	TaskStatusWaiting   TaskStatus = "waiting"
)

Defines values for TaskStatus.

func (TaskStatus) Valid added in v0.4.1

func (e TaskStatus) Valid() bool

Valid indicates whether the value is a known member of the TaskStatus enum.

type TaskText added in v0.4.1

type TaskText struct {
	// Text The note; every word stays a word, never an attribute.
	//
	// Example: Waiting on the forge's rate limit to reset
	Text string `json:"text"`
}

TaskText The text of a note on a task.

type TaskUUID added in v0.4.1

type TaskUUID = string

TaskUUID Example: 5f3c9a1e-8b2d-4c6f-9e7a-1d2b3c4d5e6f

type TasksSummary added in v0.4.1

type TasksSummary struct {
	// Active The started task: the first among your pending tasks, ranked among them as the Tasks list ranks it, else the first among the linked tasks, ranked among those, as when the active context hides it from the pending ones. Absent when none is started.
	Active *Task `json:"active,omitempty"`

	// Available Whether Taskwarrior answered: false when there is none to ask, as in TaskList, and when it was found but could not be read.
	Available bool `json:"available"`

	// Linked Every task linked to an issue, whatever its status but deleted, and whatever context hides it. Empty unless available.
	Linked []Task `json:"linked"`

	// Reason Why Taskwarrior is not available, safe to show; empty when it is.
	Reason string `json:"reason"`
}

TasksSummary What the event stream carries of your Taskwarrior tasks: the started one, as active — absent when none is started — and every task linked to an issue. Until Taskwarrior has answered both reads the summary makes, it is not available, with no active task and no linked one.

type TaskwarriorConfig added in v0.4.1

type TaskwarriorConfig struct {
	// Disabled Turn off the Taskwarrior integration even where Taskwarrior is installed.
	Disabled *bool `json:"disabled,omitempty"`

	// Program The task program to run: a name looked up on PATH, or a path. Empty tries every task in an absolute PATH directory and keeps the first that is Taskwarrior 3.5.0 or newer. workflow runs it as you, so a save keeps it as the file holds it, left out or not; one carrying another value is refused 422. It changes only in the file.
	Program *string `json:"program,omitempty"`
}

TaskwarriorConfig defines model for TaskwarriorConfig.

type TimingConfig

type TimingConfig struct {
	// CiInterval A Go duration; empty for the default.
	CiInterval *string `json:"ci_interval,omitempty"`

	// RequestTimeout A Go duration such as 20s; empty for the default.
	RequestTimeout *string `json:"request_timeout,omitempty"`
}

TimingConfig defines model for TimingConfig.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

type TrackIssue200JSONResponse added in v0.4.1

type TrackIssue200JSONResponse TaskList

func (TrackIssue200JSONResponse) VisitTrackIssueResponse added in v0.4.1

func (response TrackIssue200JSONResponse) VisitTrackIssueResponse(w http.ResponseWriter) error

type TrackIssue404ApplicationProblemPlusJSONResponse added in v0.4.1

type TrackIssue404ApplicationProblemPlusJSONResponse Problem

func (TrackIssue404ApplicationProblemPlusJSONResponse) VisitTrackIssueResponse added in v0.4.1

func (response TrackIssue404ApplicationProblemPlusJSONResponse) VisitTrackIssueResponse(w http.ResponseWriter) error

type TrackIssue422ApplicationProblemPlusJSONResponse added in v0.4.1

type TrackIssue422ApplicationProblemPlusJSONResponse Problem

func (TrackIssue422ApplicationProblemPlusJSONResponse) VisitTrackIssueResponse added in v0.4.1

func (response TrackIssue422ApplicationProblemPlusJSONResponse) VisitTrackIssueResponse(w http.ResponseWriter) error

type TrackIssueJSONRequestBody added in v0.4.1

type TrackIssueJSONRequestBody = TrackIssueRequest

TrackIssueJSONRequestBody defines body for TrackIssue for application/json ContentType.

type TrackIssueRequest added in v0.4.1

type TrackIssueRequest struct {
	// IssueKey The issue the task is for.
	//
	// Example: PROJ-412
	IssueKey string `json:"issue_key"`
}

TrackIssueRequest The issue to track in Taskwarrior.

type TrackIssueRequestObject added in v0.4.1

type TrackIssueRequestObject struct {
	Body *TrackIssueJSONRequestBody
}

type TrackIssueResponseObject added in v0.4.1

type TrackIssueResponseObject interface {
	VisitTrackIssueResponse(w http.ResponseWriter) error
}

type TrackIssuedefaultApplicationProblemPlusJSONResponse added in v0.4.1

type TrackIssuedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (TrackIssuedefaultApplicationProblemPlusJSONResponse) VisitTrackIssueResponse added in v0.4.1

type TransitionIssue200JSONResponse added in v0.3.0

type TransitionIssue200JSONResponse MovedIssue

func (TransitionIssue200JSONResponse) VisitTransitionIssueResponse added in v0.3.0

func (response TransitionIssue200JSONResponse) VisitTransitionIssueResponse(w http.ResponseWriter) error

type TransitionIssue409ApplicationProblemPlusJSONResponse added in v0.3.0

type TransitionIssue409ApplicationProblemPlusJSONResponse Problem

func (TransitionIssue409ApplicationProblemPlusJSONResponse) VisitTransitionIssueResponse added in v0.3.0

func (response TransitionIssue409ApplicationProblemPlusJSONResponse) VisitTransitionIssueResponse(w http.ResponseWriter) error

type TransitionIssue422ApplicationProblemPlusJSONResponse added in v0.3.0

type TransitionIssue422ApplicationProblemPlusJSONResponse Problem

func (TransitionIssue422ApplicationProblemPlusJSONResponse) VisitTransitionIssueResponse added in v0.3.0

func (response TransitionIssue422ApplicationProblemPlusJSONResponse) VisitTransitionIssueResponse(w http.ResponseWriter) error

type TransitionIssueRequestObject added in v0.3.0

type TransitionIssueRequestObject struct {
	Key string `json:"key"`
}

type TransitionIssueResponseObject added in v0.3.0

type TransitionIssueResponseObject interface {
	VisitTransitionIssueResponse(w http.ResponseWriter) error
}

type TransitionIssuedefaultApplicationProblemPlusJSONResponse added in v0.3.0

type TransitionIssuedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (TransitionIssuedefaultApplicationProblemPlusJSONResponse) VisitTransitionIssueResponse added in v0.3.0

func (response TransitionIssuedefaultApplicationProblemPlusJSONResponse) VisitTransitionIssueResponse(w http.ResponseWriter) error

type UIConfig

type UIConfig struct {
	// Accessible Whether the terminal's forms ask as plain prompts, one question at a time, rather than drawn over the screen.
	Accessible *bool `json:"accessible,omitempty"`

	// ASCII Draw borders and glyphs in plain ASCII, in the terminal interface and on the live line a command keeps while it waits.
	ASCII *bool `json:"ascii,omitempty"`

	// Color Empty for auto, or "never".
	Color *UIConfigColor `json:"color,omitempty"`

	// CommentsShown How many comments the detail shows; 0 means the built-in default.
	CommentsShown *int `json:"comments_shown,omitempty"`

	// Keys Map from a key action to the key that triggers it; see the configuration docs for the actions.
	Keys *map[string]string `json:"keys,omitempty"`

	// Motion Empty for motion (a turning in-flight mark, a stage's rule filling), or "reduce" to draw every state still, in the terminal interface and on the live line a command keeps while it waits.
	Motion *UIConfigMotion `json:"motion,omitempty"`
	Mouse  *bool           `json:"mouse,omitempty"`
	Notify *bool           `json:"notify,omitempty"`

	// WebShortcuts Whether the web page's single-key shortcuts are on. Off unless set; ? and the command palette work either way.
	WebShortcuts *bool `json:"web_shortcuts,omitempty"`
}

UIConfig defines model for UIConfig.

type UIConfigColor added in v0.4.0

type UIConfigColor string

UIConfigColor Empty for auto, or "never".

const (
	UIConfigColorEmpty UIConfigColor = ""
	UIConfigColorNever UIConfigColor = "never"
)

Defines values for UIConfigColor.

func (UIConfigColor) Valid added in v0.4.0

func (e UIConfigColor) Valid() bool

Valid indicates whether the value is a known member of the UIConfigColor enum.

type UIConfigMotion added in v0.11.0

type UIConfigMotion string

UIConfigMotion Empty for motion (a turning in-flight mark, a stage's rule filling), or "reduce" to draw every state still, in the terminal interface and on the live line a command keeps while it waits.

const (
	UIConfigMotionEmpty  UIConfigMotion = ""
	UIConfigMotionReduce UIConfigMotion = "reduce"
)

Defines values for UIConfigMotion.

func (UIConfigMotion) Valid added in v0.11.0

func (e UIConfigMotion) Valid() bool

Valid indicates whether the value is a known member of the UIConfigMotion enum.

type UndoTasks200JSONResponse added in v0.4.1

type UndoTasks200JSONResponse TaskList

func (UndoTasks200JSONResponse) VisitUndoTasksResponse added in v0.4.1

func (response UndoTasks200JSONResponse) VisitUndoTasksResponse(w http.ResponseWriter) error

type UndoTasks409ApplicationProblemPlusJSONResponse added in v0.4.1

type UndoTasks409ApplicationProblemPlusJSONResponse Problem

func (UndoTasks409ApplicationProblemPlusJSONResponse) VisitUndoTasksResponse added in v0.4.1

func (response UndoTasks409ApplicationProblemPlusJSONResponse) VisitUndoTasksResponse(w http.ResponseWriter) error

type UndoTasks422ApplicationProblemPlusJSONResponse added in v0.4.1

type UndoTasks422ApplicationProblemPlusJSONResponse Problem

func (UndoTasks422ApplicationProblemPlusJSONResponse) VisitUndoTasksResponse added in v0.4.1

func (response UndoTasks422ApplicationProblemPlusJSONResponse) VisitUndoTasksResponse(w http.ResponseWriter) error

type UndoTasksRequestObject added in v0.4.1

type UndoTasksRequestObject struct {
}

type UndoTasksResponseObject added in v0.4.1

type UndoTasksResponseObject interface {
	VisitUndoTasksResponse(w http.ResponseWriter) error
}

type UndoTasksdefaultApplicationProblemPlusJSONResponse added in v0.4.1

type UndoTasksdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (UndoTasksdefaultApplicationProblemPlusJSONResponse) VisitUndoTasksResponse added in v0.4.1

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type UnlinkBranchIssue200JSONResponse added in v0.5.0

type UnlinkBranchIssue200JSONResponse Branch

func (UnlinkBranchIssue200JSONResponse) VisitUnlinkBranchIssueResponse added in v0.5.0

func (response UnlinkBranchIssue200JSONResponse) VisitUnlinkBranchIssueResponse(w http.ResponseWriter) error

type UnlinkBranchIssue409ApplicationProblemPlusJSONResponse added in v0.5.0

type UnlinkBranchIssue409ApplicationProblemPlusJSONResponse Problem

func (UnlinkBranchIssue409ApplicationProblemPlusJSONResponse) VisitUnlinkBranchIssueResponse added in v0.5.0

func (response UnlinkBranchIssue409ApplicationProblemPlusJSONResponse) VisitUnlinkBranchIssueResponse(w http.ResponseWriter) error

type UnlinkBranchIssue422ApplicationProblemPlusJSONResponse added in v0.5.0

type UnlinkBranchIssue422ApplicationProblemPlusJSONResponse Problem

func (UnlinkBranchIssue422ApplicationProblemPlusJSONResponse) VisitUnlinkBranchIssueResponse added in v0.5.0

func (response UnlinkBranchIssue422ApplicationProblemPlusJSONResponse) VisitUnlinkBranchIssueResponse(w http.ResponseWriter) error

type UnlinkBranchIssueRequestObject added in v0.5.0

type UnlinkBranchIssueRequestObject struct {
}

type UnlinkBranchIssueResponseObject added in v0.5.0

type UnlinkBranchIssueResponseObject interface {
	VisitUnlinkBranchIssueResponse(w http.ResponseWriter) error
}

type UnlinkBranchIssuedefaultApplicationProblemPlusJSONResponse added in v0.5.0

type UnlinkBranchIssuedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (UnlinkBranchIssuedefaultApplicationProblemPlusJSONResponse) VisitUnlinkBranchIssueResponse added in v0.5.0

func (response UnlinkBranchIssuedefaultApplicationProblemPlusJSONResponse) VisitUnlinkBranchIssueResponse(w http.ResponseWriter) error

type UnmanagedHook added in v0.7.0

type UnmanagedHook struct {
	// Lines How many lines its script holds.
	Lines int `json:"lines"`

	// Name Example: pre-commit
	Name string `json:"name"`
}

UnmanagedHook defines model for UnmanagedHook.

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

type Unstage200JSONResponse added in v0.3.0

type Unstage200JSONResponse ChangeList

func (Unstage200JSONResponse) VisitUnstageResponse added in v0.3.0

func (response Unstage200JSONResponse) VisitUnstageResponse(w http.ResponseWriter) error

type Unstage404ApplicationProblemPlusJSONResponse added in v0.3.0

type Unstage404ApplicationProblemPlusJSONResponse Problem

func (Unstage404ApplicationProblemPlusJSONResponse) VisitUnstageResponse added in v0.3.0

func (response Unstage404ApplicationProblemPlusJSONResponse) VisitUnstageResponse(w http.ResponseWriter) error

type Unstage422ApplicationProblemPlusJSONResponse added in v0.3.0

type Unstage422ApplicationProblemPlusJSONResponse Problem

func (Unstage422ApplicationProblemPlusJSONResponse) VisitUnstageResponse added in v0.3.0

func (response Unstage422ApplicationProblemPlusJSONResponse) VisitUnstageResponse(w http.ResponseWriter) error

type UnstageJSONRequestBody added in v0.3.0

type UnstageJSONRequestBody = StagingRequest

UnstageJSONRequestBody defines body for Unstage for application/json ContentType.

type UnstageRequestObject added in v0.3.0

type UnstageRequestObject struct {
	Body *UnstageJSONRequestBody
}

type UnstageResponseObject added in v0.3.0

type UnstageResponseObject interface {
	VisitUnstageResponse(w http.ResponseWriter) error
}

type UnstagedefaultApplicationProblemPlusJSONResponse added in v0.3.0

type UnstagedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (UnstagedefaultApplicationProblemPlusJSONResponse) VisitUnstageResponse added in v0.3.0

type UpdateConfig200JSONResponse

type UpdateConfig200JSONResponse struct {
	Body    Config
	Headers UpdateConfig200ResponseHeaders
}

func (UpdateConfig200JSONResponse) VisitUpdateConfigResponse

func (response UpdateConfig200JSONResponse) VisitUpdateConfigResponse(w http.ResponseWriter) error

type UpdateConfig200ResponseHeaders added in v0.3.1

type UpdateConfig200ResponseHeaders struct {
	ETag string
}

type UpdateConfig404ApplicationProblemPlusJSONResponse added in v0.7.0

type UpdateConfig404ApplicationProblemPlusJSONResponse Problem

func (UpdateConfig404ApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse added in v0.7.0

func (response UpdateConfig404ApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse(w http.ResponseWriter) error

type UpdateConfig409ApplicationProblemPlusJSONResponse added in v0.3.1

type UpdateConfig409ApplicationProblemPlusJSONResponse Problem

func (UpdateConfig409ApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse added in v0.3.1

func (response UpdateConfig409ApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse(w http.ResponseWriter) error

type UpdateConfig422ApplicationProblemPlusJSONResponse added in v0.3.0

type UpdateConfig422ApplicationProblemPlusJSONResponse Problem

func (UpdateConfig422ApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse added in v0.3.0

func (response UpdateConfig422ApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse(w http.ResponseWriter) error

type UpdateConfig428ApplicationProblemPlusJSONResponse added in v0.3.1

type UpdateConfig428ApplicationProblemPlusJSONResponse Problem

func (UpdateConfig428ApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse added in v0.3.1

func (response UpdateConfig428ApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse(w http.ResponseWriter) error

type UpdateConfigJSONRequestBody

type UpdateConfigJSONRequestBody = Config

UpdateConfigJSONRequestBody defines body for UpdateConfig for application/json ContentType.

type UpdateConfigParams added in v0.3.1

type UpdateConfigParams struct {
	// IfMatch The ETag of the read the change was made over. A write without it is refused with 428, one whose value is not in the form of an ETag a read returns with 400, and one naming a revision the file is no longer at with 409.
	IfMatch *string `json:"If-Match,omitempty"`
}

UpdateConfigParams defines parameters for UpdateConfig.

type UpdateConfigRequestObject

type UpdateConfigRequestObject struct {
	Params UpdateConfigParams
	Body   *UpdateConfigJSONRequestBody
}

type UpdateConfigResponseObject

type UpdateConfigResponseObject interface {
	VisitUpdateConfigResponse(w http.ResponseWriter) error
}

type UpdateConfigdefaultApplicationProblemPlusJSONResponse added in v0.3.0

type UpdateConfigdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	Headers    ProblemResponseHeaders
	StatusCode int
}

func (UpdateConfigdefaultApplicationProblemPlusJSONResponse) VisitUpdateConfigResponse added in v0.3.0

type ViewList

type ViewList struct {
	Views []JiraView `json:"views"`
}

ViewList defines model for ViewList.

type WorklogRequest added in v0.7.0

type WorklogRequest struct {
	// Comment A note on the work; left out, the worklog carries none.
	Comment *string `json:"comment,omitempty"`

	// TimeSpent The duration in Jira's words, such as 2h, 30m or 1d 4h.
	TimeSpent string `json:"time_spent"`
}

WorklogRequest Time spent on a Jira issue, and an optional note.

type Worktree added in v0.6.0

type Worktree struct {
	// Branch The branch it has checked out, or empty when its HEAD is detached.
	Branch string `json:"branch"`

	// Dir The worktree's directory, as an absolute path.
	Dir string `json:"dir"`

	// Head The commit it has checked out, abbreviated.
	Head string `json:"head"`

	// Locked Whether git keeps it from being removed or pruned.
	Locked bool `json:"locked"`

	// Shown The directory written from your home.
	Shown string `json:"shown"`

	// State here is the worktree the server works in; worktree is another; missing is one git still lists whose directory is gone.
	State WorktreeState `json:"state"`
}

Worktree One working tree of the repository the server works in.

type WorktreeState added in v0.6.0

type WorktreeState string

WorktreeState here is the worktree the server works in; worktree is another; missing is one git still lists whose directory is gone.

const (
	WorktreeStateHere     WorktreeState = "here"
	WorktreeStateMissing  WorktreeState = "missing"
	WorktreeStateWorktree WorktreeState = "worktree"
)

Defines values for WorktreeState.

func (WorktreeState) Valid added in v0.6.0

func (e WorktreeState) Valid() bool

Valid indicates whether the value is a known member of the WorktreeState enum.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL