Documentation
¶
Overview ¶
Package github 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 github is CSF's GitHub protocol client: a library compiled into the binary that uses it, granted the http capability, which never dials on its own and starts no goroutine. client.gen.go is oapi-codegen's client for the operations operations.txt names, generated from GitHub's own OpenAPI description (api.github.com.json, filtered from the pinned upstream by generate.sh); csf/githubtools serves the same operations as MCP tools, generated from the same file.
This file is the handwritten rest: the client every request of which is authenticated with the token the binary read through the config capability, the rate limit a response reports, and marking a draft ready, which GitHub offers in GraphQL only.
Index ¶
- Constants
- Variables
- func NewCheckslistForRefRequest(server string, owner Owner, repo Repo, ref CommitRef, ...) (*http.Request, error)
- func NewGitgetRefRequest(server string, owner Owner, repo Repo, ref GitRefOnly) (*http.Request, error)
- func NewIssuesaddBlockedByDependencyRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Request, error)
- func NewIssuesaddBlockedByDependencyRequestWithBody(server string, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Request, error)
- func NewIssuescreateCommentRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Request, error)
- func NewIssuescreateCommentRequestWithBody(server string, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Request, error)
- func NewIssuescreateRequest(server string, owner Owner, repo Repo, body IssuescreateJSONRequestBody) (*http.Request, error)
- func NewIssuescreateRequestWithBody(server string, owner Owner, repo Repo, contentType string, body io.Reader) (*http.Request, error)
- func NewIssuesgetRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber) (*http.Request, error)
- func NewIssueslistCommentsRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Request, error)
- func NewIssueslistForRepoRequest(server string, owner Owner, repo Repo, params *IssueslistForRepoParams) (*http.Request, error)
- func NewIssuesupdateRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Request, error)
- func NewIssuesupdateRequestWithBody(server string, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Request, error)
- func NewPullscreateRequest(server string, owner Owner, repo Repo, body PullscreateJSONRequestBody) (*http.Request, error)
- func NewPullscreateRequestWithBody(server string, owner Owner, repo Repo, contentType string, body io.Reader) (*http.Request, error)
- func NewPullsgetRequest(server string, owner Owner, repo Repo, pullNumber PullNumber) (*http.Request, error)
- func NewPullslistRequest(server string, owner Owner, repo Repo, params *PullslistParams) (*http.Request, error)
- func NewPullsmergeRequest(server string, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Request, error)
- func NewPullsmergeRequestWithBody(server string, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Request, error)
- func NewPullsupdateRequest(server string, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Request, error)
- func NewPullsupdateRequestWithBody(server string, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Request, error)
- func NewReposgetCommitRequest(server string, owner Owner, repo Repo, ref CommitRef, ...) (*http.Request, error)
- func NewReposlistWebhookDeliveriesRequest(server string, owner Owner, repo Repo, hookId HookId, ...) (*http.Request, error)
- func NewReposlistWebhooksRequest(server string, owner Owner, repo Repo, params *ReposlistWebhooksParams) (*http.Request, error)
- func NextCursor(response *http.Response) string
- func TokenFromGhHosts(content []byte) (string, error)
- type AuthorAssociation
- type AutoMerge
- type AutoMergeMergeMethod
- type CheckName
- type CheckRun
- type CheckRunConclusion
- type CheckRunStatus
- type ChecksListForRefResult
- type CheckslistForRefParams
- type CheckslistForRefParamsFilter
- type CheckslistForRefParamsStatus
- type CheckslistForRefResponse
- type CheckslistForRefResponse200Headers
- type Client
- func (c *Client) CheckslistForRef(ctx context.Context, owner Owner, repo Repo, ref CommitRef, ...) (*http.Response, error)
- func (c *Client) GitgetRef(ctx context.Context, owner Owner, repo Repo, ref GitRefOnly, ...) (*http.Response, error)
- func (c *Client) IssuesaddBlockedByDependency(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Response, error)
- func (c *Client) IssuesaddBlockedByDependencyWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Response, error)
- func (c *Client) Issuescreate(ctx context.Context, owner Owner, repo Repo, body IssuescreateJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) IssuescreateComment(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Response, error)
- func (c *Client) IssuescreateCommentWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Response, error)
- func (c *Client) IssuescreateWithBody(ctx context.Context, owner Owner, repo Repo, contentType string, ...) (*http.Response, error)
- func (c *Client) Issuesget(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Response, error)
- func (c *Client) IssueslistComments(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Response, error)
- func (c *Client) IssueslistForRepo(ctx context.Context, owner Owner, repo Repo, params *IssueslistForRepoParams, ...) (*http.Response, error)
- func (c *Client) Issuesupdate(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Response, error)
- func (c *Client) IssuesupdateWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*http.Response, error)
- func (c *Client) Pullscreate(ctx context.Context, owner Owner, repo Repo, body PullscreateJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PullscreateWithBody(ctx context.Context, owner Owner, repo Repo, contentType string, ...) (*http.Response, error)
- func (c *Client) Pullsget(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Response, error)
- func (c *Client) Pullslist(ctx context.Context, owner Owner, repo Repo, params *PullslistParams, ...) (*http.Response, error)
- func (c *Client) Pullsmerge(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Response, error)
- func (c *Client) PullsmergeWithBody(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Response, error)
- func (c *Client) Pullsupdate(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Response, error)
- func (c *Client) PullsupdateWithBody(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*http.Response, error)
- func (c *Client) ReposgetCommit(ctx context.Context, owner Owner, repo Repo, ref CommitRef, ...) (*http.Response, error)
- func (c *Client) ReposlistWebhookDeliveries(ctx context.Context, owner Owner, repo Repo, hookId HookId, ...) (*http.Response, error)
- func (c *Client) ReposlistWebhooks(ctx context.Context, owner Owner, repo Repo, params *ReposlistWebhooksParams, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) CheckslistForRefWithResponse(ctx context.Context, owner Owner, repo Repo, ref CommitRef, ...) (*CheckslistForRefResponse, error)
- func (c *ClientWithResponses) GitgetRefWithResponse(ctx context.Context, owner Owner, repo Repo, ref GitRefOnly, ...) (*GitgetRefResponse, error)
- func (c *ClientWithResponses) IssuesaddBlockedByDependencyWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*IssuesaddBlockedByDependencyResponse, error)
- func (c *ClientWithResponses) IssuesaddBlockedByDependencyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*IssuesaddBlockedByDependencyResponse, error)
- func (c *ClientWithResponses) IssuescreateCommentWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*IssuescreateCommentResponse, error)
- func (c *ClientWithResponses) IssuescreateCommentWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*IssuescreateCommentResponse, error)
- func (c *ClientWithResponses) IssuescreateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, contentType string, ...) (*IssuescreateResponse, error)
- func (c *ClientWithResponses) IssuescreateWithResponse(ctx context.Context, owner Owner, repo Repo, body IssuescreateJSONRequestBody, ...) (*IssuescreateResponse, error)
- func (c *ClientWithResponses) IssuesgetWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*IssuesgetResponse, error)
- func (c *ClientWithResponses) IssueslistCommentsWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*IssueslistCommentsResponse, error)
- func (c *ClientWithResponses) IssueslistForRepoWithResponse(ctx context.Context, owner Owner, repo Repo, params *IssueslistForRepoParams, ...) (*IssueslistForRepoResponse, error)
- func (c *ClientWithResponses) IssuesupdateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*IssuesupdateResponse, error)
- func (c *ClientWithResponses) IssuesupdateWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, ...) (*IssuesupdateResponse, error)
- func (c *ClientWithResponses) PullscreateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, contentType string, ...) (*PullscreateResponse, error)
- func (c *ClientWithResponses) PullscreateWithResponse(ctx context.Context, owner Owner, repo Repo, body PullscreateJSONRequestBody, ...) (*PullscreateResponse, error)
- func (c *ClientWithResponses) PullsgetWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*PullsgetResponse, error)
- func (c *ClientWithResponses) PullslistWithResponse(ctx context.Context, owner Owner, repo Repo, params *PullslistParams, ...) (*PullslistResponse, error)
- func (c *ClientWithResponses) PullsmergeWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*PullsmergeResponse, error)
- func (c *ClientWithResponses) PullsmergeWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*PullsmergeResponse, error)
- func (c *ClientWithResponses) PullsupdateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*PullsupdateResponse, error)
- func (c *ClientWithResponses) PullsupdateWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, ...) (*PullsupdateResponse, error)
- func (c *ClientWithResponses) ReposgetCommitWithResponse(ctx context.Context, owner Owner, repo Repo, ref CommitRef, ...) (*ReposgetCommitResponse, error)
- func (c *ClientWithResponses) ReposlistWebhookDeliveriesWithResponse(ctx context.Context, owner Owner, repo Repo, hookId HookId, ...) (*ReposlistWebhookDeliveriesResponse, error)
- func (c *ClientWithResponses) ReposlistWebhooksWithResponse(ctx context.Context, owner Owner, repo Repo, params *ReposlistWebhooksParams, ...) (*ReposlistWebhooksResponse, error)
- type ClientWithResponsesInterface
- type Commit
- type CommitRef
- type Commit_Author
- func (t Commit_Author) AsEmptyObject() (EmptyObject, error)
- func (t Commit_Author) AsSimpleUser() (SimpleUser, error)
- func (t *Commit_Author) FromEmptyObject(v EmptyObject) error
- func (t *Commit_Author) FromSimpleUser(v SimpleUser) error
- func (t Commit_Author) MarshalJSON() ([]byte, error)
- func (t *Commit_Author) MergeEmptyObject(v EmptyObject) error
- func (t *Commit_Author) MergeSimpleUser(v SimpleUser) error
- func (t *Commit_Author) UnmarshalJSON(b []byte) error
- type Commit_Committer
- func (t Commit_Committer) AsEmptyObject() (EmptyObject, error)
- func (t Commit_Committer) AsSimpleUser() (SimpleUser, error)
- func (t *Commit_Committer) FromEmptyObject(v EmptyObject) error
- func (t *Commit_Committer) FromSimpleUser(v SimpleUser) error
- func (t Commit_Committer) MarshalJSON() ([]byte, error)
- func (t *Commit_Committer) MergeEmptyObject(v EmptyObject) error
- func (t *Commit_Committer) MergeSimpleUser(v SimpleUser) error
- func (t *Commit_Committer) UnmarshalJSON(b []byte) error
- type Cursor
- type DeploymentSimple
- type DiffEntry
- type DiffEntryStatus
- type Direction
- type EmptyObject
- type Enterprise
- type GitHubClient
- type GitRef
- type GitRefOnly
- type GitgetRefResponse
- type Hook
- type HookDeliveryItem
- type HookId
- type HookResponse
- type HttpRequestDoer
- type Issue
- type IssueComment
- type IssueDependenciesSummary
- type IssueFieldValue
- type IssueFieldValueDataType
- type IssueFieldValueValue0
- type IssueFieldValueValue1
- type IssueFieldValueValue2
- type IssueFieldValue_Value
- func (t IssueFieldValue_Value) AsIssueFieldValueValue0() (IssueFieldValueValue0, error)
- func (t IssueFieldValue_Value) AsIssueFieldValueValue1() (IssueFieldValueValue1, error)
- func (t IssueFieldValue_Value) AsIssueFieldValueValue2() (IssueFieldValueValue2, error)
- func (t *IssueFieldValue_Value) FromIssueFieldValueValue0(v IssueFieldValueValue0) error
- func (t *IssueFieldValue_Value) FromIssueFieldValueValue1(v IssueFieldValueValue1) error
- func (t *IssueFieldValue_Value) FromIssueFieldValueValue2(v IssueFieldValueValue2) error
- func (t IssueFieldValue_Value) MarshalJSON() ([]byte, error)
- func (t *IssueFieldValue_Value) MergeIssueFieldValueValue0(v IssueFieldValueValue0) error
- func (t *IssueFieldValue_Value) MergeIssueFieldValueValue1(v IssueFieldValueValue1) error
- func (t *IssueFieldValue_Value) MergeIssueFieldValueValue2(v IssueFieldValueValue2) error
- func (t *IssueFieldValue_Value) UnmarshalJSON(b []byte) error
- type IssueLabels0
- type IssueLabels1
- type IssueNumber
- type IssueStateReason
- type IssueType
- type IssueTypeColor
- type Issue_Labels_Item
- func (t Issue_Labels_Item) AsIssueLabels0() (IssueLabels0, error)
- func (t Issue_Labels_Item) AsIssueLabels1() (IssueLabels1, error)
- func (t *Issue_Labels_Item) FromIssueLabels0(v IssueLabels0) error
- func (t *Issue_Labels_Item) FromIssueLabels1(v IssueLabels1) error
- func (t Issue_Labels_Item) MarshalJSON() ([]byte, error)
- func (t *Issue_Labels_Item) MergeIssueLabels0(v IssueLabels0) error
- func (t *Issue_Labels_Item) MergeIssueLabels1(v IssueLabels1) error
- func (t *Issue_Labels_Item) UnmarshalJSON(b []byte) error
- type IssuesListCommentsResult
- type IssuesListForRepoResult
- type IssuesUpdateResult
- type IssuesUpdateResultLabels0
- type IssuesUpdateResultLabels1
- type IssuesUpdateResultStateReason
- type IssuesUpdateResultSuggestionsAssigneesConfidence
- type IssuesUpdateResultSuggestionsAssigneesIgnoredReason
- type IssuesUpdateResultSuggestionsIssueFieldValuesConfidence
- type IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason
- type IssuesUpdateResultSuggestionsIssueFieldValuesValue0
- type IssuesUpdateResultSuggestionsIssueFieldValuesValue1
- type IssuesUpdateResultSuggestionsIssueFieldValuesValue2
- type IssuesUpdateResultSuggestionsLabelsConfidence
- type IssuesUpdateResultSuggestionsLabelsIgnoredReason
- type IssuesUpdateResultSuggestionsStateConfidence
- type IssuesUpdateResultSuggestionsStateIgnoredReason
- type IssuesUpdateResultSuggestionsTypeConfidence
- type IssuesUpdateResultSuggestionsTypeIgnoredReason
- type IssuesUpdateResult_Labels_Item
- func (t IssuesUpdateResult_Labels_Item) AsIssuesUpdateResultLabels0() (IssuesUpdateResultLabels0, error)
- func (t IssuesUpdateResult_Labels_Item) AsIssuesUpdateResultLabels1() (IssuesUpdateResultLabels1, error)
- func (t *IssuesUpdateResult_Labels_Item) FromIssuesUpdateResultLabels0(v IssuesUpdateResultLabels0) error
- func (t *IssuesUpdateResult_Labels_Item) FromIssuesUpdateResultLabels1(v IssuesUpdateResultLabels1) error
- func (t IssuesUpdateResult_Labels_Item) MarshalJSON() ([]byte, error)
- func (t *IssuesUpdateResult_Labels_Item) MergeIssuesUpdateResultLabels0(v IssuesUpdateResultLabels0) error
- func (t *IssuesUpdateResult_Labels_Item) MergeIssuesUpdateResultLabels1(v IssuesUpdateResultLabels1) error
- func (t *IssuesUpdateResult_Labels_Item) UnmarshalJSON(b []byte) error
- type IssuesUpdateResult_Suggestions_IssueFieldValues_Value
- func (t IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue0() (IssuesUpdateResultSuggestionsIssueFieldValuesValue0, error)
- func (t IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue1() (IssuesUpdateResultSuggestionsIssueFieldValuesValue1, error)
- func (t IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue2() (IssuesUpdateResultSuggestionsIssueFieldValuesValue2, error)
- func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue0(v IssuesUpdateResultSuggestionsIssueFieldValuesValue0) error
- func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue1(v IssuesUpdateResultSuggestionsIssueFieldValuesValue1) error
- func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue2(v IssuesUpdateResultSuggestionsIssueFieldValuesValue2) error
- func (t IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MarshalJSON() ([]byte, error)
- func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue0(v IssuesUpdateResultSuggestionsIssueFieldValuesValue0) error
- func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue1(v IssuesUpdateResultSuggestionsIssueFieldValuesValue1) error
- func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue2(v IssuesUpdateResultSuggestionsIssueFieldValuesValue2) error
- func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) UnmarshalJSON(b []byte) error
- type IssuesaddBlockedByDependencyJSONBody
- type IssuesaddBlockedByDependencyJSONRequestBody
- type IssuesaddBlockedByDependencyResponse
- func (r IssuesaddBlockedByDependencyResponse) ContentType() string
- func (r IssuesaddBlockedByDependencyResponse) GetBody() []byte
- func (r IssuesaddBlockedByDependencyResponse) GetJSON201() *Issue
- func (r IssuesaddBlockedByDependencyResponse) Status() string
- func (r IssuesaddBlockedByDependencyResponse) StatusCode() int
- type IssuesaddBlockedByDependencyResponse201Headers
- type IssuescreateCommentJSONBody
- type IssuescreateCommentJSONRequestBody
- type IssuescreateCommentResponse
- type IssuescreateCommentResponse201Headers
- type IssuescreateJSONBody
- type IssuescreateJSONBodyIssueFieldValuesValue0
- type IssuescreateJSONBodyIssueFieldValuesValue1
- type IssuescreateJSONBodyIssueFieldValuesValue2
- type IssuescreateJSONBodyLabels0
- type IssuescreateJSONBodyLabels1
- type IssuescreateJSONBodyMilestone0
- type IssuescreateJSONBodyMilestone1
- type IssuescreateJSONBodyTitle0
- type IssuescreateJSONBodyTitle1
- type IssuescreateJSONBody_IssueFieldValues_Value
- func (t IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue0() (IssuescreateJSONBodyIssueFieldValuesValue0, error)
- func (t IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue1() (IssuescreateJSONBodyIssueFieldValuesValue1, error)
- func (t IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue2() (IssuescreateJSONBodyIssueFieldValuesValue2, error)
- func (t *IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue0(v IssuescreateJSONBodyIssueFieldValuesValue0) error
- func (t *IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue1(v IssuescreateJSONBodyIssueFieldValuesValue1) error
- func (t *IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue2(v IssuescreateJSONBodyIssueFieldValuesValue2) error
- func (t IssuescreateJSONBody_IssueFieldValues_Value) MarshalJSON() ([]byte, error)
- func (t *IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue0(v IssuescreateJSONBodyIssueFieldValuesValue0) error
- func (t *IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue1(v IssuescreateJSONBodyIssueFieldValuesValue1) error
- func (t *IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue2(v IssuescreateJSONBodyIssueFieldValuesValue2) error
- func (t *IssuescreateJSONBody_IssueFieldValues_Value) UnmarshalJSON(b []byte) error
- type IssuescreateJSONBody_Labels_Item
- func (t IssuescreateJSONBody_Labels_Item) AsIssuescreateJSONBodyLabels0() (IssuescreateJSONBodyLabels0, error)
- func (t IssuescreateJSONBody_Labels_Item) AsIssuescreateJSONBodyLabels1() (IssuescreateJSONBodyLabels1, error)
- func (t *IssuescreateJSONBody_Labels_Item) FromIssuescreateJSONBodyLabels0(v IssuescreateJSONBodyLabels0) error
- func (t *IssuescreateJSONBody_Labels_Item) FromIssuescreateJSONBodyLabels1(v IssuescreateJSONBodyLabels1) error
- func (t IssuescreateJSONBody_Labels_Item) MarshalJSON() ([]byte, error)
- func (t *IssuescreateJSONBody_Labels_Item) MergeIssuescreateJSONBodyLabels0(v IssuescreateJSONBodyLabels0) error
- func (t *IssuescreateJSONBody_Labels_Item) MergeIssuescreateJSONBodyLabels1(v IssuescreateJSONBodyLabels1) error
- func (t *IssuescreateJSONBody_Labels_Item) UnmarshalJSON(b []byte) error
- type IssuescreateJSONBody_Milestone
- func (t IssuescreateJSONBody_Milestone) AsIssuescreateJSONBodyMilestone0() (IssuescreateJSONBodyMilestone0, error)
- func (t IssuescreateJSONBody_Milestone) AsIssuescreateJSONBodyMilestone1() (IssuescreateJSONBodyMilestone1, error)
- func (t *IssuescreateJSONBody_Milestone) FromIssuescreateJSONBodyMilestone0(v IssuescreateJSONBodyMilestone0) error
- func (t *IssuescreateJSONBody_Milestone) FromIssuescreateJSONBodyMilestone1(v IssuescreateJSONBodyMilestone1) error
- func (t IssuescreateJSONBody_Milestone) MarshalJSON() ([]byte, error)
- func (t *IssuescreateJSONBody_Milestone) MergeIssuescreateJSONBodyMilestone0(v IssuescreateJSONBodyMilestone0) error
- func (t *IssuescreateJSONBody_Milestone) MergeIssuescreateJSONBodyMilestone1(v IssuescreateJSONBodyMilestone1) error
- func (t *IssuescreateJSONBody_Milestone) UnmarshalJSON(b []byte) error
- type IssuescreateJSONBody_Title
- func (t IssuescreateJSONBody_Title) AsIssuescreateJSONBodyTitle0() (IssuescreateJSONBodyTitle0, error)
- func (t IssuescreateJSONBody_Title) AsIssuescreateJSONBodyTitle1() (IssuescreateJSONBodyTitle1, error)
- func (t *IssuescreateJSONBody_Title) FromIssuescreateJSONBodyTitle0(v IssuescreateJSONBodyTitle0) error
- func (t *IssuescreateJSONBody_Title) FromIssuescreateJSONBodyTitle1(v IssuescreateJSONBodyTitle1) error
- func (t IssuescreateJSONBody_Title) MarshalJSON() ([]byte, error)
- func (t *IssuescreateJSONBody_Title) MergeIssuescreateJSONBodyTitle0(v IssuescreateJSONBodyTitle0) error
- func (t *IssuescreateJSONBody_Title) MergeIssuescreateJSONBodyTitle1(v IssuescreateJSONBodyTitle1) error
- func (t *IssuescreateJSONBody_Title) UnmarshalJSON(b []byte) error
- type IssuescreateJSONRequestBody
- type IssuescreateResponse
- type IssuescreateResponse201Headers
- type IssuesgetResponse
- type IssueslistCommentsParams
- type IssueslistCommentsResponse
- type IssueslistCommentsResponse200Headers
- type IssueslistForRepoParams
- type IssueslistForRepoParamsDirection
- type IssueslistForRepoParamsSort
- type IssueslistForRepoParamsState
- type IssueslistForRepoResponse
- type IssueslistForRepoResponse200Headers
- type IssuesupdateJSONBody
- type IssuesupdateJSONBodyAssignees0
- type IssuesupdateJSONBodyAssignees1
- type IssuesupdateJSONBodyAssignees1Confidence
- type IssuesupdateJSONBodyIssueFieldValuesConfidence
- type IssuesupdateJSONBodyIssueFieldValuesValue0
- type IssuesupdateJSONBodyIssueFieldValuesValue1
- type IssuesupdateJSONBodyIssueFieldValuesValue2
- type IssuesupdateJSONBodyLabels0
- type IssuesupdateJSONBodyLabels1
- type IssuesupdateJSONBodyLabels1Confidence
- type IssuesupdateJSONBodyMilestone0
- type IssuesupdateJSONBodyMilestone1
- type IssuesupdateJSONBodyState
- type IssuesupdateJSONBodyStateReason
- type IssuesupdateJSONBodyTitle0
- type IssuesupdateJSONBodyTitle1
- type IssuesupdateJSONBodyType0
- type IssuesupdateJSONBodyType1
- type IssuesupdateJSONBodyType1Confidence
- type IssuesupdateJSONBody_Assignees_Item
- func (t IssuesupdateJSONBody_Assignees_Item) AsIssuesupdateJSONBodyAssignees0() (IssuesupdateJSONBodyAssignees0, error)
- func (t IssuesupdateJSONBody_Assignees_Item) AsIssuesupdateJSONBodyAssignees1() (IssuesupdateJSONBodyAssignees1, error)
- func (t *IssuesupdateJSONBody_Assignees_Item) FromIssuesupdateJSONBodyAssignees0(v IssuesupdateJSONBodyAssignees0) error
- func (t *IssuesupdateJSONBody_Assignees_Item) FromIssuesupdateJSONBodyAssignees1(v IssuesupdateJSONBodyAssignees1) error
- func (t IssuesupdateJSONBody_Assignees_Item) MarshalJSON() ([]byte, error)
- func (t *IssuesupdateJSONBody_Assignees_Item) MergeIssuesupdateJSONBodyAssignees0(v IssuesupdateJSONBodyAssignees0) error
- func (t *IssuesupdateJSONBody_Assignees_Item) MergeIssuesupdateJSONBodyAssignees1(v IssuesupdateJSONBodyAssignees1) error
- func (t *IssuesupdateJSONBody_Assignees_Item) UnmarshalJSON(b []byte) error
- type IssuesupdateJSONBody_IssueFieldValues_Value
- func (t IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue0() (IssuesupdateJSONBodyIssueFieldValuesValue0, error)
- func (t IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue1() (IssuesupdateJSONBodyIssueFieldValuesValue1, error)
- func (t IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue2() (IssuesupdateJSONBodyIssueFieldValuesValue2, error)
- func (t *IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue0(v IssuesupdateJSONBodyIssueFieldValuesValue0) error
- func (t *IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue1(v IssuesupdateJSONBodyIssueFieldValuesValue1) error
- func (t *IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue2(v IssuesupdateJSONBodyIssueFieldValuesValue2) error
- func (t IssuesupdateJSONBody_IssueFieldValues_Value) MarshalJSON() ([]byte, error)
- func (t *IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue0(v IssuesupdateJSONBodyIssueFieldValuesValue0) error
- func (t *IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue1(v IssuesupdateJSONBodyIssueFieldValuesValue1) error
- func (t *IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue2(v IssuesupdateJSONBodyIssueFieldValuesValue2) error
- func (t *IssuesupdateJSONBody_IssueFieldValues_Value) UnmarshalJSON(b []byte) error
- type IssuesupdateJSONBody_Labels_Item
- func (t IssuesupdateJSONBody_Labels_Item) AsIssuesupdateJSONBodyLabels0() (IssuesupdateJSONBodyLabels0, error)
- func (t IssuesupdateJSONBody_Labels_Item) AsIssuesupdateJSONBodyLabels1() (IssuesupdateJSONBodyLabels1, error)
- func (t *IssuesupdateJSONBody_Labels_Item) FromIssuesupdateJSONBodyLabels0(v IssuesupdateJSONBodyLabels0) error
- func (t *IssuesupdateJSONBody_Labels_Item) FromIssuesupdateJSONBodyLabels1(v IssuesupdateJSONBodyLabels1) error
- func (t IssuesupdateJSONBody_Labels_Item) MarshalJSON() ([]byte, error)
- func (t *IssuesupdateJSONBody_Labels_Item) MergeIssuesupdateJSONBodyLabels0(v IssuesupdateJSONBodyLabels0) error
- func (t *IssuesupdateJSONBody_Labels_Item) MergeIssuesupdateJSONBodyLabels1(v IssuesupdateJSONBodyLabels1) error
- func (t *IssuesupdateJSONBody_Labels_Item) UnmarshalJSON(b []byte) error
- type IssuesupdateJSONBody_Milestone
- func (t IssuesupdateJSONBody_Milestone) AsIssuesupdateJSONBodyMilestone0() (IssuesupdateJSONBodyMilestone0, error)
- func (t IssuesupdateJSONBody_Milestone) AsIssuesupdateJSONBodyMilestone1() (IssuesupdateJSONBodyMilestone1, error)
- func (t *IssuesupdateJSONBody_Milestone) FromIssuesupdateJSONBodyMilestone0(v IssuesupdateJSONBodyMilestone0) error
- func (t *IssuesupdateJSONBody_Milestone) FromIssuesupdateJSONBodyMilestone1(v IssuesupdateJSONBodyMilestone1) error
- func (t IssuesupdateJSONBody_Milestone) MarshalJSON() ([]byte, error)
- func (t *IssuesupdateJSONBody_Milestone) MergeIssuesupdateJSONBodyMilestone0(v IssuesupdateJSONBodyMilestone0) error
- func (t *IssuesupdateJSONBody_Milestone) MergeIssuesupdateJSONBodyMilestone1(v IssuesupdateJSONBodyMilestone1) error
- func (t *IssuesupdateJSONBody_Milestone) UnmarshalJSON(b []byte) error
- type IssuesupdateJSONBody_Title
- func (t IssuesupdateJSONBody_Title) AsIssuesupdateJSONBodyTitle0() (IssuesupdateJSONBodyTitle0, error)
- func (t IssuesupdateJSONBody_Title) AsIssuesupdateJSONBodyTitle1() (IssuesupdateJSONBodyTitle1, error)
- func (t *IssuesupdateJSONBody_Title) FromIssuesupdateJSONBodyTitle0(v IssuesupdateJSONBodyTitle0) error
- func (t *IssuesupdateJSONBody_Title) FromIssuesupdateJSONBodyTitle1(v IssuesupdateJSONBodyTitle1) error
- func (t IssuesupdateJSONBody_Title) MarshalJSON() ([]byte, error)
- func (t *IssuesupdateJSONBody_Title) MergeIssuesupdateJSONBodyTitle0(v IssuesupdateJSONBodyTitle0) error
- func (t *IssuesupdateJSONBody_Title) MergeIssuesupdateJSONBodyTitle1(v IssuesupdateJSONBodyTitle1) error
- func (t *IssuesupdateJSONBody_Title) UnmarshalJSON(b []byte) error
- type IssuesupdateJSONBody_Type
- func (t IssuesupdateJSONBody_Type) AsIssuesupdateJSONBodyType0() (IssuesupdateJSONBodyType0, error)
- func (t IssuesupdateJSONBody_Type) AsIssuesupdateJSONBodyType1() (IssuesupdateJSONBodyType1, error)
- func (t *IssuesupdateJSONBody_Type) FromIssuesupdateJSONBodyType0(v IssuesupdateJSONBodyType0) error
- func (t *IssuesupdateJSONBody_Type) FromIssuesupdateJSONBodyType1(v IssuesupdateJSONBodyType1) error
- func (t IssuesupdateJSONBody_Type) MarshalJSON() ([]byte, error)
- func (t *IssuesupdateJSONBody_Type) MergeIssuesupdateJSONBodyType0(v IssuesupdateJSONBodyType0) error
- func (t *IssuesupdateJSONBody_Type) MergeIssuesupdateJSONBodyType1(v IssuesupdateJSONBodyType1) error
- func (t *IssuesupdateJSONBody_Type) UnmarshalJSON(b []byte) error
- type IssuesupdateJSONRequestBody
- type IssuesupdateResponse
- type Labels
- type Link
- type NullableGitUser
- type NullableIntegration
- type NullableIntegration_Owner
- func (t NullableIntegration_Owner) AsEnterprise() (Enterprise, error)
- func (t NullableIntegration_Owner) AsSimpleUser() (SimpleUser, error)
- func (t *NullableIntegration_Owner) FromEnterprise(v Enterprise) error
- func (t *NullableIntegration_Owner) FromSimpleUser(v SimpleUser) error
- func (t NullableIntegration_Owner) MarshalJSON() ([]byte, error)
- func (t *NullableIntegration_Owner) MergeEnterprise(v Enterprise) error
- func (t *NullableIntegration_Owner) MergeSimpleUser(v SimpleUser) error
- func (t *NullableIntegration_Owner) UnmarshalJSON(b []byte) error
- type NullableIntegration_Permissions
- func (a NullableIntegration_Permissions) Get(fieldName string) (value string, found bool)
- func (a NullableIntegration_Permissions) MarshalJSON() ([]byte, error)
- func (a *NullableIntegration_Permissions) Set(fieldName string, value string)
- func (a *NullableIntegration_Permissions) UnmarshalJSON(b []byte) error
- type NullableIssueComment
- type NullableIssueCommentMinimized
- type NullableLicenseSimple
- type NullableMilestone
- type NullableMilestoneState
- type NullablePinnedIssueComment
- type NullableSimpleUser
- type NullableTeamSimple
- type NullableTeamSimpleType
- type Owner
- type Page
- type PerPage
- type PullNumber
- type PullRequest
- type PullRequestMergeResult
- type PullRequestMinimal
- type PullRequestSimple
- type PullRequestStack
- type PullRequestState
- type PullsListResult
- type PullscreateJSONBody
- type PullscreateJSONRequestBody
- type PullscreateResponse
- type PullscreateResponse201Headers
- type PullsgetResponse
- type PullslistParams
- type PullslistParamsDirection
- type PullslistParamsSort
- type PullslistParamsState
- type PullslistResponse
- type PullslistResponse200Headers
- type PullsmergeJSONBody
- type PullsmergeJSONBodyMergeMethod
- type PullsmergeJSONRequestBody
- type PullsmergeResponse
- type PullsupdateJSONBody
- type PullsupdateJSONBodyState
- type PullsupdateJSONRequestBody
- type PullsupdateResponse
- type RateLimit
- type ReactionRollup
- type ReadyPullRequest
- type Remote
- type Repo
- type ReposListWebhookDeliveriesResult
- type ReposListWebhooksResult
- type ReposgetCommitParams
- type ReposgetCommitResponse
- type Repository
- type RepositoryMergeCommitMessage
- type RepositoryMergeCommitTitle
- type RepositoryPullRequestCreationPolicy
- type RepositorySquashMergeCommitMessage
- type RepositorySquashMergeCommitTitle
- type ReposlistWebhookDeliveriesParams
- type ReposlistWebhookDeliveriesParamsStatus
- type ReposlistWebhookDeliveriesResponse
- func (r ReposlistWebhookDeliveriesResponse) ContentType() string
- func (r ReposlistWebhookDeliveriesResponse) GetBody() []byte
- func (r ReposlistWebhookDeliveriesResponse) GetJSON200() *ReposListWebhookDeliveriesResult
- func (r ReposlistWebhookDeliveriesResponse) Status() string
- func (r ReposlistWebhookDeliveriesResponse) StatusCode() int
- type ReposlistWebhooksParams
- type ReposlistWebhooksResponse
- type ReposlistWebhooksResponse200Headers
- type RequestEditorFn
- type SimpleUser
- type Since
- type Status
- type StatusError
- type SubIssuesSummary
- type Team
- type TeamAccessSource
- type TeamSimple
- type TeamSimpleType
- type TeamType
- type Verification
- type WebhookConfig
- type WebhookConfigContentType
- type WebhookConfigInsecureSsl
- func (t WebhookConfigInsecureSsl) AsWebhookConfigInsecureSsl0() (WebhookConfigInsecureSsl0, error)
- func (t WebhookConfigInsecureSsl) AsWebhookConfigInsecureSsl1() (WebhookConfigInsecureSsl1, error)
- func (t *WebhookConfigInsecureSsl) FromWebhookConfigInsecureSsl0(v WebhookConfigInsecureSsl0) error
- func (t *WebhookConfigInsecureSsl) FromWebhookConfigInsecureSsl1(v WebhookConfigInsecureSsl1) error
- func (t WebhookConfigInsecureSsl) MarshalJSON() ([]byte, error)
- func (t *WebhookConfigInsecureSsl) MergeWebhookConfigInsecureSsl0(v WebhookConfigInsecureSsl0) error
- func (t *WebhookConfigInsecureSsl) MergeWebhookConfigInsecureSsl1(v WebhookConfigInsecureSsl1) error
- func (t *WebhookConfigInsecureSsl) UnmarshalJSON(b []byte) error
- type WebhookConfigInsecureSsl0
- type WebhookConfigInsecureSsl1
- type WebhookConfigSecret
- type WebhookConfigUrl
- type WebhookDeliveryStatus
Constants ¶
const ( // Server is GitHub's REST endpoint. Server = "https://api.github.com" // APIVersion is the REST API version api.github.com.json describes. APIVersion = "2026-03-10" )
const GhHostsFile = "hosts.yml"
GhHostsFile is the gh CLI's account file, under its config directory.
Variables ¶
var ( // ErrNoHTTPClient reports a client built without the http capability. ErrNoHTTPClient = errors.New("github: an HTTP client capability is required") // ErrNoToken reports a client built without a token. ErrNoToken = errors.New("github: a token is required") )
var Description []byte
Description is the filtered OpenAPI description the client was generated from: the source of each GitHub tool's input and output schema.
var ErrInvalidRepository = errors.New("github: not a github.com repository")
ErrInvalidRepository reports a remote that is not a repository on github.com.
Functions ¶
func NewCheckslistForRefRequest ¶
func NewCheckslistForRefRequest(server string, owner Owner, repo Repo, ref CommitRef, params *CheckslistForRefParams) (*http.Request, error)
NewCheckslistForRefRequest constructs an http.Request for the CheckslistForRef method
func NewGitgetRefRequest ¶
func NewGitgetRefRequest(server string, owner Owner, repo Repo, ref GitRefOnly) (*http.Request, error)
NewGitgetRefRequest constructs an http.Request for the GitgetRef method
func NewIssuesaddBlockedByDependencyRequest ¶
func NewIssuesaddBlockedByDependencyRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesaddBlockedByDependencyJSONRequestBody) (*http.Request, error)
NewIssuesaddBlockedByDependencyRequest calls the generic IssuesaddBlockedByDependency builder with application/json body
func NewIssuesaddBlockedByDependencyRequestWithBody ¶
func NewIssuesaddBlockedByDependencyRequestWithBody(server string, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader) (*http.Request, error)
NewIssuesaddBlockedByDependencyRequestWithBody constructs an http.Request for the IssuesaddBlockedByDependency method, with any body, and a specified content type
func NewIssuescreateCommentRequest ¶
func NewIssuescreateCommentRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber, body IssuescreateCommentJSONRequestBody) (*http.Request, error)
NewIssuescreateCommentRequest calls the generic IssuescreateComment builder with application/json body
func NewIssuescreateCommentRequestWithBody ¶
func NewIssuescreateCommentRequestWithBody(server string, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader) (*http.Request, error)
NewIssuescreateCommentRequestWithBody constructs an http.Request for the IssuescreateComment method, with any body, and a specified content type
func NewIssuescreateRequest ¶
func NewIssuescreateRequest(server string, owner Owner, repo Repo, body IssuescreateJSONRequestBody) (*http.Request, error)
NewIssuescreateRequest calls the generic Issuescreate builder with application/json body
func NewIssuescreateRequestWithBody ¶
func NewIssuescreateRequestWithBody(server string, owner Owner, repo Repo, contentType string, body io.Reader) (*http.Request, error)
NewIssuescreateRequestWithBody constructs an http.Request for the Issuescreate method, with any body, and a specified content type
func NewIssuesgetRequest ¶
func NewIssuesgetRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber) (*http.Request, error)
NewIssuesgetRequest constructs an http.Request for the Issuesget method
func NewIssueslistCommentsRequest ¶
func NewIssueslistCommentsRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber, params *IssueslistCommentsParams) (*http.Request, error)
NewIssueslistCommentsRequest constructs an http.Request for the IssueslistComments method
func NewIssueslistForRepoRequest ¶
func NewIssueslistForRepoRequest(server string, owner Owner, repo Repo, params *IssueslistForRepoParams) (*http.Request, error)
NewIssueslistForRepoRequest constructs an http.Request for the IssueslistForRepo method
func NewIssuesupdateRequest ¶
func NewIssuesupdateRequest(server string, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesupdateJSONRequestBody) (*http.Request, error)
NewIssuesupdateRequest calls the generic Issuesupdate builder with application/json body
func NewIssuesupdateRequestWithBody ¶
func NewIssuesupdateRequestWithBody(server string, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader) (*http.Request, error)
NewIssuesupdateRequestWithBody constructs an http.Request for the Issuesupdate method, with any body, and a specified content type
func NewPullscreateRequest ¶
func NewPullscreateRequest(server string, owner Owner, repo Repo, body PullscreateJSONRequestBody) (*http.Request, error)
NewPullscreateRequest calls the generic Pullscreate builder with application/json body
func NewPullscreateRequestWithBody ¶
func NewPullscreateRequestWithBody(server string, owner Owner, repo Repo, contentType string, body io.Reader) (*http.Request, error)
NewPullscreateRequestWithBody constructs an http.Request for the Pullscreate method, with any body, and a specified content type
func NewPullsgetRequest ¶
func NewPullsgetRequest(server string, owner Owner, repo Repo, pullNumber PullNumber) (*http.Request, error)
NewPullsgetRequest constructs an http.Request for the Pullsget method
func NewPullslistRequest ¶
func NewPullslistRequest(server string, owner Owner, repo Repo, params *PullslistParams) (*http.Request, error)
NewPullslistRequest constructs an http.Request for the Pullslist method
func NewPullsmergeRequest ¶
func NewPullsmergeRequest(server string, owner Owner, repo Repo, pullNumber PullNumber, body PullsmergeJSONRequestBody) (*http.Request, error)
NewPullsmergeRequest calls the generic Pullsmerge builder with application/json body
func NewPullsmergeRequestWithBody ¶
func NewPullsmergeRequestWithBody(server string, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader) (*http.Request, error)
NewPullsmergeRequestWithBody constructs an http.Request for the Pullsmerge method, with any body, and a specified content type
func NewPullsupdateRequest ¶
func NewPullsupdateRequest(server string, owner Owner, repo Repo, pullNumber PullNumber, body PullsupdateJSONRequestBody) (*http.Request, error)
NewPullsupdateRequest calls the generic Pullsupdate builder with application/json body
func NewPullsupdateRequestWithBody ¶
func NewPullsupdateRequestWithBody(server string, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader) (*http.Request, error)
NewPullsupdateRequestWithBody constructs an http.Request for the Pullsupdate method, with any body, and a specified content type
func NewReposgetCommitRequest ¶
func NewReposgetCommitRequest(server string, owner Owner, repo Repo, ref CommitRef, params *ReposgetCommitParams) (*http.Request, error)
NewReposgetCommitRequest constructs an http.Request for the ReposgetCommit method
func NewReposlistWebhookDeliveriesRequest ¶
func NewReposlistWebhookDeliveriesRequest(server string, owner Owner, repo Repo, hookId HookId, params *ReposlistWebhookDeliveriesParams) (*http.Request, error)
NewReposlistWebhookDeliveriesRequest constructs an http.Request for the ReposlistWebhookDeliveries method
func NewReposlistWebhooksRequest ¶
func NewReposlistWebhooksRequest(server string, owner Owner, repo Repo, params *ReposlistWebhooksParams) (*http.Request, error)
NewReposlistWebhooksRequest constructs an http.Request for the ReposlistWebhooks method
func NextCursor ¶
NextCursor is the cursor of the next page a cursor-paginated response's Link header points to: "" on the last page.
func TokenFromGhHosts ¶
TokenFromGhHosts is github.com's active-account token in the gh CLI's hosts.yml: the credential gh itself already uses, so CSF holds no second one. ErrNoToken when the file names none (gh keeps it in a keyring).
Types ¶
type AuthorAssociation ¶
type AuthorAssociation string
AuthorAssociation How the author is associated with the repository.
const ( COLLABORATOR AuthorAssociation = "COLLABORATOR" CONTRIBUTOR AuthorAssociation = "CONTRIBUTOR" FIRSTTIMECONTRIBUTOR AuthorAssociation = "FIRST_TIME_CONTRIBUTOR" FIRSTTIMER AuthorAssociation = "FIRST_TIMER" MANNEQUIN AuthorAssociation = "MANNEQUIN" MEMBER AuthorAssociation = "MEMBER" NONE AuthorAssociation = "NONE" OWNER AuthorAssociation = "OWNER" )
Defines values for AuthorAssociation.
func (AuthorAssociation) Valid ¶
func (e AuthorAssociation) Valid() bool
Valid indicates whether the value is a known member of the AuthorAssociation enum.
type AutoMerge ¶
type AutoMerge struct {
// CommitMessage Commit message for the merge commit.
CommitMessage string `json:"commit_message"`
// CommitTitle Title for the merge commit message.
CommitTitle string `json:"commit_title"`
// EnabledBy A GitHub user.
EnabledBy SimpleUser `json:"enabled_by"`
// MergeMethod The merge method to use.
MergeMethod AutoMergeMergeMethod `json:"merge_method"`
}
AutoMerge The status of auto merging a pull request.
type AutoMergeMergeMethod ¶
type AutoMergeMergeMethod string
AutoMergeMergeMethod The merge method to use.
const ( AutoMergeMergeMethodMerge AutoMergeMergeMethod = "merge" AutoMergeMergeMethodRebase AutoMergeMergeMethod = "rebase" AutoMergeMergeMethodSquash AutoMergeMergeMethod = "squash" )
Defines values for AutoMergeMergeMethod.
func (AutoMergeMergeMethod) Valid ¶
func (e AutoMergeMergeMethod) Valid() bool
Valid indicates whether the value is a known member of the AutoMergeMergeMethod enum.
type CheckRun ¶
type CheckRun struct {
// App GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
App *NullableIntegration `json:"app"`
CheckSuite *struct {
Id int `json:"id"`
} `json:"check_suite"`
CompletedAt *time.Time `json:"completed_at"`
Conclusion *CheckRunConclusion `json:"conclusion"`
// Deployment A deployment created as the result of an Actions check run from a workflow that references an environment
Deployment *DeploymentSimple `json:"deployment,omitempty"`
DetailsUrl *string `json:"details_url"`
ExternalId *string `json:"external_id"`
// HeadSha The SHA of the commit that is being checked.
HeadSha string `json:"head_sha"`
HtmlUrl *string `json:"html_url"`
// Id The id of the check.
Id int64 `json:"id"`
// Name The name of the check.
Name string `json:"name"`
NodeId string `json:"node_id"`
Output struct {
AnnotationsCount int `json:"annotations_count"`
AnnotationsUrl string `json:"annotations_url"`
Summary *string `json:"summary"`
Text *string `json:"text"`
Title *string `json:"title"`
} `json:"output"`
// PullRequests Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.
PullRequests []PullRequestMinimal `json:"pull_requests"`
StartedAt *time.Time `json:"started_at"`
// Status The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.
Status CheckRunStatus `json:"status"`
Url string `json:"url"`
}
CheckRun A check performed on the code of a given code change
type CheckRunConclusion ¶
type CheckRunConclusion string
CheckRunConclusion defines model for CheckRun.Conclusion.
const ( CheckRunConclusionActionRequired CheckRunConclusion = "action_required" CheckRunConclusionCancelled CheckRunConclusion = "cancelled" CheckRunConclusionFailure CheckRunConclusion = "failure" CheckRunConclusionNeutral CheckRunConclusion = "neutral" CheckRunConclusionSkipped CheckRunConclusion = "skipped" CheckRunConclusionSuccess CheckRunConclusion = "success" CheckRunConclusionTimedOut CheckRunConclusion = "timed_out" )
Defines values for CheckRunConclusion.
func (CheckRunConclusion) Valid ¶
func (e CheckRunConclusion) Valid() bool
Valid indicates whether the value is a known member of the CheckRunConclusion enum.
type CheckRunStatus ¶
type CheckRunStatus string
CheckRunStatus The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.
const ( CheckRunStatusCompleted CheckRunStatus = "completed" CheckRunStatusInProgress CheckRunStatus = "in_progress" CheckRunStatusPending CheckRunStatus = "pending" CheckRunStatusQueued CheckRunStatus = "queued" CheckRunStatusRequested CheckRunStatus = "requested" CheckRunStatusWaiting CheckRunStatus = "waiting" )
Defines values for CheckRunStatus.
func (CheckRunStatus) Valid ¶
func (e CheckRunStatus) Valid() bool
Valid indicates whether the value is a known member of the CheckRunStatus enum.
type ChecksListForRefResult ¶
type ChecksListForRefResult struct {
CheckRuns []CheckRun `json:"check_runs"`
TotalCount int `json:"total_count"`
}
ChecksListForRefResult defines model for checks-list-for-ref-result.
type CheckslistForRefParams ¶
type CheckslistForRefParams struct {
// CheckName Returns check runs with the specified `name`.
CheckName *CheckName `form:"check_name,omitempty" json:"check_name,omitempty"`
// Status Returns check runs with the specified `status`.
Status *CheckslistForRefParamsStatus `form:"status,omitempty" json:"status,omitempty"`
// Filter Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.
Filter *CheckslistForRefParamsFilter `form:"filter,omitempty" json:"filter,omitempty"`
// PerPage The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
PerPage *PerPage `form:"per_page,omitempty" json:"per_page,omitempty"`
// Page The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Page *Page `form:"page,omitempty" json:"page,omitempty"`
AppId *int `form:"app_id,omitempty" json:"app_id,omitempty"`
}
CheckslistForRefParams defines parameters for CheckslistForRef.
type CheckslistForRefParamsFilter ¶
type CheckslistForRefParamsFilter string
CheckslistForRefParamsFilter defines parameters for CheckslistForRef.
const ( CheckslistForRefParamsFilterAll CheckslistForRefParamsFilter = "all" CheckslistForRefParamsFilterLatest CheckslistForRefParamsFilter = "latest" )
Defines values for CheckslistForRefParamsFilter.
func (CheckslistForRefParamsFilter) Valid ¶
func (e CheckslistForRefParamsFilter) Valid() bool
Valid indicates whether the value is a known member of the CheckslistForRefParamsFilter enum.
type CheckslistForRefParamsStatus ¶
type CheckslistForRefParamsStatus string
CheckslistForRefParamsStatus defines parameters for CheckslistForRef.
const ( CheckslistForRefParamsStatusCompleted CheckslistForRefParamsStatus = "completed" CheckslistForRefParamsStatusInProgress CheckslistForRefParamsStatus = "in_progress" CheckslistForRefParamsStatusQueued CheckslistForRefParamsStatus = "queued" )
Defines values for CheckslistForRefParamsStatus.
func (CheckslistForRefParamsStatus) Valid ¶
func (e CheckslistForRefParamsStatus) Valid() bool
Valid indicates whether the value is a known member of the CheckslistForRefParamsStatus enum.
type CheckslistForRefResponse ¶
type CheckslistForRefResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *ChecksListForRefResult
// Headers200 the parsed response headers for an HTTP 200 response
Headers200 *CheckslistForRefResponse200Headers
}
func ParseCheckslistForRefResponse ¶
func ParseCheckslistForRefResponse(rsp *http.Response) (*CheckslistForRefResponse, error)
ParseCheckslistForRefResponse parses an HTTP response from a CheckslistForRefWithResponse call
func (CheckslistForRefResponse) ContentType ¶
func (r CheckslistForRefResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (CheckslistForRefResponse) GetBody ¶
func (r CheckslistForRefResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (CheckslistForRefResponse) GetJSON200 ¶
func (r CheckslistForRefResponse) GetJSON200() *ChecksListForRefResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (CheckslistForRefResponse) Status ¶
func (r CheckslistForRefResponse) Status() string
Status returns HTTPResponse.Status
func (CheckslistForRefResponse) StatusCode ¶
func (r CheckslistForRefResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CheckslistForRefResponse200Headers ¶
type CheckslistForRefResponse200Headers struct {
Link *string
}
CheckslistForRefResponse200Headers the declared response headers of an HTTP 200 response for CheckslistForRef
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) CheckslistForRef ¶
func (c *Client) CheckslistForRef(ctx context.Context, owner Owner, repo Repo, ref CommitRef, params *CheckslistForRefParams, reqEditors ...RequestEditorFn) (*http.Response, error)
CheckslistForRef List check runs for a Git reference
Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
> [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
Corresponds with GET /repos/{owner}/{repo}/commits/{ref}/check-runs (the `CheckslistForRef` operationId).
func (*Client) GitgetRef ¶
func (c *Client) GitgetRef(ctx context.Context, owner Owner, repo Repo, ref GitRefOnly, reqEditors ...RequestEditorFn) (*http.Response, error)
GitgetRef Get a reference
Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.
> [!NOTE] > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
Corresponds with GET /repos/{owner}/{repo}/git/ref/{ref} (the `GitgetRef` operationId).
func (*Client) IssuesaddBlockedByDependency ¶
func (c *Client) IssuesaddBlockedByDependency(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesaddBlockedByDependencyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
IssuesaddBlockedByDependency Add a dependency an issue is blocked by
You can use the REST API to add a 'blocked by' relationship to an issue.
Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).
This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type.
Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by (the `IssuesaddBlockedByDependency` operationId).
func (*Client) IssuesaddBlockedByDependencyWithBody ¶
func (c *Client) IssuesaddBlockedByDependencyWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
IssuesaddBlockedByDependencyWithBody Add a dependency an issue is blocked by
You can use the REST API to add a 'blocked by' relationship to an issue.
Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).
This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type.
Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by (the `IssuesaddBlockedByDependency` operationId).
func (*Client) Issuescreate ¶
func (c *Client) Issuescreate(ctx context.Context, owner Owner, repo Repo, body IssuescreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Issuescreate Create an issue
Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type.
Corresponds with POST /repos/{owner}/{repo}/issues (the `Issuescreate` operationId).
func (*Client) IssuescreateComment ¶
func (c *Client) IssuescreateComment(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuescreateCommentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
IssuescreateComment Create an issue comment
You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type.
Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssuescreateComment` operationId).
func (*Client) IssuescreateCommentWithBody ¶
func (c *Client) IssuescreateCommentWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
IssuescreateCommentWithBody Create an issue comment
You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type.
Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssuescreateComment` operationId).
func (*Client) IssuescreateWithBody ¶
func (c *Client) IssuescreateWithBody(ctx context.Context, owner Owner, repo Repo, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
IssuescreateWithBody Create an issue
Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type.
Corresponds with POST /repos/{owner}/{repo}/issues (the `Issuescreate` operationId).
func (*Client) Issuesget ¶
func (c *Client) Issuesget(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, reqEditors ...RequestEditorFn) (*http.Response, error)
Issuesget Get an issue
The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
> [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Corresponds with GET /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesget` operationId).
func (*Client) IssueslistComments ¶
func (c *Client) IssueslistComments(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, params *IssueslistCommentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
IssueslistComments List issue comments
You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
Issue comments are ordered by ascending ID.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Corresponds with GET /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssueslistComments` operationId).
func (*Client) IssueslistForRepo ¶
func (c *Client) IssueslistForRepo(ctx context.Context, owner Owner, repo Repo, params *IssueslistForRepoParams, reqEditors ...RequestEditorFn) (*http.Response, error)
IssueslistForRepo List repository issues
List issues in a repository. Only open issues will be listed.
> [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Corresponds with GET /repos/{owner}/{repo}/issues (the `IssueslistForRepo` operationId).
func (*Client) Issuesupdate ¶
func (c *Client) Issuesupdate(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesupdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Issuesupdate Update an issue
Issue owners and users with push access or Triage role can edit an issue.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type.
Corresponds with PATCH /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesupdate` operationId).
func (*Client) IssuesupdateWithBody ¶
func (c *Client) IssuesupdateWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
IssuesupdateWithBody Update an issue
Issue owners and users with push access or Triage role can edit an issue.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type.
Corresponds with PATCH /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesupdate` operationId).
func (*Client) Pullscreate ¶
func (c *Client) Pullscreate(ctx context.Context, owner Owner, repo Repo, body PullscreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Pullscreate Create a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type.
Corresponds with POST /repos/{owner}/{repo}/pulls (the `Pullscreate` operationId).
func (*Client) PullscreateWithBody ¶
func (c *Client) PullscreateWithBody(ctx context.Context, owner Owner, repo Repo, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PullscreateWithBody Create a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type.
Corresponds with POST /repos/{owner}/{repo}/pulls (the `Pullscreate` operationId).
func (*Client) Pullsget ¶
func (c *Client) Pullsget(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, reqEditors ...RequestEditorFn) (*http.Response, error)
Pullsget Get a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Lists details of a pull request by providing its number.
When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.
The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:
* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
Corresponds with GET /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsget` operationId).
func (*Client) Pullslist ¶
func (c *Client) Pullslist(ctx context.Context, owner Owner, repo Repo, params *PullslistParams, reqEditors ...RequestEditorFn) (*http.Response, error)
Pullslist List pull requests
Lists pull requests in a specified repository.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Corresponds with GET /repos/{owner}/{repo}/pulls (the `Pullslist` operationId).
func (*Client) Pullsmerge ¶
func (c *Client) Pullsmerge(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, body PullsmergeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Pullsmerge Merge a pull request
> [!NOTE] > We recommend using the [asynchronous merge API](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously) instead. This endpoint does not support stacked pull requests or merging with a merge queue.
Merges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
Takes a body of the `application/json` content type.
Corresponds with PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (the `Pullsmerge` operationId).
func (*Client) PullsmergeWithBody ¶
func (c *Client) PullsmergeWithBody(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PullsmergeWithBody Merge a pull request
> [!NOTE] > We recommend using the [asynchronous merge API](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously) instead. This endpoint does not support stacked pull requests or merging with a merge queue.
Merges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
Takes any type of body and a specified content type.
Corresponds with PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (the `Pullsmerge` operationId).
func (*Client) Pullsupdate ¶
func (c *Client) Pullsupdate(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, body PullsupdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Pullsupdate Update a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type.
Corresponds with PATCH /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsupdate` operationId).
func (*Client) PullsupdateWithBody ¶
func (c *Client) PullsupdateWithBody(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PullsupdateWithBody Update a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type.
Corresponds with PATCH /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsupdate` operationId).
func (*Client) ReposgetCommit ¶
func (c *Client) ReposgetCommit(ctx context.Context, owner Owner, repo Repo, ref CommitRef, params *ReposgetCommitParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ReposgetCommit Get a commit
Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
> [!NOTE] > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.
- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. |
These are the possible values for `reason` in the `verification` object:
| Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. |
Corresponds with GET /repos/{owner}/{repo}/commits/{ref} (the `ReposgetCommit` operationId).
func (*Client) ReposlistWebhookDeliveries ¶
func (c *Client) ReposlistWebhookDeliveries(ctx context.Context, owner Owner, repo Repo, hookId HookId, params *ReposlistWebhookDeliveriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ReposlistWebhookDeliveries List deliveries for a repository webhook
Returns a list of webhook deliveries for a webhook configured in a repository.
Corresponds with GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries (the `ReposlistWebhookDeliveries` operationId).
func (*Client) ReposlistWebhooks ¶
func (c *Client) ReposlistWebhooks(ctx context.Context, owner Owner, repo Repo, params *ReposlistWebhooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ReposlistWebhooks List repository webhooks
Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
Corresponds with GET /repos/{owner}/{repo}/hooks (the `ReposlistWebhooks` operationId).
type ClientInterface ¶
type ClientInterface interface {
// ReposgetCommit Get a commit
//
// Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
//
// > [!NOTE]
// > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.
//
// - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
// - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
// - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
//
// **Signature verification object**
//
// The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
//
// | Name | Type | Description |
// | ---- | ---- | ----------- |
// | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
// | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
// | `signature` | `string` | The signature that was extracted from the commit. |
// | `payload` | `string` | The value that was signed. |
// | `verified_at` | `string` | The date the signature was verified by GitHub. |
//
// These are the possible values for `reason` in the `verification` object:
//
// | Value | Description |
// | ----- | ----------- |
// | `expired_key` | The key that made the signature is expired. |
// | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
// | `gpgverify_error` | There was an error communicating with the signature verification service. |
// | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
// | `unsigned` | The object does not include a signature. |
// | `unknown_signature_type` | A non-PGP signature was found in the commit. |
// | `no_user` | No user was associated with the `committer` email address in the commit. |
// | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
// | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
// | `unknown_key` | The key that made the signature has not been registered with any user's account. |
// | `malformed_signature` | There was an error parsing the signature. |
// | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
// | `valid` | None of the above errors applied, so the signature is considered to be verified. |
//
// Corresponds with GET /repos/{owner}/{repo}/commits/{ref} (the `ReposgetCommit` operationId).
ReposgetCommit(ctx context.Context, owner Owner, repo Repo, ref CommitRef, params *ReposgetCommitParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CheckslistForRef List check runs for a Git reference
//
// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
//
// > [!NOTE]
// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
//
// If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
//
// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
//
// Corresponds with GET /repos/{owner}/{repo}/commits/{ref}/check-runs (the `CheckslistForRef` operationId).
CheckslistForRef(ctx context.Context, owner Owner, repo Repo, ref CommitRef, params *CheckslistForRefParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GitgetRef Get a reference
//
// Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.
//
// > [!NOTE]
// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
//
// Corresponds with GET /repos/{owner}/{repo}/git/ref/{ref} (the `GitgetRef` operationId).
GitgetRef(ctx context.Context, owner Owner, repo Repo, ref GitRefOnly, reqEditors ...RequestEditorFn) (*http.Response, error)
// ReposlistWebhooks List repository webhooks
//
// Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
//
// Corresponds with GET /repos/{owner}/{repo}/hooks (the `ReposlistWebhooks` operationId).
ReposlistWebhooks(ctx context.Context, owner Owner, repo Repo, params *ReposlistWebhooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// ReposlistWebhookDeliveries List deliveries for a repository webhook
//
// Returns a list of webhook deliveries for a webhook configured in a repository.
//
// Corresponds with GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries (the `ReposlistWebhookDeliveries` operationId).
ReposlistWebhookDeliveries(ctx context.Context, owner Owner, repo Repo, hookId HookId, params *ReposlistWebhookDeliveriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssueslistForRepo List repository issues
//
// List issues in a repository. Only open issues will be listed.
//
// > [!NOTE]
// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Corresponds with GET /repos/{owner}/{repo}/issues (the `IssueslistForRepo` operationId).
IssueslistForRepo(ctx context.Context, owner Owner, repo Repo, params *IssueslistForRepoParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssuescreateWithBody Create an issue
//
// Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
// and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /repos/{owner}/{repo}/issues (the `Issuescreate` operationId).
IssuescreateWithBody(ctx context.Context, owner Owner, repo Repo, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Issuescreate Create an issue
//
// Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
// and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /repos/{owner}/{repo}/issues (the `Issuescreate` operationId).
Issuescreate(ctx context.Context, owner Owner, repo Repo, body IssuescreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// Issuesget Get an issue
//
// The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
// [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
// the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
// returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
// access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
// to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
//
// > [!NOTE]
// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Corresponds with GET /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesget` operationId).
Issuesget(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssuesupdateWithBody Update an issue
//
// Issue owners and users with push access or Triage role can edit an issue.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PATCH /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesupdate` operationId).
IssuesupdateWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Issuesupdate Update an issue
//
// Issue owners and users with push access or Triage role can edit an issue.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PATCH /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesupdate` operationId).
Issuesupdate(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesupdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssueslistComments List issue comments
//
// You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
//
// Issue comments are ordered by ascending ID.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Corresponds with GET /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssueslistComments` operationId).
IssueslistComments(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, params *IssueslistCommentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssuescreateCommentWithBody Create an issue comment
//
// You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
// and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssuescreateComment` operationId).
IssuescreateCommentWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssuescreateComment Create an issue comment
//
// You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
// and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssuescreateComment` operationId).
IssuescreateComment(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuescreateCommentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssuesaddBlockedByDependencyWithBody Add a dependency an issue is blocked by
//
// You can use the REST API to add a 'blocked by' relationship to an issue.
//
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)
// and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).
//
// This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
//
// - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by (the `IssuesaddBlockedByDependency` operationId).
IssuesaddBlockedByDependencyWithBody(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssuesaddBlockedByDependency Add a dependency an issue is blocked by
//
// You can use the REST API to add a 'blocked by' relationship to an issue.
//
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)
// and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).
//
// This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
//
// - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by (the `IssuesaddBlockedByDependency` operationId).
IssuesaddBlockedByDependency(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesaddBlockedByDependencyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// Pullslist List pull requests
//
// Lists pull requests in a specified repository.
//
// Draft pull requests are available in public repositories with GitHub
// Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
// plans, and in public and private repositories with GitHub Team and GitHub Enterprise
// Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
// in the GitHub Help documentation.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Corresponds with GET /repos/{owner}/{repo}/pulls (the `Pullslist` operationId).
Pullslist(ctx context.Context, owner Owner, repo Repo, params *PullslistParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PullscreateWithBody Create a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /repos/{owner}/{repo}/pulls (the `Pullscreate` operationId).
PullscreateWithBody(ctx context.Context, owner Owner, repo Repo, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Pullscreate Create a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /repos/{owner}/{repo}/pulls (the `Pullscreate` operationId).
Pullscreate(ctx context.Context, owner Owner, repo Repo, body PullscreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// Pullsget Get a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// Lists details of a pull request by providing its number.
//
// When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
//
// The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.
//
// The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:
//
// * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
// * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
// * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
//
// Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
// - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
//
// Corresponds with GET /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsget` operationId).
Pullsget(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, reqEditors ...RequestEditorFn) (*http.Response, error)
// PullsupdateWithBody Update a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PATCH /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsupdate` operationId).
PullsupdateWithBody(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Pullsupdate Update a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PATCH /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsupdate` operationId).
Pullsupdate(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, body PullsupdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PullsmergeWithBody Merge a pull request
//
// > [!NOTE]
// > We recommend using the [asynchronous merge API](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously) instead. This endpoint does not support stacked pull requests or merging with a merge queue.
//
// Merges a pull request into the base branch.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// Takes any type of body and a specified content type.
//
// Corresponds with PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (the `Pullsmerge` operationId).
PullsmergeWithBody(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Pullsmerge Merge a pull request
//
// > [!NOTE]
// > We recommend using the [asynchronous merge API](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously) instead. This endpoint does not support stacked pull requests or merging with a merge queue.
//
// Merges a pull request into the base branch.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (the `Pullsmerge` operationId).
Pullsmerge(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, body PullsmergeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) CheckslistForRefWithResponse ¶
func (c *ClientWithResponses) CheckslistForRefWithResponse(ctx context.Context, owner Owner, repo Repo, ref CommitRef, params *CheckslistForRefParams, reqEditors ...RequestEditorFn) (*CheckslistForRefResponse, error)
CheckslistForRefWithResponse List check runs for a Git reference
Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
> [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/commits/{ref}/check-runs (the `CheckslistForRef` operationId).
func (*ClientWithResponses) GitgetRefWithResponse ¶
func (c *ClientWithResponses) GitgetRefWithResponse(ctx context.Context, owner Owner, repo Repo, ref GitRefOnly, reqEditors ...RequestEditorFn) (*GitgetRefResponse, error)
GitgetRefWithResponse Get a reference
Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.
> [!NOTE] > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/git/ref/{ref} (the `GitgetRef` operationId).
func (*ClientWithResponses) IssuesaddBlockedByDependencyWithBodyWithResponse ¶
func (c *ClientWithResponses) IssuesaddBlockedByDependencyWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssuesaddBlockedByDependencyResponse, error)
IssuesaddBlockedByDependencyWithBodyWithResponse Add a dependency an issue is blocked by
You can use the REST API to add a 'blocked by' relationship to an issue.
Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).
This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by (the `IssuesaddBlockedByDependency` operationId).
func (*ClientWithResponses) IssuesaddBlockedByDependencyWithResponse ¶
func (c *ClientWithResponses) IssuesaddBlockedByDependencyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesaddBlockedByDependencyJSONRequestBody, reqEditors ...RequestEditorFn) (*IssuesaddBlockedByDependencyResponse, error)
IssuesaddBlockedByDependencyWithResponse Add a dependency an issue is blocked by
You can use the REST API to add a 'blocked by' relationship to an issue.
Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).
This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by (the `IssuesaddBlockedByDependency` operationId).
func (*ClientWithResponses) IssuescreateCommentWithBodyWithResponse ¶
func (c *ClientWithResponses) IssuescreateCommentWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssuescreateCommentResponse, error)
IssuescreateCommentWithBodyWithResponse Create an issue comment
You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssuescreateComment` operationId).
func (*ClientWithResponses) IssuescreateCommentWithResponse ¶
func (c *ClientWithResponses) IssuescreateCommentWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuescreateCommentJSONRequestBody, reqEditors ...RequestEditorFn) (*IssuescreateCommentResponse, error)
IssuescreateCommentWithResponse Create an issue comment
You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssuescreateComment` operationId).
func (*ClientWithResponses) IssuescreateWithBodyWithResponse ¶
func (c *ClientWithResponses) IssuescreateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssuescreateResponse, error)
IssuescreateWithBodyWithResponse Create an issue
Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /repos/{owner}/{repo}/issues (the `Issuescreate` operationId).
func (*ClientWithResponses) IssuescreateWithResponse ¶
func (c *ClientWithResponses) IssuescreateWithResponse(ctx context.Context, owner Owner, repo Repo, body IssuescreateJSONRequestBody, reqEditors ...RequestEditorFn) (*IssuescreateResponse, error)
IssuescreateWithResponse Create an issue
Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /repos/{owner}/{repo}/issues (the `Issuescreate` operationId).
func (*ClientWithResponses) IssuesgetWithResponse ¶
func (c *ClientWithResponses) IssuesgetWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, reqEditors ...RequestEditorFn) (*IssuesgetResponse, error)
IssuesgetWithResponse Get an issue
The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
> [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesget` operationId).
func (*ClientWithResponses) IssueslistCommentsWithResponse ¶
func (c *ClientWithResponses) IssueslistCommentsWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, params *IssueslistCommentsParams, reqEditors ...RequestEditorFn) (*IssueslistCommentsResponse, error)
IssueslistCommentsWithResponse List issue comments
You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
Issue comments are ordered by ascending ID.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssueslistComments` operationId).
func (*ClientWithResponses) IssueslistForRepoWithResponse ¶
func (c *ClientWithResponses) IssueslistForRepoWithResponse(ctx context.Context, owner Owner, repo Repo, params *IssueslistForRepoParams, reqEditors ...RequestEditorFn) (*IssueslistForRepoResponse, error)
IssueslistForRepoWithResponse List repository issues
List issues in a repository. Only open issues will be listed.
> [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/issues (the `IssueslistForRepo` operationId).
func (*ClientWithResponses) IssuesupdateWithBodyWithResponse ¶
func (c *ClientWithResponses) IssuesupdateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssuesupdateResponse, error)
IssuesupdateWithBodyWithResponse Update an issue
Issue owners and users with push access or Triage role can edit an issue.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesupdate` operationId).
func (*ClientWithResponses) IssuesupdateWithResponse ¶
func (c *ClientWithResponses) IssuesupdateWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesupdateJSONRequestBody, reqEditors ...RequestEditorFn) (*IssuesupdateResponse, error)
IssuesupdateWithResponse Update an issue
Issue owners and users with push access or Triage role can edit an issue.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesupdate` operationId).
func (*ClientWithResponses) PullscreateWithBodyWithResponse ¶
func (c *ClientWithResponses) PullscreateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PullscreateResponse, error)
PullscreateWithBodyWithResponse Create a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /repos/{owner}/{repo}/pulls (the `Pullscreate` operationId).
func (*ClientWithResponses) PullscreateWithResponse ¶
func (c *ClientWithResponses) PullscreateWithResponse(ctx context.Context, owner Owner, repo Repo, body PullscreateJSONRequestBody, reqEditors ...RequestEditorFn) (*PullscreateResponse, error)
PullscreateWithResponse Create a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /repos/{owner}/{repo}/pulls (the `Pullscreate` operationId).
func (*ClientWithResponses) PullsgetWithResponse ¶
func (c *ClientWithResponses) PullsgetWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, reqEditors ...RequestEditorFn) (*PullsgetResponse, error)
PullsgetWithResponse Get a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Lists details of a pull request by providing its number.
When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.
The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:
* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsget` operationId).
func (*ClientWithResponses) PullslistWithResponse ¶
func (c *ClientWithResponses) PullslistWithResponse(ctx context.Context, owner Owner, repo Repo, params *PullslistParams, reqEditors ...RequestEditorFn) (*PullslistResponse, error)
PullslistWithResponse List pull requests
Lists pull requests in a specified repository.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/pulls (the `Pullslist` operationId).
func (*ClientWithResponses) PullsmergeWithBodyWithResponse ¶
func (c *ClientWithResponses) PullsmergeWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PullsmergeResponse, error)
PullsmergeWithBodyWithResponse Merge a pull request
> [!NOTE] > We recommend using the [asynchronous merge API](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously) instead. This endpoint does not support stacked pull requests or merging with a merge queue.
Merges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (the `Pullsmerge` operationId).
func (*ClientWithResponses) PullsmergeWithResponse ¶
func (c *ClientWithResponses) PullsmergeWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, body PullsmergeJSONRequestBody, reqEditors ...RequestEditorFn) (*PullsmergeResponse, error)
PullsmergeWithResponse Merge a pull request
> [!NOTE] > We recommend using the [asynchronous merge API](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously) instead. This endpoint does not support stacked pull requests or merging with a merge queue.
Merges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (the `Pullsmerge` operationId).
func (*ClientWithResponses) PullsupdateWithBodyWithResponse ¶
func (c *ClientWithResponses) PullsupdateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PullsupdateResponse, error)
PullsupdateWithBodyWithResponse Update a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsupdate` operationId).
func (*ClientWithResponses) PullsupdateWithResponse ¶
func (c *ClientWithResponses) PullsupdateWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, body PullsupdateJSONRequestBody, reqEditors ...RequestEditorFn) (*PullsupdateResponse, error)
PullsupdateWithResponse Update a pull request
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsupdate` operationId).
func (*ClientWithResponses) ReposgetCommitWithResponse ¶
func (c *ClientWithResponses) ReposgetCommitWithResponse(ctx context.Context, owner Owner, repo Repo, ref CommitRef, params *ReposgetCommitParams, reqEditors ...RequestEditorFn) (*ReposgetCommitResponse, error)
ReposgetCommitWithResponse Get a commit
Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
> [!NOTE] > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.
- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
**Signature verification object**
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
| Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. |
These are the possible values for `reason` in the `verification` object:
| Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. |
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/commits/{ref} (the `ReposgetCommit` operationId).
func (*ClientWithResponses) ReposlistWebhookDeliveriesWithResponse ¶
func (c *ClientWithResponses) ReposlistWebhookDeliveriesWithResponse(ctx context.Context, owner Owner, repo Repo, hookId HookId, params *ReposlistWebhookDeliveriesParams, reqEditors ...RequestEditorFn) (*ReposlistWebhookDeliveriesResponse, error)
ReposlistWebhookDeliveriesWithResponse List deliveries for a repository webhook
Returns a list of webhook deliveries for a webhook configured in a repository.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries (the `ReposlistWebhookDeliveries` operationId).
func (*ClientWithResponses) ReposlistWebhooksWithResponse ¶
func (c *ClientWithResponses) ReposlistWebhooksWithResponse(ctx context.Context, owner Owner, repo Repo, params *ReposlistWebhooksParams, reqEditors ...RequestEditorFn) (*ReposlistWebhooksResponse, error)
ReposlistWebhooksWithResponse List repository webhooks
Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /repos/{owner}/{repo}/hooks (the `ReposlistWebhooks` operationId).
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// ReposgetCommitWithResponse Get a commit
//
// Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
//
// > [!NOTE]
// > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.
//
// - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
// - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
// - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
//
// **Signature verification object**
//
// The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
//
// | Name | Type | Description |
// | ---- | ---- | ----------- |
// | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
// | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
// | `signature` | `string` | The signature that was extracted from the commit. |
// | `payload` | `string` | The value that was signed. |
// | `verified_at` | `string` | The date the signature was verified by GitHub. |
//
// These are the possible values for `reason` in the `verification` object:
//
// | Value | Description |
// | ----- | ----------- |
// | `expired_key` | The key that made the signature is expired. |
// | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
// | `gpgverify_error` | There was an error communicating with the signature verification service. |
// | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
// | `unsigned` | The object does not include a signature. |
// | `unknown_signature_type` | A non-PGP signature was found in the commit. |
// | `no_user` | No user was associated with the `committer` email address in the commit. |
// | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
// | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
// | `unknown_key` | The key that made the signature has not been registered with any user's account. |
// | `malformed_signature` | There was an error parsing the signature. |
// | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
// | `valid` | None of the above errors applied, so the signature is considered to be verified. |
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/commits/{ref} (the `ReposgetCommit` operationId).
ReposgetCommitWithResponse(ctx context.Context, owner Owner, repo Repo, ref CommitRef, params *ReposgetCommitParams, reqEditors ...RequestEditorFn) (*ReposgetCommitResponse, error)
// CheckslistForRefWithResponse List check runs for a Git reference
//
// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
//
// > [!NOTE]
// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
//
// If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
//
// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/commits/{ref}/check-runs (the `CheckslistForRef` operationId).
CheckslistForRefWithResponse(ctx context.Context, owner Owner, repo Repo, ref CommitRef, params *CheckslistForRefParams, reqEditors ...RequestEditorFn) (*CheckslistForRefResponse, error)
// GitgetRefWithResponse Get a reference
//
// Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.
//
// > [!NOTE]
// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/git/ref/{ref} (the `GitgetRef` operationId).
GitgetRefWithResponse(ctx context.Context, owner Owner, repo Repo, ref GitRefOnly, reqEditors ...RequestEditorFn) (*GitgetRefResponse, error)
// ReposlistWebhooksWithResponse List repository webhooks
//
// Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/hooks (the `ReposlistWebhooks` operationId).
ReposlistWebhooksWithResponse(ctx context.Context, owner Owner, repo Repo, params *ReposlistWebhooksParams, reqEditors ...RequestEditorFn) (*ReposlistWebhooksResponse, error)
// ReposlistWebhookDeliveriesWithResponse List deliveries for a repository webhook
//
// Returns a list of webhook deliveries for a webhook configured in a repository.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries (the `ReposlistWebhookDeliveries` operationId).
ReposlistWebhookDeliveriesWithResponse(ctx context.Context, owner Owner, repo Repo, hookId HookId, params *ReposlistWebhookDeliveriesParams, reqEditors ...RequestEditorFn) (*ReposlistWebhookDeliveriesResponse, error)
// IssueslistForRepoWithResponse List repository issues
//
// List issues in a repository. Only open issues will be listed.
//
// > [!NOTE]
// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/issues (the `IssueslistForRepo` operationId).
IssueslistForRepoWithResponse(ctx context.Context, owner Owner, repo Repo, params *IssueslistForRepoParams, reqEditors ...RequestEditorFn) (*IssueslistForRepoResponse, error)
// IssuescreateWithBodyWithResponse Create an issue
//
// Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
// and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /repos/{owner}/{repo}/issues (the `Issuescreate` operationId).
IssuescreateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssuescreateResponse, error)
// IssuescreateWithResponse Create an issue
//
// Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
// and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /repos/{owner}/{repo}/issues (the `Issuescreate` operationId).
IssuescreateWithResponse(ctx context.Context, owner Owner, repo Repo, body IssuescreateJSONRequestBody, reqEditors ...RequestEditorFn) (*IssuescreateResponse, error)
// IssuesgetWithResponse Get an issue
//
// The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
// [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
// the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
// returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
// access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
// to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
//
// > [!NOTE]
// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesget` operationId).
IssuesgetWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, reqEditors ...RequestEditorFn) (*IssuesgetResponse, error)
// IssuesupdateWithBodyWithResponse Update an issue
//
// Issue owners and users with push access or Triage role can edit an issue.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesupdate` operationId).
IssuesupdateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssuesupdateResponse, error)
// IssuesupdateWithResponse Update an issue
//
// Issue owners and users with push access or Triage role can edit an issue.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /repos/{owner}/{repo}/issues/{issue_number} (the `Issuesupdate` operationId).
IssuesupdateWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesupdateJSONRequestBody, reqEditors ...RequestEditorFn) (*IssuesupdateResponse, error)
// IssueslistCommentsWithResponse List issue comments
//
// You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
//
// Issue comments are ordered by ascending ID.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssueslistComments` operationId).
IssueslistCommentsWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, params *IssueslistCommentsParams, reqEditors ...RequestEditorFn) (*IssueslistCommentsResponse, error)
// IssuescreateCommentWithBodyWithResponse Create an issue comment
//
// You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
// and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssuescreateComment` operationId).
IssuescreateCommentWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssuescreateCommentResponse, error)
// IssuescreateCommentWithResponse Create an issue comment
//
// You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
// and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/comments (the `IssuescreateComment` operationId).
IssuescreateCommentWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuescreateCommentJSONRequestBody, reqEditors ...RequestEditorFn) (*IssuescreateCommentResponse, error)
// IssuesaddBlockedByDependencyWithBodyWithResponse Add a dependency an issue is blocked by
//
// You can use the REST API to add a 'blocked by' relationship to an issue.
//
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)
// and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).
//
// This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
//
// - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by (the `IssuesaddBlockedByDependency` operationId).
IssuesaddBlockedByDependencyWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssuesaddBlockedByDependencyResponse, error)
// IssuesaddBlockedByDependencyWithResponse Add a dependency an issue is blocked by
//
// You can use the REST API to add a 'blocked by' relationship to an issue.
//
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)
// and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).
//
// This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
//
// - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by (the `IssuesaddBlockedByDependency` operationId).
IssuesaddBlockedByDependencyWithResponse(ctx context.Context, owner Owner, repo Repo, issueNumber IssueNumber, body IssuesaddBlockedByDependencyJSONRequestBody, reqEditors ...RequestEditorFn) (*IssuesaddBlockedByDependencyResponse, error)
// PullslistWithResponse List pull requests
//
// Lists pull requests in a specified repository.
//
// Draft pull requests are available in public repositories with GitHub
// Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
// plans, and in public and private repositories with GitHub Team and GitHub Enterprise
// Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
// in the GitHub Help documentation.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/pulls (the `Pullslist` operationId).
PullslistWithResponse(ctx context.Context, owner Owner, repo Repo, params *PullslistParams, reqEditors ...RequestEditorFn) (*PullslistResponse, error)
// PullscreateWithBodyWithResponse Create a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /repos/{owner}/{repo}/pulls (the `Pullscreate` operationId).
PullscreateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PullscreateResponse, error)
// PullscreateWithResponse Create a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /repos/{owner}/{repo}/pulls (the `Pullscreate` operationId).
PullscreateWithResponse(ctx context.Context, owner Owner, repo Repo, body PullscreateJSONRequestBody, reqEditors ...RequestEditorFn) (*PullscreateResponse, error)
// PullsgetWithResponse Get a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// Lists details of a pull request by providing its number.
//
// When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
//
// The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.
//
// The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:
//
// * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
// * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
// * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
//
// Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
// - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsget` operationId).
PullsgetWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, reqEditors ...RequestEditorFn) (*PullsgetResponse, error)
// PullsupdateWithBodyWithResponse Update a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsupdate` operationId).
PullsupdateWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PullsupdateResponse, error)
// PullsupdateWithResponse Update a pull request
//
// Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
//
// To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
//
// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
//
// - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
// - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
// - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
// - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /repos/{owner}/{repo}/pulls/{pull_number} (the `Pullsupdate` operationId).
PullsupdateWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, body PullsupdateJSONRequestBody, reqEditors ...RequestEditorFn) (*PullsupdateResponse, error)
// PullsmergeWithBodyWithResponse Merge a pull request
//
// > [!NOTE]
// > We recommend using the [asynchronous merge API](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously) instead. This endpoint does not support stacked pull requests or merging with a merge queue.
//
// Merges a pull request into the base branch.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (the `Pullsmerge` operationId).
PullsmergeWithBodyWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PullsmergeResponse, error)
// PullsmergeWithResponse Merge a pull request
//
// > [!NOTE]
// > We recommend using the [asynchronous merge API](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously) instead. This endpoint does not support stacked pull requests or merging with a merge queue.
//
// Merges a pull request into the base branch.
//
// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
// Creating content too quickly using this endpoint may result in secondary rate limiting.
// For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge (the `Pullsmerge` operationId).
PullsmergeWithResponse(ctx context.Context, owner Owner, repo Repo, pullNumber PullNumber, body PullsmergeJSONRequestBody, reqEditors ...RequestEditorFn) (*PullsmergeResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type Commit ¶
type Commit struct {
Author *Commit_Author `json:"author"`
CommentsUrl string `json:"comments_url"`
Commit struct {
// Author Metaproperties for Git author/committer information.
Author *NullableGitUser `json:"author"`
CommentCount int `json:"comment_count"`
// Committer Metaproperties for Git author/committer information.
Committer *NullableGitUser `json:"committer"`
Message string `json:"message"`
Tree struct {
Sha string `json:"sha"`
Url string `json:"url"`
} `json:"tree"`
Url string `json:"url"`
Verification *Verification `json:"verification,omitempty"`
} `json:"commit"`
Committer *Commit_Committer `json:"committer"`
Files *[]DiffEntry `json:"files,omitempty"`
HtmlUrl string `json:"html_url"`
NodeId string `json:"node_id"`
Parents []struct {
HtmlUrl *string `json:"html_url,omitempty"`
Sha string `json:"sha"`
Url string `json:"url"`
} `json:"parents"`
Sha string `json:"sha"`
Stats *struct {
Additions *int `json:"additions,omitempty"`
Deletions *int `json:"deletions,omitempty"`
Total *int `json:"total,omitempty"`
} `json:"stats,omitempty"`
Url string `json:"url"`
}
Commit Commit
type Commit_Author ¶
type Commit_Author struct {
// contains filtered or unexported fields
}
Commit_Author defines model for Commit.Author.
func (Commit_Author) AsEmptyObject ¶
func (t Commit_Author) AsEmptyObject() (EmptyObject, error)
AsEmptyObject returns the union data inside the Commit_Author as a EmptyObject
func (Commit_Author) AsSimpleUser ¶
func (t Commit_Author) AsSimpleUser() (SimpleUser, error)
AsSimpleUser returns the union data inside the Commit_Author as a SimpleUser
func (*Commit_Author) FromEmptyObject ¶
func (t *Commit_Author) FromEmptyObject(v EmptyObject) error
FromEmptyObject overwrites any union data inside the Commit_Author as the provided EmptyObject
func (*Commit_Author) FromSimpleUser ¶
func (t *Commit_Author) FromSimpleUser(v SimpleUser) error
FromSimpleUser overwrites any union data inside the Commit_Author as the provided SimpleUser
func (Commit_Author) MarshalJSON ¶
func (t Commit_Author) MarshalJSON() ([]byte, error)
func (*Commit_Author) MergeEmptyObject ¶
func (t *Commit_Author) MergeEmptyObject(v EmptyObject) error
MergeEmptyObject performs a merge with any union data inside the Commit_Author, using the provided EmptyObject
func (*Commit_Author) MergeSimpleUser ¶
func (t *Commit_Author) MergeSimpleUser(v SimpleUser) error
MergeSimpleUser performs a merge with any union data inside the Commit_Author, using the provided SimpleUser
func (*Commit_Author) UnmarshalJSON ¶
func (t *Commit_Author) UnmarshalJSON(b []byte) error
type Commit_Committer ¶
type Commit_Committer struct {
// contains filtered or unexported fields
}
Commit_Committer defines model for Commit.Committer.
func (Commit_Committer) AsEmptyObject ¶
func (t Commit_Committer) AsEmptyObject() (EmptyObject, error)
AsEmptyObject returns the union data inside the Commit_Committer as a EmptyObject
func (Commit_Committer) AsSimpleUser ¶
func (t Commit_Committer) AsSimpleUser() (SimpleUser, error)
AsSimpleUser returns the union data inside the Commit_Committer as a SimpleUser
func (*Commit_Committer) FromEmptyObject ¶
func (t *Commit_Committer) FromEmptyObject(v EmptyObject) error
FromEmptyObject overwrites any union data inside the Commit_Committer as the provided EmptyObject
func (*Commit_Committer) FromSimpleUser ¶
func (t *Commit_Committer) FromSimpleUser(v SimpleUser) error
FromSimpleUser overwrites any union data inside the Commit_Committer as the provided SimpleUser
func (Commit_Committer) MarshalJSON ¶
func (t Commit_Committer) MarshalJSON() ([]byte, error)
func (*Commit_Committer) MergeEmptyObject ¶
func (t *Commit_Committer) MergeEmptyObject(v EmptyObject) error
MergeEmptyObject performs a merge with any union data inside the Commit_Committer, using the provided EmptyObject
func (*Commit_Committer) MergeSimpleUser ¶
func (t *Commit_Committer) MergeSimpleUser(v SimpleUser) error
MergeSimpleUser performs a merge with any union data inside the Commit_Committer, using the provided SimpleUser
func (*Commit_Committer) UnmarshalJSON ¶
func (t *Commit_Committer) UnmarshalJSON(b []byte) error
type DeploymentSimple ¶
type DeploymentSimple struct {
CreatedAt time.Time `json:"created_at"`
Description *string `json:"description"`
// Environment Name for the target deployment environment.
Environment string `json:"environment"`
// Id Unique identifier of the deployment
Id int `json:"id"`
NodeId string `json:"node_id"`
OriginalEnvironment *string `json:"original_environment,omitempty"`
// PerformedViaGithubApp GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
PerformedViaGithubApp *NullableIntegration `json:"performed_via_github_app,omitempty"`
// ProductionEnvironment Specifies if the given environment is one that end-users directly interact with. Default: false.
ProductionEnvironment *bool `json:"production_environment,omitempty"`
RepositoryUrl string `json:"repository_url"`
StatusesUrl string `json:"statuses_url"`
// Task Parameter to specify a task to execute
Task string `json:"task"`
// TransientEnvironment Specifies if the given environment is will no longer exist at some point in the future. Default: false.
TransientEnvironment *bool `json:"transient_environment,omitempty"`
UpdatedAt time.Time `json:"updated_at"`
Url string `json:"url"`
}
DeploymentSimple A deployment created as the result of an Actions check run from a workflow that references an environment
type DiffEntry ¶
type DiffEntry struct {
Additions int `json:"additions"`
BlobUrl string `json:"blob_url"`
Changes int `json:"changes"`
ContentsUrl string `json:"contents_url"`
Deletions int `json:"deletions"`
Filename string `json:"filename"`
Patch *string `json:"patch,omitempty"`
PreviousFilename *string `json:"previous_filename,omitempty"`
RawUrl string `json:"raw_url"`
Sha *string `json:"sha"`
Status DiffEntryStatus `json:"status"`
}
DiffEntry Diff Entry
type DiffEntryStatus ¶
type DiffEntryStatus string
DiffEntryStatus defines model for DiffEntry.Status.
const ( Added DiffEntryStatus = "added" Changed DiffEntryStatus = "changed" Copied DiffEntryStatus = "copied" Modified DiffEntryStatus = "modified" Removed DiffEntryStatus = "removed" Renamed DiffEntryStatus = "renamed" Unchanged DiffEntryStatus = "unchanged" )
Defines values for DiffEntryStatus.
func (DiffEntryStatus) Valid ¶
func (e DiffEntryStatus) Valid() bool
Valid indicates whether the value is a known member of the DiffEntryStatus enum.
type Direction ¶
type Direction string
Direction defines model for direction.
Defines values for Direction.
type EmptyObject ¶
type EmptyObject = map[string]interface{}
EmptyObject An object without any properties.
type Enterprise ¶
type Enterprise struct {
AvatarUrl string `json:"avatar_url"`
CreatedAt *time.Time `json:"created_at"`
// Description A short description of the enterprise.
Description *string `json:"description,omitempty"`
HtmlUrl string `json:"html_url"`
// Id Unique identifier of the enterprise
Id int `json:"id"`
// Name The name of the enterprise.
Name string `json:"name"`
NodeId string `json:"node_id"`
// Slug The slug url identifier for the enterprise.
Slug string `json:"slug"`
UpdatedAt *time.Time `json:"updated_at"`
// WebsiteUrl The enterprise's website URL.
WebsiteUrl *string `json:"website_url,omitempty"`
}
Enterprise An enterprise on GitHub.
type GitHubClient ¶
type GitHubClient struct {
*ClientWithResponses
// contains filtered or unexported fields
}
GitHubClient is the generated client, authenticated, plus the operations the REST description lacks.
func NewGitHubClient ¶
func NewGitHubClient(httpClient iohttp.IHTTPClient, token string) (*GitHubClient, error)
NewGitHubClient builds the client whose every request httpClient sends, authenticated with token, against Server.
func (*GitHubClient) MarkPullRequestReady ¶
func (client *GitHubClient) MarkPullRequestReady(ctx context.Context, owner string, repo string, number int) (ReadyPullRequest, RateLimit, error)
MarkPullRequestReady takes a draft pull request out of draft through GraphQL's markPullRequestReadyForReview, and returns it with the rate limit the last response reported. A pull request that is not a draft is left as it is.
func (*GitHubClient) RedeliverHookDelivery ¶
func (client *GitHubClient) RedeliverHookDelivery(ctx context.Context, owner string, repo string, hook int, delivery int64) (RateLimit, error)
RedeliverHookDelivery asks GitHub to deliver one attempt to a repository webhook again. GitHub answers 202 with no body the description names, so the generated client does not carry it.
type GitRef ¶
type GitRef struct {
NodeId string `json:"node_id"`
Object struct {
// Sha SHA for the reference
Sha string `json:"sha"`
Type string `json:"type"`
Url string `json:"url"`
} `json:"object"`
Ref string `json:"ref"`
Url string `json:"url"`
}
GitRef Git references within a repository
type GitgetRefResponse ¶
type GitgetRefResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *GitRef
}
func ParseGitgetRefResponse ¶
func ParseGitgetRefResponse(rsp *http.Response) (*GitgetRefResponse, error)
ParseGitgetRefResponse parses an HTTP response from a GitgetRefWithResponse call
func (GitgetRefResponse) ContentType ¶
func (r GitgetRefResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GitgetRefResponse) GetBody ¶
func (r GitgetRefResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GitgetRefResponse) GetJSON200 ¶
func (r GitgetRefResponse) GetJSON200() *GitRef
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GitgetRefResponse) Status ¶
func (r GitgetRefResponse) Status() string
Status returns HTTPResponse.Status
func (GitgetRefResponse) StatusCode ¶
func (r GitgetRefResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Hook ¶
type Hook struct {
// Active Determines whether the hook is actually triggered on pushes.
Active bool `json:"active"`
// Config Configuration object of the webhook
Config WebhookConfig `json:"config"`
CreatedAt time.Time `json:"created_at"`
DeliveriesUrl *string `json:"deliveries_url,omitempty"`
// Events Determines what events the hook is triggered for. Default: ['push'].
Events []string `json:"events"`
// Id Unique identifier of the webhook.
Id int `json:"id"`
LastResponse HookResponse `json:"last_response"`
// Name The name of a valid service, use 'web' for a webhook.
Name string `json:"name"`
PingUrl string `json:"ping_url"`
TestUrl string `json:"test_url"`
Type string `json:"type"`
UpdatedAt time.Time `json:"updated_at"`
Url string `json:"url"`
}
Hook Webhooks for repositories.
type HookDeliveryItem ¶
type HookDeliveryItem struct {
// Action The type of activity for the event that triggered the delivery.
Action *string `json:"action"`
// DeliveredAt Time when the webhook delivery occurred.
DeliveredAt time.Time `json:"delivered_at"`
// Duration Time spent delivering.
Duration float32 `json:"duration"`
// Event The event that triggered the delivery.
Event string `json:"event"`
// Guid Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
Guid string `json:"guid"`
// Id Unique identifier of the webhook delivery.
Id int64 `json:"id"`
// InstallationId The id of the GitHub App installation associated with this event.
InstallationId *int64 `json:"installation_id"`
// Redelivery Whether the webhook delivery is a redelivery.
Redelivery bool `json:"redelivery"`
// RepositoryId The id of the repository associated with this event.
RepositoryId *int64 `json:"repository_id"`
// Status Describes the response returned after attempting the delivery.
Status string `json:"status"`
// StatusCode Status code received when delivery was made.
StatusCode int `json:"status_code"`
// ThrottledAt Time when the webhook delivery was throttled.
ThrottledAt *time.Time `json:"throttled_at,omitempty"`
}
HookDeliveryItem Delivery made by a webhook, without request and response information.
type HookResponse ¶
type HookResponse struct {
Code *int `json:"code"`
Message *string `json:"message"`
Status *string `json:"status"`
}
HookResponse defines model for hook-response.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type Issue ¶
type Issue struct {
ActiveLockReason *string `json:"active_lock_reason,omitempty"`
Assignees *[]SimpleUser `json:"assignees,omitempty"`
// AuthorAssociation How the author is associated with the repository.
AuthorAssociation *AuthorAssociation `json:"author_association,omitempty"`
// Body Contents of the issue
Body *string `json:"body,omitempty"`
BodyHtml *string `json:"body_html,omitempty"`
BodyText *string `json:"body_text,omitempty"`
ClosedAt *time.Time `json:"closed_at"`
// ClosedBy A GitHub user.
ClosedBy *NullableSimpleUser `json:"closed_by,omitempty"`
Comments int `json:"comments"`
CommentsUrl string `json:"comments_url"`
CreatedAt time.Time `json:"created_at"`
Draft *bool `json:"draft,omitempty"`
EventsUrl string `json:"events_url"`
HtmlUrl string `json:"html_url"`
Id int64 `json:"id"`
IssueDependenciesSummary *IssueDependenciesSummary `json:"issue_dependencies_summary,omitempty"`
IssueFieldValues *[]IssueFieldValue `json:"issue_field_values,omitempty"`
// Labels Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
Labels []Issue_Labels_Item `json:"labels"`
LabelsUrl string `json:"labels_url"`
Locked bool `json:"locked"`
// Milestone A collection of related issues and pull requests.
Milestone *NullableMilestone `json:"milestone"`
NodeId string `json:"node_id"`
// Number Number uniquely identifying the issue within its repository
Number int `json:"number"`
// ParentIssueUrl URL to get the parent issue of this issue, if it is a sub-issue
ParentIssueUrl *string `json:"parent_issue_url,omitempty"`
// PerformedViaGithubApp GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
PerformedViaGithubApp *NullableIntegration `json:"performed_via_github_app,omitempty"`
// PinnedComment Comments provide a way for people to collaborate on an issue.
PinnedComment *NullableIssueComment `json:"pinned_comment,omitempty"`
PullRequest *struct {
DiffUrl string `json:"diff_url"`
HtmlUrl string `json:"html_url"`
MergedAt *time.Time `json:"merged_at,omitempty"`
PatchUrl string `json:"patch_url"`
Url string `json:"url"`
} `json:"pull_request,omitempty"`
Reactions *ReactionRollup `json:"reactions,omitempty"`
// Repository A repository on GitHub.
Repository *Repository `json:"repository,omitempty"`
RepositoryUrl string `json:"repository_url"`
// State State of the issue; either 'open' or 'closed'
State string `json:"state"`
// StateReason The reason for the current state
StateReason *IssueStateReason `json:"state_reason,omitempty"`
SubIssuesSummary *SubIssuesSummary `json:"sub_issues_summary,omitempty"`
TimelineUrl *string `json:"timeline_url,omitempty"`
// Title Title of the issue
Title string `json:"title"`
// Type The type assigned to the issue. This is only present for issues in repositories where issue types are supported.
Type *IssueType `json:"type,omitempty"`
UpdatedAt time.Time `json:"updated_at"`
// Url URL for the issue
Url string `json:"url"`
// User A GitHub user.
User *NullableSimpleUser `json:"user"`
}
Issue Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
type IssueComment ¶
type IssueComment struct {
// AuthorAssociation How the author is associated with the repository.
AuthorAssociation *AuthorAssociation `json:"author_association,omitempty"`
// Body Contents of the issue comment
Body *string `json:"body,omitempty"`
BodyHtml *string `json:"body_html,omitempty"`
BodyText *string `json:"body_text,omitempty"`
CreatedAt time.Time `json:"created_at"`
HtmlUrl string `json:"html_url"`
// Id Unique identifier of the issue comment
Id int64 `json:"id"`
IssueUrl string `json:"issue_url"`
// Minimized Details about why an issue comment was minimized.
Minimized *NullableIssueCommentMinimized `json:"minimized,omitempty"`
NodeId string `json:"node_id"`
// PerformedViaGithubApp GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
PerformedViaGithubApp *NullableIntegration `json:"performed_via_github_app,omitempty"`
// Pin Context around who pinned an issue comment and when it was pinned.
Pin *NullablePinnedIssueComment `json:"pin,omitempty"`
Reactions *ReactionRollup `json:"reactions,omitempty"`
UpdatedAt time.Time `json:"updated_at"`
// Url URL for the issue comment
Url string `json:"url"`
// User A GitHub user.
User *NullableSimpleUser `json:"user"`
}
IssueComment Comments provide a way for people to collaborate on an issue.
type IssueDependenciesSummary ¶
type IssueDependenciesSummary struct {
BlockedBy int `json:"blocked_by"`
Blocking int `json:"blocking"`
TotalBlockedBy int `json:"total_blocked_by"`
TotalBlocking int `json:"total_blocking"`
}
IssueDependenciesSummary defines model for issue-dependencies-summary.
type IssueFieldValue ¶
type IssueFieldValue struct {
// DataType The data type of the issue field
DataType IssueFieldValueDataType `json:"data_type"`
// IssueFieldId Unique identifier for the issue field.
IssueFieldId int64 `json:"issue_field_id"`
// IssueFieldName The human-readable name of the issue field.
IssueFieldName *string `json:"issue_field_name,omitempty"`
// MultiSelectOptions Details about the selected options
MultiSelectOptions *[]struct {
// Color The color of the option
Color string `json:"color"`
// Id Unique identifier for the option.
Id int64 `json:"id"`
// Name The name of the option
Name string `json:"name"`
} `json:"multi_select_options,omitempty"`
NodeId string `json:"node_id"`
// SingleSelectOption Details about the selected option (only present for single_select fields)
SingleSelectOption *struct {
// Color The color of the option
Color string `json:"color"`
// Id Unique identifier for the option.
Id int64 `json:"id"`
// Name The name of the option
Name string `json:"name"`
} `json:"single_select_option,omitempty"`
// Value The value of the issue field
Value *IssueFieldValue_Value `json:"value"`
}
IssueFieldValue A value assigned to an issue field
type IssueFieldValueDataType ¶
type IssueFieldValueDataType string
IssueFieldValueDataType The data type of the issue field
const ( Date IssueFieldValueDataType = "date" MultiSelect IssueFieldValueDataType = "multi_select" Number IssueFieldValueDataType = "number" SingleSelect IssueFieldValueDataType = "single_select" Text IssueFieldValueDataType = "text" )
Defines values for IssueFieldValueDataType.
func (IssueFieldValueDataType) Valid ¶
func (e IssueFieldValueDataType) Valid() bool
Valid indicates whether the value is a known member of the IssueFieldValueDataType enum.
type IssueFieldValueValue0 ¶
type IssueFieldValueValue0 = string
IssueFieldValueValue0 defines model for IssueFieldValue.Value.0.
type IssueFieldValueValue1 ¶
type IssueFieldValueValue1 = float32
IssueFieldValueValue1 defines model for IssueFieldValue.Value.1.
type IssueFieldValueValue2 ¶
type IssueFieldValueValue2 = int
IssueFieldValueValue2 defines model for IssueFieldValue.Value.2.
type IssueFieldValue_Value ¶
type IssueFieldValue_Value struct {
// contains filtered or unexported fields
}
IssueFieldValue_Value The value of the issue field
func (IssueFieldValue_Value) AsIssueFieldValueValue0 ¶
func (t IssueFieldValue_Value) AsIssueFieldValueValue0() (IssueFieldValueValue0, error)
AsIssueFieldValueValue0 returns the union data inside the IssueFieldValue_Value as a IssueFieldValueValue0
func (IssueFieldValue_Value) AsIssueFieldValueValue1 ¶
func (t IssueFieldValue_Value) AsIssueFieldValueValue1() (IssueFieldValueValue1, error)
AsIssueFieldValueValue1 returns the union data inside the IssueFieldValue_Value as a IssueFieldValueValue1
func (IssueFieldValue_Value) AsIssueFieldValueValue2 ¶
func (t IssueFieldValue_Value) AsIssueFieldValueValue2() (IssueFieldValueValue2, error)
AsIssueFieldValueValue2 returns the union data inside the IssueFieldValue_Value as a IssueFieldValueValue2
func (*IssueFieldValue_Value) FromIssueFieldValueValue0 ¶
func (t *IssueFieldValue_Value) FromIssueFieldValueValue0(v IssueFieldValueValue0) error
FromIssueFieldValueValue0 overwrites any union data inside the IssueFieldValue_Value as the provided IssueFieldValueValue0
func (*IssueFieldValue_Value) FromIssueFieldValueValue1 ¶
func (t *IssueFieldValue_Value) FromIssueFieldValueValue1(v IssueFieldValueValue1) error
FromIssueFieldValueValue1 overwrites any union data inside the IssueFieldValue_Value as the provided IssueFieldValueValue1
func (*IssueFieldValue_Value) FromIssueFieldValueValue2 ¶
func (t *IssueFieldValue_Value) FromIssueFieldValueValue2(v IssueFieldValueValue2) error
FromIssueFieldValueValue2 overwrites any union data inside the IssueFieldValue_Value as the provided IssueFieldValueValue2
func (IssueFieldValue_Value) MarshalJSON ¶
func (t IssueFieldValue_Value) MarshalJSON() ([]byte, error)
func (*IssueFieldValue_Value) MergeIssueFieldValueValue0 ¶
func (t *IssueFieldValue_Value) MergeIssueFieldValueValue0(v IssueFieldValueValue0) error
MergeIssueFieldValueValue0 performs a merge with any union data inside the IssueFieldValue_Value, using the provided IssueFieldValueValue0
func (*IssueFieldValue_Value) MergeIssueFieldValueValue1 ¶
func (t *IssueFieldValue_Value) MergeIssueFieldValueValue1(v IssueFieldValueValue1) error
MergeIssueFieldValueValue1 performs a merge with any union data inside the IssueFieldValue_Value, using the provided IssueFieldValueValue1
func (*IssueFieldValue_Value) MergeIssueFieldValueValue2 ¶
func (t *IssueFieldValue_Value) MergeIssueFieldValueValue2(v IssueFieldValueValue2) error
MergeIssueFieldValueValue2 performs a merge with any union data inside the IssueFieldValue_Value, using the provided IssueFieldValueValue2
func (*IssueFieldValue_Value) UnmarshalJSON ¶
func (t *IssueFieldValue_Value) UnmarshalJSON(b []byte) error
type IssueLabels1 ¶
type IssueLabels1 struct {
// ArchivedBy The user who archived the label, or `null` if it has not been archived.
ArchivedBy *SimpleUser `json:"archived_by,omitempty"`
Color *string `json:"color,omitempty"`
Default *bool `json:"default,omitempty"`
Description *string `json:"description,omitempty"`
Id *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
NodeId *string `json:"node_id,omitempty"`
Url *string `json:"url,omitempty"`
}
IssueLabels1 defines model for Issue.Labels.1.
type IssueStateReason ¶
type IssueStateReason string
IssueStateReason The reason for the current state
const ( IssueStateReasonCompleted IssueStateReason = "completed" IssueStateReasonDuplicate IssueStateReason = "duplicate" IssueStateReasonNotPlanned IssueStateReason = "not_planned" IssueStateReasonReopened IssueStateReason = "reopened" )
Defines values for IssueStateReason.
func (IssueStateReason) Valid ¶
func (e IssueStateReason) Valid() bool
Valid indicates whether the value is a known member of the IssueStateReason enum.
type IssueType ¶
type IssueType struct {
// Color The color of the issue type.
Color *IssueTypeColor `json:"color,omitempty"`
// CreatedAt The time the issue type created.
CreatedAt *time.Time `json:"created_at,omitempty"`
// Description The description of the issue type.
Description *string `json:"description"`
// Id The unique identifier of the issue type.
Id int `json:"id"`
// IsEnabled The enabled state of the issue type.
IsEnabled *bool `json:"is_enabled,omitempty"`
// Name The name of the issue type.
Name string `json:"name"`
// NodeId The node identifier of the issue type.
NodeId string `json:"node_id"`
// UpdatedAt The time the issue type last updated.
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
IssueType The type assigned to the issue. This is only present for issues in repositories where issue types are supported.
type IssueTypeColor ¶
type IssueTypeColor string
IssueTypeColor The color of the issue type.
const ( Blue IssueTypeColor = "blue" Gray IssueTypeColor = "gray" Green IssueTypeColor = "green" Orange IssueTypeColor = "orange" Pink IssueTypeColor = "pink" Purple IssueTypeColor = "purple" Red IssueTypeColor = "red" Yellow IssueTypeColor = "yellow" )
Defines values for IssueTypeColor.
func (IssueTypeColor) Valid ¶
func (e IssueTypeColor) Valid() bool
Valid indicates whether the value is a known member of the IssueTypeColor enum.
type Issue_Labels_Item ¶
type Issue_Labels_Item struct {
// contains filtered or unexported fields
}
Issue_Labels_Item defines model for issue.labels.Item.
func (Issue_Labels_Item) AsIssueLabels0 ¶
func (t Issue_Labels_Item) AsIssueLabels0() (IssueLabels0, error)
AsIssueLabels0 returns the union data inside the Issue_Labels_Item as a IssueLabels0
func (Issue_Labels_Item) AsIssueLabels1 ¶
func (t Issue_Labels_Item) AsIssueLabels1() (IssueLabels1, error)
AsIssueLabels1 returns the union data inside the Issue_Labels_Item as a IssueLabels1
func (*Issue_Labels_Item) FromIssueLabels0 ¶
func (t *Issue_Labels_Item) FromIssueLabels0(v IssueLabels0) error
FromIssueLabels0 overwrites any union data inside the Issue_Labels_Item as the provided IssueLabels0
func (*Issue_Labels_Item) FromIssueLabels1 ¶
func (t *Issue_Labels_Item) FromIssueLabels1(v IssueLabels1) error
FromIssueLabels1 overwrites any union data inside the Issue_Labels_Item as the provided IssueLabels1
func (Issue_Labels_Item) MarshalJSON ¶
func (t Issue_Labels_Item) MarshalJSON() ([]byte, error)
func (*Issue_Labels_Item) MergeIssueLabels0 ¶
func (t *Issue_Labels_Item) MergeIssueLabels0(v IssueLabels0) error
MergeIssueLabels0 performs a merge with any union data inside the Issue_Labels_Item, using the provided IssueLabels0
func (*Issue_Labels_Item) MergeIssueLabels1 ¶
func (t *Issue_Labels_Item) MergeIssueLabels1(v IssueLabels1) error
MergeIssueLabels1 performs a merge with any union data inside the Issue_Labels_Item, using the provided IssueLabels1
func (*Issue_Labels_Item) UnmarshalJSON ¶
func (t *Issue_Labels_Item) UnmarshalJSON(b []byte) error
type IssuesListCommentsResult ¶
type IssuesListCommentsResult = []IssueComment
IssuesListCommentsResult defines model for issues-list-comments-result.
type IssuesListForRepoResult ¶
type IssuesListForRepoResult = []Issue
IssuesListForRepoResult defines model for issues-list-for-repo-result.
type IssuesUpdateResult ¶
type IssuesUpdateResult struct {
ActiveLockReason *string `json:"active_lock_reason,omitempty"`
Assignees *[]SimpleUser `json:"assignees,omitempty"`
// AuthorAssociation How the author is associated with the repository.
AuthorAssociation *AuthorAssociation `json:"author_association,omitempty"`
// Body Contents of the issue
Body *string `json:"body,omitempty"`
BodyHtml *string `json:"body_html,omitempty"`
BodyText *string `json:"body_text,omitempty"`
ClosedAt *time.Time `json:"closed_at"`
// ClosedBy A GitHub user.
ClosedBy *NullableSimpleUser `json:"closed_by,omitempty"`
Comments int `json:"comments"`
CommentsUrl string `json:"comments_url"`
CreatedAt time.Time `json:"created_at"`
Draft *bool `json:"draft,omitempty"`
EventsUrl string `json:"events_url"`
HtmlUrl string `json:"html_url"`
Id int64 `json:"id"`
IssueDependenciesSummary *IssueDependenciesSummary `json:"issue_dependencies_summary,omitempty"`
IssueFieldValues *[]IssueFieldValue `json:"issue_field_values,omitempty"`
// Labels Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
Labels []IssuesUpdateResult_Labels_Item `json:"labels"`
LabelsUrl string `json:"labels_url"`
Locked bool `json:"locked"`
// Milestone A collection of related issues and pull requests.
Milestone *NullableMilestone `json:"milestone"`
NodeId string `json:"node_id"`
// Number Number uniquely identifying the issue within its repository
Number int `json:"number"`
// ParentIssueUrl URL to get the parent issue of this issue, if it is a sub-issue
ParentIssueUrl *string `json:"parent_issue_url,omitempty"`
// PerformedViaGithubApp GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
PerformedViaGithubApp *NullableIntegration `json:"performed_via_github_app,omitempty"`
// PinnedComment Comments provide a way for people to collaborate on an issue.
PinnedComment *NullableIssueComment `json:"pinned_comment,omitempty"`
PullRequest *struct {
DiffUrl string `json:"diff_url"`
HtmlUrl string `json:"html_url"`
MergedAt *time.Time `json:"merged_at,omitempty"`
PatchUrl string `json:"patch_url"`
Url string `json:"url"`
} `json:"pull_request,omitempty"`
Reactions *ReactionRollup `json:"reactions,omitempty"`
// Repository A repository on GitHub.
Repository *Repository `json:"repository,omitempty"`
RepositoryUrl string `json:"repository_url"`
// State State of the issue; either 'open' or 'closed'
State string `json:"state"`
// StateReason The reason for the current state
StateReason *IssuesUpdateResultStateReason `json:"state_reason,omitempty"`
SubIssuesSummary *SubIssuesSummary `json:"sub_issues_summary,omitempty"`
// Suggestions Pending suggestions for each suggestible field (`type`,
// `issue_field_values`, `labels`, `assignees`, `state`) the
// request touched. Omitted for fields not in the request or
// with no pending or ignored suggestions. Items tagged
// `ignored` are echoes of the current request's inputs that
// were not persisted as pending suggestions.
Suggestions *struct {
Assignees *[]struct {
Confidence *IssuesUpdateResultSuggestionsAssigneesConfidence `json:"confidence,omitempty"`
Ignored *bool `json:"ignored,omitempty"`
IgnoredReason *IssuesUpdateResultSuggestionsAssigneesIgnoredReason `json:"ignored_reason,omitempty"`
Login *string `json:"login,omitempty"`
Rationale *string `json:"rationale,omitempty"`
Suggest *bool `json:"suggest,omitempty"`
} `json:"assignees,omitempty"`
IssueFieldValues *[]struct {
Confidence *IssuesUpdateResultSuggestionsIssueFieldValuesConfidence `json:"confidence,omitempty"`
FieldId *int `json:"field_id,omitempty"`
Ignored *bool `json:"ignored,omitempty"`
IgnoredReason *IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason `json:"ignored_reason,omitempty"`
Rationale *string `json:"rationale,omitempty"`
Suggest *bool `json:"suggest,omitempty"`
Value *IssuesUpdateResult_Suggestions_IssueFieldValues_Value `json:"value,omitempty"`
} `json:"issue_field_values,omitempty"`
Labels *[]struct {
Confidence *IssuesUpdateResultSuggestionsLabelsConfidence `json:"confidence,omitempty"`
Ignored *bool `json:"ignored,omitempty"`
IgnoredReason *IssuesUpdateResultSuggestionsLabelsIgnoredReason `json:"ignored_reason,omitempty"`
Name *string `json:"name,omitempty"`
Rationale *string `json:"rationale,omitempty"`
Suggest *bool `json:"suggest,omitempty"`
} `json:"labels,omitempty"`
State *[]struct {
Confidence *IssuesUpdateResultSuggestionsStateConfidence `json:"confidence,omitempty"`
DuplicateIssueId *int `json:"duplicate_issue_id,omitempty"`
Ignored *bool `json:"ignored,omitempty"`
IgnoredReason *IssuesUpdateResultSuggestionsStateIgnoredReason `json:"ignored_reason,omitempty"`
Rationale *string `json:"rationale,omitempty"`
StateReason *string `json:"state_reason,omitempty"`
Suggest *bool `json:"suggest,omitempty"`
Value *string `json:"value,omitempty"`
} `json:"state,omitempty"`
Type *[]struct {
Confidence *IssuesUpdateResultSuggestionsTypeConfidence `json:"confidence,omitempty"`
Ignored *bool `json:"ignored,omitempty"`
IgnoredReason *IssuesUpdateResultSuggestionsTypeIgnoredReason `json:"ignored_reason,omitempty"`
Rationale *string `json:"rationale,omitempty"`
Suggest *bool `json:"suggest,omitempty"`
Value *string `json:"value,omitempty"`
} `json:"type,omitempty"`
} `json:"suggestions,omitempty"`
TimelineUrl *string `json:"timeline_url,omitempty"`
// Title Title of the issue
Title string `json:"title"`
// Type The type assigned to the issue. This is only present for issues in repositories where issue types are supported.
Type *IssueType `json:"type,omitempty"`
UpdatedAt time.Time `json:"updated_at"`
// Url URL for the issue
Url string `json:"url"`
// User A GitHub user.
User *NullableSimpleUser `json:"user"`
}
IssuesUpdateResult defines model for issues-update-result.
type IssuesUpdateResultLabels0 ¶
type IssuesUpdateResultLabels0 = string
IssuesUpdateResultLabels0 defines model for IssuesUpdateResult.Labels.0.
type IssuesUpdateResultLabels1 ¶
type IssuesUpdateResultLabels1 struct {
// ArchivedBy The user who archived the label, or `null` if it has not been archived.
ArchivedBy *SimpleUser `json:"archived_by,omitempty"`
Color *string `json:"color,omitempty"`
Default *bool `json:"default,omitempty"`
Description *string `json:"description,omitempty"`
Id *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
NodeId *string `json:"node_id,omitempty"`
Url *string `json:"url,omitempty"`
}
IssuesUpdateResultLabels1 defines model for IssuesUpdateResult.Labels.1.
type IssuesUpdateResultStateReason ¶
type IssuesUpdateResultStateReason string
IssuesUpdateResultStateReason The reason for the current state
const ( IssuesUpdateResultStateReasonCompleted IssuesUpdateResultStateReason = "completed" IssuesUpdateResultStateReasonDuplicate IssuesUpdateResultStateReason = "duplicate" IssuesUpdateResultStateReasonNotPlanned IssuesUpdateResultStateReason = "not_planned" IssuesUpdateResultStateReasonReopened IssuesUpdateResultStateReason = "reopened" )
Defines values for IssuesUpdateResultStateReason.
func (IssuesUpdateResultStateReason) Valid ¶
func (e IssuesUpdateResultStateReason) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultStateReason enum.
type IssuesUpdateResultSuggestionsAssigneesConfidence ¶
type IssuesUpdateResultSuggestionsAssigneesConfidence string
IssuesUpdateResultSuggestionsAssigneesConfidence defines model for IssuesUpdateResult.Suggestions.Assignees.Confidence.
const ( IssuesUpdateResultSuggestionsAssigneesConfidenceHigh IssuesUpdateResultSuggestionsAssigneesConfidence = "high" IssuesUpdateResultSuggestionsAssigneesConfidenceLow IssuesUpdateResultSuggestionsAssigneesConfidence = "low" IssuesUpdateResultSuggestionsAssigneesConfidenceMedium IssuesUpdateResultSuggestionsAssigneesConfidence = "medium" )
Defines values for IssuesUpdateResultSuggestionsAssigneesConfidence.
func (IssuesUpdateResultSuggestionsAssigneesConfidence) Valid ¶
func (e IssuesUpdateResultSuggestionsAssigneesConfidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsAssigneesConfidence enum.
type IssuesUpdateResultSuggestionsAssigneesIgnoredReason ¶
type IssuesUpdateResultSuggestionsAssigneesIgnoredReason string
IssuesUpdateResultSuggestionsAssigneesIgnoredReason defines model for IssuesUpdateResult.Suggestions.Assignees.IgnoredReason.
const ( IssuesUpdateResultSuggestionsAssigneesIgnoredReasonAlreadyApplied IssuesUpdateResultSuggestionsAssigneesIgnoredReason = "already_applied" IssuesUpdateResultSuggestionsAssigneesIgnoredReasonIssueAlreadyClosed IssuesUpdateResultSuggestionsAssigneesIgnoredReason = "issue_already_closed" )
Defines values for IssuesUpdateResultSuggestionsAssigneesIgnoredReason.
func (IssuesUpdateResultSuggestionsAssigneesIgnoredReason) Valid ¶
func (e IssuesUpdateResultSuggestionsAssigneesIgnoredReason) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsAssigneesIgnoredReason enum.
type IssuesUpdateResultSuggestionsIssueFieldValuesConfidence ¶
type IssuesUpdateResultSuggestionsIssueFieldValuesConfidence string
IssuesUpdateResultSuggestionsIssueFieldValuesConfidence defines model for IssuesUpdateResult.Suggestions.IssueFieldValues.Confidence.
const ( IssuesUpdateResultSuggestionsIssueFieldValuesConfidenceHigh IssuesUpdateResultSuggestionsIssueFieldValuesConfidence = "high" IssuesUpdateResultSuggestionsIssueFieldValuesConfidenceLow IssuesUpdateResultSuggestionsIssueFieldValuesConfidence = "low" IssuesUpdateResultSuggestionsIssueFieldValuesConfidenceMedium IssuesUpdateResultSuggestionsIssueFieldValuesConfidence = "medium" )
Defines values for IssuesUpdateResultSuggestionsIssueFieldValuesConfidence.
func (IssuesUpdateResultSuggestionsIssueFieldValuesConfidence) Valid ¶
func (e IssuesUpdateResultSuggestionsIssueFieldValuesConfidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsIssueFieldValuesConfidence enum.
type IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason ¶
type IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason string
IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason defines model for IssuesUpdateResult.Suggestions.IssueFieldValues.IgnoredReason.
const ( IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReasonAlreadyApplied IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason = "already_applied" IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReasonIssueAlreadyClosed IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason = "issue_already_closed" )
Defines values for IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason.
func (IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason) Valid ¶
func (e IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsIssueFieldValuesIgnoredReason enum.
type IssuesUpdateResultSuggestionsIssueFieldValuesValue0 ¶
type IssuesUpdateResultSuggestionsIssueFieldValuesValue0 = string
IssuesUpdateResultSuggestionsIssueFieldValuesValue0 defines model for IssuesUpdateResult.Suggestions.IssueFieldValues.Value.0.
type IssuesUpdateResultSuggestionsIssueFieldValuesValue1 ¶
type IssuesUpdateResultSuggestionsIssueFieldValuesValue1 = float32
IssuesUpdateResultSuggestionsIssueFieldValuesValue1 defines model for IssuesUpdateResult.Suggestions.IssueFieldValues.Value.1.
type IssuesUpdateResultSuggestionsIssueFieldValuesValue2 ¶
type IssuesUpdateResultSuggestionsIssueFieldValuesValue2 = []string
IssuesUpdateResultSuggestionsIssueFieldValuesValue2 defines model for IssuesUpdateResult.Suggestions.IssueFieldValues.Value.2.
type IssuesUpdateResultSuggestionsLabelsConfidence ¶
type IssuesUpdateResultSuggestionsLabelsConfidence string
IssuesUpdateResultSuggestionsLabelsConfidence defines model for IssuesUpdateResult.Suggestions.Labels.Confidence.
const ( IssuesUpdateResultSuggestionsLabelsConfidenceHigh IssuesUpdateResultSuggestionsLabelsConfidence = "high" IssuesUpdateResultSuggestionsLabelsConfidenceLow IssuesUpdateResultSuggestionsLabelsConfidence = "low" IssuesUpdateResultSuggestionsLabelsConfidenceMedium IssuesUpdateResultSuggestionsLabelsConfidence = "medium" )
Defines values for IssuesUpdateResultSuggestionsLabelsConfidence.
func (IssuesUpdateResultSuggestionsLabelsConfidence) Valid ¶
func (e IssuesUpdateResultSuggestionsLabelsConfidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsLabelsConfidence enum.
type IssuesUpdateResultSuggestionsLabelsIgnoredReason ¶
type IssuesUpdateResultSuggestionsLabelsIgnoredReason string
IssuesUpdateResultSuggestionsLabelsIgnoredReason defines model for IssuesUpdateResult.Suggestions.Labels.IgnoredReason.
const ( IssuesUpdateResultSuggestionsLabelsIgnoredReasonAlreadyApplied IssuesUpdateResultSuggestionsLabelsIgnoredReason = "already_applied" IssuesUpdateResultSuggestionsLabelsIgnoredReasonIssueAlreadyClosed IssuesUpdateResultSuggestionsLabelsIgnoredReason = "issue_already_closed" )
Defines values for IssuesUpdateResultSuggestionsLabelsIgnoredReason.
func (IssuesUpdateResultSuggestionsLabelsIgnoredReason) Valid ¶
func (e IssuesUpdateResultSuggestionsLabelsIgnoredReason) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsLabelsIgnoredReason enum.
type IssuesUpdateResultSuggestionsStateConfidence ¶
type IssuesUpdateResultSuggestionsStateConfidence string
IssuesUpdateResultSuggestionsStateConfidence defines model for IssuesUpdateResult.Suggestions.State.Confidence.
const ( IssuesUpdateResultSuggestionsStateConfidenceHigh IssuesUpdateResultSuggestionsStateConfidence = "high" IssuesUpdateResultSuggestionsStateConfidenceLow IssuesUpdateResultSuggestionsStateConfidence = "low" IssuesUpdateResultSuggestionsStateConfidenceMedium IssuesUpdateResultSuggestionsStateConfidence = "medium" )
Defines values for IssuesUpdateResultSuggestionsStateConfidence.
func (IssuesUpdateResultSuggestionsStateConfidence) Valid ¶
func (e IssuesUpdateResultSuggestionsStateConfidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsStateConfidence enum.
type IssuesUpdateResultSuggestionsStateIgnoredReason ¶
type IssuesUpdateResultSuggestionsStateIgnoredReason string
IssuesUpdateResultSuggestionsStateIgnoredReason defines model for IssuesUpdateResult.Suggestions.State.IgnoredReason.
const ( IssuesUpdateResultSuggestionsStateIgnoredReasonAlreadyApplied IssuesUpdateResultSuggestionsStateIgnoredReason = "already_applied" IssuesUpdateResultSuggestionsStateIgnoredReasonIssueAlreadyClosed IssuesUpdateResultSuggestionsStateIgnoredReason = "issue_already_closed" )
Defines values for IssuesUpdateResultSuggestionsStateIgnoredReason.
func (IssuesUpdateResultSuggestionsStateIgnoredReason) Valid ¶
func (e IssuesUpdateResultSuggestionsStateIgnoredReason) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsStateIgnoredReason enum.
type IssuesUpdateResultSuggestionsTypeConfidence ¶
type IssuesUpdateResultSuggestionsTypeConfidence string
IssuesUpdateResultSuggestionsTypeConfidence defines model for IssuesUpdateResult.Suggestions.Type.Confidence.
const ( IssuesUpdateResultSuggestionsTypeConfidenceHigh IssuesUpdateResultSuggestionsTypeConfidence = "high" IssuesUpdateResultSuggestionsTypeConfidenceLow IssuesUpdateResultSuggestionsTypeConfidence = "low" IssuesUpdateResultSuggestionsTypeConfidenceMedium IssuesUpdateResultSuggestionsTypeConfidence = "medium" )
Defines values for IssuesUpdateResultSuggestionsTypeConfidence.
func (IssuesUpdateResultSuggestionsTypeConfidence) Valid ¶
func (e IssuesUpdateResultSuggestionsTypeConfidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsTypeConfidence enum.
type IssuesUpdateResultSuggestionsTypeIgnoredReason ¶
type IssuesUpdateResultSuggestionsTypeIgnoredReason string
IssuesUpdateResultSuggestionsTypeIgnoredReason defines model for IssuesUpdateResult.Suggestions.Type.IgnoredReason.
const ( IssuesUpdateResultSuggestionsTypeIgnoredReasonAlreadyApplied IssuesUpdateResultSuggestionsTypeIgnoredReason = "already_applied" IssuesUpdateResultSuggestionsTypeIgnoredReasonIssueAlreadyClosed IssuesUpdateResultSuggestionsTypeIgnoredReason = "issue_already_closed" )
Defines values for IssuesUpdateResultSuggestionsTypeIgnoredReason.
func (IssuesUpdateResultSuggestionsTypeIgnoredReason) Valid ¶
func (e IssuesUpdateResultSuggestionsTypeIgnoredReason) Valid() bool
Valid indicates whether the value is a known member of the IssuesUpdateResultSuggestionsTypeIgnoredReason enum.
type IssuesUpdateResult_Labels_Item ¶
type IssuesUpdateResult_Labels_Item struct {
// contains filtered or unexported fields
}
IssuesUpdateResult_Labels_Item defines model for issues-update-result.labels.Item.
func (IssuesUpdateResult_Labels_Item) AsIssuesUpdateResultLabels0 ¶
func (t IssuesUpdateResult_Labels_Item) AsIssuesUpdateResultLabels0() (IssuesUpdateResultLabels0, error)
AsIssuesUpdateResultLabels0 returns the union data inside the IssuesUpdateResult_Labels_Item as a IssuesUpdateResultLabels0
func (IssuesUpdateResult_Labels_Item) AsIssuesUpdateResultLabels1 ¶
func (t IssuesUpdateResult_Labels_Item) AsIssuesUpdateResultLabels1() (IssuesUpdateResultLabels1, error)
AsIssuesUpdateResultLabels1 returns the union data inside the IssuesUpdateResult_Labels_Item as a IssuesUpdateResultLabels1
func (*IssuesUpdateResult_Labels_Item) FromIssuesUpdateResultLabels0 ¶
func (t *IssuesUpdateResult_Labels_Item) FromIssuesUpdateResultLabels0(v IssuesUpdateResultLabels0) error
FromIssuesUpdateResultLabels0 overwrites any union data inside the IssuesUpdateResult_Labels_Item as the provided IssuesUpdateResultLabels0
func (*IssuesUpdateResult_Labels_Item) FromIssuesUpdateResultLabels1 ¶
func (t *IssuesUpdateResult_Labels_Item) FromIssuesUpdateResultLabels1(v IssuesUpdateResultLabels1) error
FromIssuesUpdateResultLabels1 overwrites any union data inside the IssuesUpdateResult_Labels_Item as the provided IssuesUpdateResultLabels1
func (IssuesUpdateResult_Labels_Item) MarshalJSON ¶
func (t IssuesUpdateResult_Labels_Item) MarshalJSON() ([]byte, error)
func (*IssuesUpdateResult_Labels_Item) MergeIssuesUpdateResultLabels0 ¶
func (t *IssuesUpdateResult_Labels_Item) MergeIssuesUpdateResultLabels0(v IssuesUpdateResultLabels0) error
MergeIssuesUpdateResultLabels0 performs a merge with any union data inside the IssuesUpdateResult_Labels_Item, using the provided IssuesUpdateResultLabels0
func (*IssuesUpdateResult_Labels_Item) MergeIssuesUpdateResultLabels1 ¶
func (t *IssuesUpdateResult_Labels_Item) MergeIssuesUpdateResultLabels1(v IssuesUpdateResultLabels1) error
MergeIssuesUpdateResultLabels1 performs a merge with any union data inside the IssuesUpdateResult_Labels_Item, using the provided IssuesUpdateResultLabels1
func (*IssuesUpdateResult_Labels_Item) UnmarshalJSON ¶
func (t *IssuesUpdateResult_Labels_Item) UnmarshalJSON(b []byte) error
type IssuesUpdateResult_Suggestions_IssueFieldValues_Value ¶
type IssuesUpdateResult_Suggestions_IssueFieldValues_Value struct {
// contains filtered or unexported fields
}
IssuesUpdateResult_Suggestions_IssueFieldValues_Value defines model for IssuesUpdateResult.Suggestions.IssueFieldValues.Value.
func (IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue0 ¶
func (t IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue0() (IssuesUpdateResultSuggestionsIssueFieldValuesValue0, error)
AsIssuesUpdateResultSuggestionsIssueFieldValuesValue0 returns the union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value as a IssuesUpdateResultSuggestionsIssueFieldValuesValue0
func (IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue1 ¶
func (t IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue1() (IssuesUpdateResultSuggestionsIssueFieldValuesValue1, error)
AsIssuesUpdateResultSuggestionsIssueFieldValuesValue1 returns the union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value as a IssuesUpdateResultSuggestionsIssueFieldValuesValue1
func (IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue2 ¶
func (t IssuesUpdateResult_Suggestions_IssueFieldValues_Value) AsIssuesUpdateResultSuggestionsIssueFieldValuesValue2() (IssuesUpdateResultSuggestionsIssueFieldValuesValue2, error)
AsIssuesUpdateResultSuggestionsIssueFieldValuesValue2 returns the union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value as a IssuesUpdateResultSuggestionsIssueFieldValuesValue2
func (*IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue0 ¶
func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue0(v IssuesUpdateResultSuggestionsIssueFieldValuesValue0) error
FromIssuesUpdateResultSuggestionsIssueFieldValuesValue0 overwrites any union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value as the provided IssuesUpdateResultSuggestionsIssueFieldValuesValue0
func (*IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue1 ¶
func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue1(v IssuesUpdateResultSuggestionsIssueFieldValuesValue1) error
FromIssuesUpdateResultSuggestionsIssueFieldValuesValue1 overwrites any union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value as the provided IssuesUpdateResultSuggestionsIssueFieldValuesValue1
func (*IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue2 ¶
func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) FromIssuesUpdateResultSuggestionsIssueFieldValuesValue2(v IssuesUpdateResultSuggestionsIssueFieldValuesValue2) error
FromIssuesUpdateResultSuggestionsIssueFieldValuesValue2 overwrites any union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value as the provided IssuesUpdateResultSuggestionsIssueFieldValuesValue2
func (IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MarshalJSON ¶
func (t IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MarshalJSON() ([]byte, error)
func (*IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue0 ¶
func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue0(v IssuesUpdateResultSuggestionsIssueFieldValuesValue0) error
MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue0 performs a merge with any union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value, using the provided IssuesUpdateResultSuggestionsIssueFieldValuesValue0
func (*IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue1 ¶
func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue1(v IssuesUpdateResultSuggestionsIssueFieldValuesValue1) error
MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue1 performs a merge with any union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value, using the provided IssuesUpdateResultSuggestionsIssueFieldValuesValue1
func (*IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue2 ¶
func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue2(v IssuesUpdateResultSuggestionsIssueFieldValuesValue2) error
MergeIssuesUpdateResultSuggestionsIssueFieldValuesValue2 performs a merge with any union data inside the IssuesUpdateResult_Suggestions_IssueFieldValues_Value, using the provided IssuesUpdateResultSuggestionsIssueFieldValuesValue2
func (*IssuesUpdateResult_Suggestions_IssueFieldValues_Value) UnmarshalJSON ¶
func (t *IssuesUpdateResult_Suggestions_IssueFieldValues_Value) UnmarshalJSON(b []byte) error
type IssuesaddBlockedByDependencyJSONBody ¶
type IssuesaddBlockedByDependencyJSONBody struct {
// IssueId The id of the issue that blocks the current issue
IssueId int `json:"issue_id"`
}
IssuesaddBlockedByDependencyJSONBody defines parameters for IssuesaddBlockedByDependency.
type IssuesaddBlockedByDependencyJSONRequestBody ¶
type IssuesaddBlockedByDependencyJSONRequestBody IssuesaddBlockedByDependencyJSONBody
IssuesaddBlockedByDependencyJSONRequestBody defines body for IssuesaddBlockedByDependency for application/json ContentType.
type IssuesaddBlockedByDependencyResponse ¶
type IssuesaddBlockedByDependencyResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *Issue
// Headers201 the parsed response headers for an HTTP 201 response
Headers201 *IssuesaddBlockedByDependencyResponse201Headers
}
func ParseIssuesaddBlockedByDependencyResponse ¶
func ParseIssuesaddBlockedByDependencyResponse(rsp *http.Response) (*IssuesaddBlockedByDependencyResponse, error)
ParseIssuesaddBlockedByDependencyResponse parses an HTTP response from a IssuesaddBlockedByDependencyWithResponse call
func (IssuesaddBlockedByDependencyResponse) ContentType ¶
func (r IssuesaddBlockedByDependencyResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (IssuesaddBlockedByDependencyResponse) GetBody ¶
func (r IssuesaddBlockedByDependencyResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (IssuesaddBlockedByDependencyResponse) GetJSON201 ¶
func (r IssuesaddBlockedByDependencyResponse) GetJSON201() *Issue
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (IssuesaddBlockedByDependencyResponse) Status ¶
func (r IssuesaddBlockedByDependencyResponse) Status() string
Status returns HTTPResponse.Status
func (IssuesaddBlockedByDependencyResponse) StatusCode ¶
func (r IssuesaddBlockedByDependencyResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type IssuesaddBlockedByDependencyResponse201Headers ¶
type IssuesaddBlockedByDependencyResponse201Headers struct {
Location *string
}
IssuesaddBlockedByDependencyResponse201Headers the declared response headers of an HTTP 201 response for IssuesaddBlockedByDependency
type IssuescreateCommentJSONBody ¶
type IssuescreateCommentJSONBody struct {
// Body The contents of the comment.
Body string `json:"body"`
}
IssuescreateCommentJSONBody defines parameters for IssuescreateComment.
type IssuescreateCommentJSONRequestBody ¶
type IssuescreateCommentJSONRequestBody IssuescreateCommentJSONBody
IssuescreateCommentJSONRequestBody defines body for IssuescreateComment for application/json ContentType.
type IssuescreateCommentResponse ¶
type IssuescreateCommentResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *IssueComment
// Headers201 the parsed response headers for an HTTP 201 response
Headers201 *IssuescreateCommentResponse201Headers
}
func ParseIssuescreateCommentResponse ¶
func ParseIssuescreateCommentResponse(rsp *http.Response) (*IssuescreateCommentResponse, error)
ParseIssuescreateCommentResponse parses an HTTP response from a IssuescreateCommentWithResponse call
func (IssuescreateCommentResponse) ContentType ¶
func (r IssuescreateCommentResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (IssuescreateCommentResponse) GetBody ¶
func (r IssuescreateCommentResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (IssuescreateCommentResponse) GetJSON201 ¶
func (r IssuescreateCommentResponse) GetJSON201() *IssueComment
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (IssuescreateCommentResponse) Status ¶
func (r IssuescreateCommentResponse) Status() string
Status returns HTTPResponse.Status
func (IssuescreateCommentResponse) StatusCode ¶
func (r IssuescreateCommentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type IssuescreateCommentResponse201Headers ¶
type IssuescreateCommentResponse201Headers struct {
Location *string
}
IssuescreateCommentResponse201Headers the declared response headers of an HTTP 201 response for IssuescreateComment
type IssuescreateJSONBody ¶
type IssuescreateJSONBody struct {
// Assignees Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._
Assignees *[]string `json:"assignees,omitempty"`
// Body The contents of the issue.
Body *string `json:"body,omitempty"`
// IssueFieldValues An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
IssueFieldValues *[]struct {
// FieldId The ID of the issue field to set
FieldId int `json:"field_id"`
// Value The value to set for the field. For multi-select fields, provide an array of option names.
Value IssuescreateJSONBody_IssueFieldValues_Value `json:"value"`
} `json:"issue_field_values,omitempty"`
// Labels Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._
Labels *[]IssuescreateJSONBody_Labels_Item `json:"labels,omitempty"`
Milestone *IssuescreateJSONBody_Milestone `json:"milestone,omitempty"`
// ParentIssueId The id of the parent issue to add this issue to as a sub-issue. _NOTE: Only users with triage access to both the parent issue's repository and this repository can set the parent issue._
ParentIssueId *int `json:"parent_issue_id,omitempty"`
// Title The title of the issue.
Title IssuescreateJSONBody_Title `json:"title"`
// Type The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._
Type *string `json:"type,omitempty"`
}
IssuescreateJSONBody defines parameters for Issuescreate.
type IssuescreateJSONBodyIssueFieldValuesValue0 ¶
type IssuescreateJSONBodyIssueFieldValuesValue0 = string
IssuescreateJSONBodyIssueFieldValuesValue0 defines parameters for Issuescreate.
type IssuescreateJSONBodyIssueFieldValuesValue1 ¶
type IssuescreateJSONBodyIssueFieldValuesValue1 = float32
IssuescreateJSONBodyIssueFieldValuesValue1 defines parameters for Issuescreate.
type IssuescreateJSONBodyIssueFieldValuesValue2 ¶
type IssuescreateJSONBodyIssueFieldValuesValue2 = []string
IssuescreateJSONBodyIssueFieldValuesValue2 defines parameters for Issuescreate.
type IssuescreateJSONBodyLabels0 ¶
type IssuescreateJSONBodyLabels0 = string
IssuescreateJSONBodyLabels0 defines parameters for Issuescreate.
type IssuescreateJSONBodyLabels1 ¶
type IssuescreateJSONBodyLabels1 struct {
Color *string `json:"color,omitempty"`
Description *string `json:"description,omitempty"`
Id *int `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
}
IssuescreateJSONBodyLabels1 defines parameters for Issuescreate.
type IssuescreateJSONBodyMilestone0 ¶
type IssuescreateJSONBodyMilestone0 = string
IssuescreateJSONBodyMilestone0 defines parameters for Issuescreate.
type IssuescreateJSONBodyMilestone1 ¶
type IssuescreateJSONBodyMilestone1 = int
IssuescreateJSONBodyMilestone1 defines parameters for Issuescreate.
type IssuescreateJSONBodyTitle0 ¶
type IssuescreateJSONBodyTitle0 = string
IssuescreateJSONBodyTitle0 defines parameters for Issuescreate.
type IssuescreateJSONBodyTitle1 ¶
type IssuescreateJSONBodyTitle1 = int
IssuescreateJSONBodyTitle1 defines parameters for Issuescreate.
type IssuescreateJSONBody_IssueFieldValues_Value ¶
type IssuescreateJSONBody_IssueFieldValues_Value struct {
// contains filtered or unexported fields
}
IssuescreateJSONBody_IssueFieldValues_Value defines parameters for Issuescreate.
func (IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue0 ¶
func (t IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue0() (IssuescreateJSONBodyIssueFieldValuesValue0, error)
AsIssuescreateJSONBodyIssueFieldValuesValue0 returns the union data inside the IssuescreateJSONBody_IssueFieldValues_Value as a IssuescreateJSONBodyIssueFieldValuesValue0
func (IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue1 ¶
func (t IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue1() (IssuescreateJSONBodyIssueFieldValuesValue1, error)
AsIssuescreateJSONBodyIssueFieldValuesValue1 returns the union data inside the IssuescreateJSONBody_IssueFieldValues_Value as a IssuescreateJSONBodyIssueFieldValuesValue1
func (IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue2 ¶
func (t IssuescreateJSONBody_IssueFieldValues_Value) AsIssuescreateJSONBodyIssueFieldValuesValue2() (IssuescreateJSONBodyIssueFieldValuesValue2, error)
AsIssuescreateJSONBodyIssueFieldValuesValue2 returns the union data inside the IssuescreateJSONBody_IssueFieldValues_Value as a IssuescreateJSONBodyIssueFieldValuesValue2
func (*IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue0 ¶
func (t *IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue0(v IssuescreateJSONBodyIssueFieldValuesValue0) error
FromIssuescreateJSONBodyIssueFieldValuesValue0 overwrites any union data inside the IssuescreateJSONBody_IssueFieldValues_Value as the provided IssuescreateJSONBodyIssueFieldValuesValue0
func (*IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue1 ¶
func (t *IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue1(v IssuescreateJSONBodyIssueFieldValuesValue1) error
FromIssuescreateJSONBodyIssueFieldValuesValue1 overwrites any union data inside the IssuescreateJSONBody_IssueFieldValues_Value as the provided IssuescreateJSONBodyIssueFieldValuesValue1
func (*IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue2 ¶
func (t *IssuescreateJSONBody_IssueFieldValues_Value) FromIssuescreateJSONBodyIssueFieldValuesValue2(v IssuescreateJSONBodyIssueFieldValuesValue2) error
FromIssuescreateJSONBodyIssueFieldValuesValue2 overwrites any union data inside the IssuescreateJSONBody_IssueFieldValues_Value as the provided IssuescreateJSONBodyIssueFieldValuesValue2
func (IssuescreateJSONBody_IssueFieldValues_Value) MarshalJSON ¶
func (t IssuescreateJSONBody_IssueFieldValues_Value) MarshalJSON() ([]byte, error)
func (*IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue0 ¶
func (t *IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue0(v IssuescreateJSONBodyIssueFieldValuesValue0) error
MergeIssuescreateJSONBodyIssueFieldValuesValue0 performs a merge with any union data inside the IssuescreateJSONBody_IssueFieldValues_Value, using the provided IssuescreateJSONBodyIssueFieldValuesValue0
func (*IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue1 ¶
func (t *IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue1(v IssuescreateJSONBodyIssueFieldValuesValue1) error
MergeIssuescreateJSONBodyIssueFieldValuesValue1 performs a merge with any union data inside the IssuescreateJSONBody_IssueFieldValues_Value, using the provided IssuescreateJSONBodyIssueFieldValuesValue1
func (*IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue2 ¶
func (t *IssuescreateJSONBody_IssueFieldValues_Value) MergeIssuescreateJSONBodyIssueFieldValuesValue2(v IssuescreateJSONBodyIssueFieldValuesValue2) error
MergeIssuescreateJSONBodyIssueFieldValuesValue2 performs a merge with any union data inside the IssuescreateJSONBody_IssueFieldValues_Value, using the provided IssuescreateJSONBodyIssueFieldValuesValue2
func (*IssuescreateJSONBody_IssueFieldValues_Value) UnmarshalJSON ¶
func (t *IssuescreateJSONBody_IssueFieldValues_Value) UnmarshalJSON(b []byte) error
type IssuescreateJSONBody_Labels_Item ¶
type IssuescreateJSONBody_Labels_Item struct {
// contains filtered or unexported fields
}
IssuescreateJSONBody_Labels_Item defines parameters for Issuescreate.
func (IssuescreateJSONBody_Labels_Item) AsIssuescreateJSONBodyLabels0 ¶
func (t IssuescreateJSONBody_Labels_Item) AsIssuescreateJSONBodyLabels0() (IssuescreateJSONBodyLabels0, error)
AsIssuescreateJSONBodyLabels0 returns the union data inside the IssuescreateJSONBody_Labels_Item as a IssuescreateJSONBodyLabels0
func (IssuescreateJSONBody_Labels_Item) AsIssuescreateJSONBodyLabels1 ¶
func (t IssuescreateJSONBody_Labels_Item) AsIssuescreateJSONBodyLabels1() (IssuescreateJSONBodyLabels1, error)
AsIssuescreateJSONBodyLabels1 returns the union data inside the IssuescreateJSONBody_Labels_Item as a IssuescreateJSONBodyLabels1
func (*IssuescreateJSONBody_Labels_Item) FromIssuescreateJSONBodyLabels0 ¶
func (t *IssuescreateJSONBody_Labels_Item) FromIssuescreateJSONBodyLabels0(v IssuescreateJSONBodyLabels0) error
FromIssuescreateJSONBodyLabels0 overwrites any union data inside the IssuescreateJSONBody_Labels_Item as the provided IssuescreateJSONBodyLabels0
func (*IssuescreateJSONBody_Labels_Item) FromIssuescreateJSONBodyLabels1 ¶
func (t *IssuescreateJSONBody_Labels_Item) FromIssuescreateJSONBodyLabels1(v IssuescreateJSONBodyLabels1) error
FromIssuescreateJSONBodyLabels1 overwrites any union data inside the IssuescreateJSONBody_Labels_Item as the provided IssuescreateJSONBodyLabels1
func (IssuescreateJSONBody_Labels_Item) MarshalJSON ¶
func (t IssuescreateJSONBody_Labels_Item) MarshalJSON() ([]byte, error)
func (*IssuescreateJSONBody_Labels_Item) MergeIssuescreateJSONBodyLabels0 ¶
func (t *IssuescreateJSONBody_Labels_Item) MergeIssuescreateJSONBodyLabels0(v IssuescreateJSONBodyLabels0) error
MergeIssuescreateJSONBodyLabels0 performs a merge with any union data inside the IssuescreateJSONBody_Labels_Item, using the provided IssuescreateJSONBodyLabels0
func (*IssuescreateJSONBody_Labels_Item) MergeIssuescreateJSONBodyLabels1 ¶
func (t *IssuescreateJSONBody_Labels_Item) MergeIssuescreateJSONBodyLabels1(v IssuescreateJSONBodyLabels1) error
MergeIssuescreateJSONBodyLabels1 performs a merge with any union data inside the IssuescreateJSONBody_Labels_Item, using the provided IssuescreateJSONBodyLabels1
func (*IssuescreateJSONBody_Labels_Item) UnmarshalJSON ¶
func (t *IssuescreateJSONBody_Labels_Item) UnmarshalJSON(b []byte) error
type IssuescreateJSONBody_Milestone ¶
type IssuescreateJSONBody_Milestone struct {
// contains filtered or unexported fields
}
IssuescreateJSONBody_Milestone defines parameters for Issuescreate.
func (IssuescreateJSONBody_Milestone) AsIssuescreateJSONBodyMilestone0 ¶
func (t IssuescreateJSONBody_Milestone) AsIssuescreateJSONBodyMilestone0() (IssuescreateJSONBodyMilestone0, error)
AsIssuescreateJSONBodyMilestone0 returns the union data inside the IssuescreateJSONBody_Milestone as a IssuescreateJSONBodyMilestone0
func (IssuescreateJSONBody_Milestone) AsIssuescreateJSONBodyMilestone1 ¶
func (t IssuescreateJSONBody_Milestone) AsIssuescreateJSONBodyMilestone1() (IssuescreateJSONBodyMilestone1, error)
AsIssuescreateJSONBodyMilestone1 returns the union data inside the IssuescreateJSONBody_Milestone as a IssuescreateJSONBodyMilestone1
func (*IssuescreateJSONBody_Milestone) FromIssuescreateJSONBodyMilestone0 ¶
func (t *IssuescreateJSONBody_Milestone) FromIssuescreateJSONBodyMilestone0(v IssuescreateJSONBodyMilestone0) error
FromIssuescreateJSONBodyMilestone0 overwrites any union data inside the IssuescreateJSONBody_Milestone as the provided IssuescreateJSONBodyMilestone0
func (*IssuescreateJSONBody_Milestone) FromIssuescreateJSONBodyMilestone1 ¶
func (t *IssuescreateJSONBody_Milestone) FromIssuescreateJSONBodyMilestone1(v IssuescreateJSONBodyMilestone1) error
FromIssuescreateJSONBodyMilestone1 overwrites any union data inside the IssuescreateJSONBody_Milestone as the provided IssuescreateJSONBodyMilestone1
func (IssuescreateJSONBody_Milestone) MarshalJSON ¶
func (t IssuescreateJSONBody_Milestone) MarshalJSON() ([]byte, error)
func (*IssuescreateJSONBody_Milestone) MergeIssuescreateJSONBodyMilestone0 ¶
func (t *IssuescreateJSONBody_Milestone) MergeIssuescreateJSONBodyMilestone0(v IssuescreateJSONBodyMilestone0) error
MergeIssuescreateJSONBodyMilestone0 performs a merge with any union data inside the IssuescreateJSONBody_Milestone, using the provided IssuescreateJSONBodyMilestone0
func (*IssuescreateJSONBody_Milestone) MergeIssuescreateJSONBodyMilestone1 ¶
func (t *IssuescreateJSONBody_Milestone) MergeIssuescreateJSONBodyMilestone1(v IssuescreateJSONBodyMilestone1) error
MergeIssuescreateJSONBodyMilestone1 performs a merge with any union data inside the IssuescreateJSONBody_Milestone, using the provided IssuescreateJSONBodyMilestone1
func (*IssuescreateJSONBody_Milestone) UnmarshalJSON ¶
func (t *IssuescreateJSONBody_Milestone) UnmarshalJSON(b []byte) error
type IssuescreateJSONBody_Title ¶
type IssuescreateJSONBody_Title struct {
// contains filtered or unexported fields
}
IssuescreateJSONBody_Title defines parameters for Issuescreate.
func (IssuescreateJSONBody_Title) AsIssuescreateJSONBodyTitle0 ¶
func (t IssuescreateJSONBody_Title) AsIssuescreateJSONBodyTitle0() (IssuescreateJSONBodyTitle0, error)
AsIssuescreateJSONBodyTitle0 returns the union data inside the IssuescreateJSONBody_Title as a IssuescreateJSONBodyTitle0
func (IssuescreateJSONBody_Title) AsIssuescreateJSONBodyTitle1 ¶
func (t IssuescreateJSONBody_Title) AsIssuescreateJSONBodyTitle1() (IssuescreateJSONBodyTitle1, error)
AsIssuescreateJSONBodyTitle1 returns the union data inside the IssuescreateJSONBody_Title as a IssuescreateJSONBodyTitle1
func (*IssuescreateJSONBody_Title) FromIssuescreateJSONBodyTitle0 ¶
func (t *IssuescreateJSONBody_Title) FromIssuescreateJSONBodyTitle0(v IssuescreateJSONBodyTitle0) error
FromIssuescreateJSONBodyTitle0 overwrites any union data inside the IssuescreateJSONBody_Title as the provided IssuescreateJSONBodyTitle0
func (*IssuescreateJSONBody_Title) FromIssuescreateJSONBodyTitle1 ¶
func (t *IssuescreateJSONBody_Title) FromIssuescreateJSONBodyTitle1(v IssuescreateJSONBodyTitle1) error
FromIssuescreateJSONBodyTitle1 overwrites any union data inside the IssuescreateJSONBody_Title as the provided IssuescreateJSONBodyTitle1
func (IssuescreateJSONBody_Title) MarshalJSON ¶
func (t IssuescreateJSONBody_Title) MarshalJSON() ([]byte, error)
func (*IssuescreateJSONBody_Title) MergeIssuescreateJSONBodyTitle0 ¶
func (t *IssuescreateJSONBody_Title) MergeIssuescreateJSONBodyTitle0(v IssuescreateJSONBodyTitle0) error
MergeIssuescreateJSONBodyTitle0 performs a merge with any union data inside the IssuescreateJSONBody_Title, using the provided IssuescreateJSONBodyTitle0
func (*IssuescreateJSONBody_Title) MergeIssuescreateJSONBodyTitle1 ¶
func (t *IssuescreateJSONBody_Title) MergeIssuescreateJSONBodyTitle1(v IssuescreateJSONBodyTitle1) error
MergeIssuescreateJSONBodyTitle1 performs a merge with any union data inside the IssuescreateJSONBody_Title, using the provided IssuescreateJSONBodyTitle1
func (*IssuescreateJSONBody_Title) UnmarshalJSON ¶
func (t *IssuescreateJSONBody_Title) UnmarshalJSON(b []byte) error
type IssuescreateJSONRequestBody ¶
type IssuescreateJSONRequestBody IssuescreateJSONBody
IssuescreateJSONRequestBody defines body for Issuescreate for application/json ContentType.
type IssuescreateResponse ¶
type IssuescreateResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *Issue
// Headers201 the parsed response headers for an HTTP 201 response
Headers201 *IssuescreateResponse201Headers
}
func ParseIssuescreateResponse ¶
func ParseIssuescreateResponse(rsp *http.Response) (*IssuescreateResponse, error)
ParseIssuescreateResponse parses an HTTP response from a IssuescreateWithResponse call
func (IssuescreateResponse) ContentType ¶
func (r IssuescreateResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (IssuescreateResponse) GetBody ¶
func (r IssuescreateResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (IssuescreateResponse) GetJSON201 ¶
func (r IssuescreateResponse) GetJSON201() *Issue
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (IssuescreateResponse) Status ¶
func (r IssuescreateResponse) Status() string
Status returns HTTPResponse.Status
func (IssuescreateResponse) StatusCode ¶
func (r IssuescreateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type IssuescreateResponse201Headers ¶
type IssuescreateResponse201Headers struct {
Location *string
}
IssuescreateResponse201Headers the declared response headers of an HTTP 201 response for Issuescreate
type IssuesgetResponse ¶
type IssuesgetResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *Issue
}
func ParseIssuesgetResponse ¶
func ParseIssuesgetResponse(rsp *http.Response) (*IssuesgetResponse, error)
ParseIssuesgetResponse parses an HTTP response from a IssuesgetWithResponse call
func (IssuesgetResponse) ContentType ¶
func (r IssuesgetResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (IssuesgetResponse) GetBody ¶
func (r IssuesgetResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (IssuesgetResponse) GetJSON200 ¶
func (r IssuesgetResponse) GetJSON200() *Issue
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (IssuesgetResponse) Status ¶
func (r IssuesgetResponse) Status() string
Status returns HTTPResponse.Status
func (IssuesgetResponse) StatusCode ¶
func (r IssuesgetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type IssueslistCommentsParams ¶
type IssueslistCommentsParams struct {
// Since Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
Since *Since `form:"since,omitempty" json:"since,omitempty"`
// PerPage The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
PerPage *PerPage `form:"per_page,omitempty" json:"per_page,omitempty"`
// Page The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Page *Page `form:"page,omitempty" json:"page,omitempty"`
}
IssueslistCommentsParams defines parameters for IssueslistComments.
type IssueslistCommentsResponse ¶
type IssueslistCommentsResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *IssuesListCommentsResult
// Headers200 the parsed response headers for an HTTP 200 response
Headers200 *IssueslistCommentsResponse200Headers
}
func ParseIssueslistCommentsResponse ¶
func ParseIssueslistCommentsResponse(rsp *http.Response) (*IssueslistCommentsResponse, error)
ParseIssueslistCommentsResponse parses an HTTP response from a IssueslistCommentsWithResponse call
func (IssueslistCommentsResponse) ContentType ¶
func (r IssueslistCommentsResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (IssueslistCommentsResponse) GetBody ¶
func (r IssueslistCommentsResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (IssueslistCommentsResponse) GetJSON200 ¶
func (r IssueslistCommentsResponse) GetJSON200() *IssuesListCommentsResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (IssueslistCommentsResponse) Status ¶
func (r IssueslistCommentsResponse) Status() string
Status returns HTTPResponse.Status
func (IssueslistCommentsResponse) StatusCode ¶
func (r IssueslistCommentsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type IssueslistCommentsResponse200Headers ¶
type IssueslistCommentsResponse200Headers struct {
Link *string
}
IssueslistCommentsResponse200Headers the declared response headers of an HTTP 200 response for IssueslistComments
type IssueslistForRepoParams ¶
type IssueslistForRepoParams struct {
// Milestone If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.
Milestone *string `form:"milestone,omitempty" json:"milestone,omitempty"`
// State Indicates the state of the issues to return.
State *IssueslistForRepoParamsState `form:"state,omitempty" json:"state,omitempty"`
// Assignee Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.
Assignee *string `form:"assignee,omitempty" json:"assignee,omitempty"`
// Type Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.
Type *string `form:"type,omitempty" json:"type,omitempty"`
// Creator The user that created the issue.
Creator *string `form:"creator,omitempty" json:"creator,omitempty"`
// Mentioned A user that's mentioned in the issue.
Mentioned *string `form:"mentioned,omitempty" json:"mentioned,omitempty"`
// IssueFieldValues A comma-separated list of issue field filters in `field_slug:value` format.
// Only issues matching all specified field values are returned.
// Requires issue fields to be enabled for the repository. Issue fields are
// not available for user-owned repositories, and field availability for
// organization-owned public repositories depends on the organization's
// visibility settings. For example, `priority:Urgent,severity:High` filters
// issues where the `priority` field is `Urgent` AND the `severity` field is
// `High`.
IssueFieldValues *string `form:"issue_field_values,omitempty" json:"issue_field_values,omitempty"`
// Labels A list of comma separated label names. Example: `bug,ui,@high`
Labels *Labels `form:"labels,omitempty" json:"labels,omitempty"`
// Sort What to sort results by.
Sort *IssueslistForRepoParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
// Direction The direction to sort the results by.
Direction *IssueslistForRepoParamsDirection `form:"direction,omitempty" json:"direction,omitempty"`
// Since Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
Since *Since `form:"since,omitempty" json:"since,omitempty"`
// PerPage The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
PerPage *PerPage `form:"per_page,omitempty" json:"per_page,omitempty"`
// Page The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Page *Page `form:"page,omitempty" json:"page,omitempty"`
}
IssueslistForRepoParams defines parameters for IssueslistForRepo.
type IssueslistForRepoParamsDirection ¶
type IssueslistForRepoParamsDirection string
IssueslistForRepoParamsDirection defines parameters for IssueslistForRepo.
const ( IssueslistForRepoParamsDirectionAsc IssueslistForRepoParamsDirection = "asc" IssueslistForRepoParamsDirectionDesc IssueslistForRepoParamsDirection = "desc" )
Defines values for IssueslistForRepoParamsDirection.
func (IssueslistForRepoParamsDirection) Valid ¶
func (e IssueslistForRepoParamsDirection) Valid() bool
Valid indicates whether the value is a known member of the IssueslistForRepoParamsDirection enum.
type IssueslistForRepoParamsSort ¶
type IssueslistForRepoParamsSort string
IssueslistForRepoParamsSort defines parameters for IssueslistForRepo.
const ( IssueslistForRepoParamsSortComments IssueslistForRepoParamsSort = "comments" IssueslistForRepoParamsSortCreated IssueslistForRepoParamsSort = "created" IssueslistForRepoParamsSortUpdated IssueslistForRepoParamsSort = "updated" )
Defines values for IssueslistForRepoParamsSort.
func (IssueslistForRepoParamsSort) Valid ¶
func (e IssueslistForRepoParamsSort) Valid() bool
Valid indicates whether the value is a known member of the IssueslistForRepoParamsSort enum.
type IssueslistForRepoParamsState ¶
type IssueslistForRepoParamsState string
IssueslistForRepoParamsState defines parameters for IssueslistForRepo.
const ( IssueslistForRepoParamsStateAll IssueslistForRepoParamsState = "all" IssueslistForRepoParamsStateClosed IssueslistForRepoParamsState = "closed" IssueslistForRepoParamsStateOpen IssueslistForRepoParamsState = "open" )
Defines values for IssueslistForRepoParamsState.
func (IssueslistForRepoParamsState) Valid ¶
func (e IssueslistForRepoParamsState) Valid() bool
Valid indicates whether the value is a known member of the IssueslistForRepoParamsState enum.
type IssueslistForRepoResponse ¶
type IssueslistForRepoResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *IssuesListForRepoResult
// Headers200 the parsed response headers for an HTTP 200 response
Headers200 *IssueslistForRepoResponse200Headers
}
func ParseIssueslistForRepoResponse ¶
func ParseIssueslistForRepoResponse(rsp *http.Response) (*IssueslistForRepoResponse, error)
ParseIssueslistForRepoResponse parses an HTTP response from a IssueslistForRepoWithResponse call
func (IssueslistForRepoResponse) ContentType ¶
func (r IssueslistForRepoResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (IssueslistForRepoResponse) GetBody ¶
func (r IssueslistForRepoResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (IssueslistForRepoResponse) GetJSON200 ¶
func (r IssueslistForRepoResponse) GetJSON200() *IssuesListForRepoResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (IssueslistForRepoResponse) Status ¶
func (r IssueslistForRepoResponse) Status() string
Status returns HTTPResponse.Status
func (IssueslistForRepoResponse) StatusCode ¶
func (r IssueslistForRepoResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type IssueslistForRepoResponse200Headers ¶
type IssueslistForRepoResponse200Headers struct {
Link *string
}
IssueslistForRepoResponse200Headers the declared response headers of an HTTP 200 response for IssueslistForRepo
type IssuesupdateJSONBody ¶
type IssuesupdateJSONBody struct {
// Assignees Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.
Assignees *[]IssuesupdateJSONBody_Assignees_Item `json:"assignees,omitempty"`
// Body The contents of the issue.
Body *string `json:"body,omitempty"`
// DuplicateIssueId The ID of the issue to mark as the canonical duplicate when `state_reason` is `duplicate`. The issue must exist and be accessible to the authenticated user. Ignored when `state_reason` is not `duplicate`.
DuplicateIssueId *int `json:"duplicate_issue_id,omitempty"`
// IssueFieldValues An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Only users with push access can set field values for issues
IssueFieldValues *[]struct {
// Confidence The confidence level for this field value choice.
Confidence *IssuesupdateJSONBodyIssueFieldValuesConfidence `json:"confidence,omitempty"`
// FieldId The ID of the issue field to set
FieldId int `json:"field_id"`
// Rationale Optional reasoning for setting this field value.
Rationale *string `json:"rationale,omitempty"`
// Suggest If `true`, the change is stored as a pending suggestion for human review rather than applied directly.
Suggest *bool `json:"suggest,omitempty"`
// Value The value to set for the field. For multi-select fields, provide an array of option names.
Value IssuesupdateJSONBody_IssueFieldValues_Value `json:"value"`
} `json:"issue_field_values,omitempty"`
// Labels Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.
Labels *[]IssuesupdateJSONBody_Labels_Item `json:"labels,omitempty"`
Milestone *IssuesupdateJSONBody_Milestone `json:"milestone,omitempty"`
// State The open or closed state of the issue.
State *IssuesupdateJSONBodyState `json:"state,omitempty"`
// StateReason The reason for the state change. Ignored unless `state` is changed.
StateReason *IssuesupdateJSONBodyStateReason `json:"state_reason,omitempty"`
// Title The title of the issue.
Title *IssuesupdateJSONBody_Title `json:"title,omitempty"`
// Type The issue type to associate with this issue. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.
Type *IssuesupdateJSONBody_Type `json:"type,omitempty"`
}
IssuesupdateJSONBody defines parameters for Issuesupdate.
type IssuesupdateJSONBodyAssignees0 ¶
type IssuesupdateJSONBodyAssignees0 = string
IssuesupdateJSONBodyAssignees0 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyAssignees1 ¶
type IssuesupdateJSONBodyAssignees1 struct {
// Confidence The confidence level for this assignee choice.
Confidence *IssuesupdateJSONBodyAssignees1Confidence `json:"confidence,omitempty"`
Login *string `json:"login,omitempty"`
// Rationale Optional reasoning for selecting this assignee.
Rationale *string `json:"rationale,omitempty"`
// Suggest If `true`, the change is stored as a pending suggestion for human review rather than applied directly.
Suggest *bool `json:"suggest,omitempty"`
}
IssuesupdateJSONBodyAssignees1 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyAssignees1Confidence ¶
type IssuesupdateJSONBodyAssignees1Confidence string
IssuesupdateJSONBodyAssignees1Confidence defines parameters for Issuesupdate.
const ( IssuesupdateJSONBodyAssignees1ConfidenceHigh IssuesupdateJSONBodyAssignees1Confidence = "high" IssuesupdateJSONBodyAssignees1ConfidenceLow IssuesupdateJSONBodyAssignees1Confidence = "low" IssuesupdateJSONBodyAssignees1ConfidenceMedium IssuesupdateJSONBodyAssignees1Confidence = "medium" )
Defines values for IssuesupdateJSONBodyAssignees1Confidence.
func (IssuesupdateJSONBodyAssignees1Confidence) Valid ¶
func (e IssuesupdateJSONBodyAssignees1Confidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesupdateJSONBodyAssignees1Confidence enum.
type IssuesupdateJSONBodyIssueFieldValuesConfidence ¶
type IssuesupdateJSONBodyIssueFieldValuesConfidence string
IssuesupdateJSONBodyIssueFieldValuesConfidence defines parameters for Issuesupdate.
const ( IssuesupdateJSONBodyIssueFieldValuesConfidenceHigh IssuesupdateJSONBodyIssueFieldValuesConfidence = "high" IssuesupdateJSONBodyIssueFieldValuesConfidenceLow IssuesupdateJSONBodyIssueFieldValuesConfidence = "low" IssuesupdateJSONBodyIssueFieldValuesConfidenceMedium IssuesupdateJSONBodyIssueFieldValuesConfidence = "medium" )
Defines values for IssuesupdateJSONBodyIssueFieldValuesConfidence.
func (IssuesupdateJSONBodyIssueFieldValuesConfidence) Valid ¶
func (e IssuesupdateJSONBodyIssueFieldValuesConfidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesupdateJSONBodyIssueFieldValuesConfidence enum.
type IssuesupdateJSONBodyIssueFieldValuesValue0 ¶
type IssuesupdateJSONBodyIssueFieldValuesValue0 = string
IssuesupdateJSONBodyIssueFieldValuesValue0 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyIssueFieldValuesValue1 ¶
type IssuesupdateJSONBodyIssueFieldValuesValue1 = float32
IssuesupdateJSONBodyIssueFieldValuesValue1 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyIssueFieldValuesValue2 ¶
type IssuesupdateJSONBodyIssueFieldValuesValue2 = []string
IssuesupdateJSONBodyIssueFieldValuesValue2 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyLabels0 ¶
type IssuesupdateJSONBodyLabels0 = string
IssuesupdateJSONBodyLabels0 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyLabels1 ¶
type IssuesupdateJSONBodyLabels1 struct {
Color *string `json:"color,omitempty"`
// Confidence The confidence level for this label choice.
Confidence *IssuesupdateJSONBodyLabels1Confidence `json:"confidence,omitempty"`
Description *string `json:"description,omitempty"`
Id *int `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
// Rationale Optional reasoning for selecting this label.
Rationale *string `json:"rationale,omitempty"`
// Suggest If `true`, the change is stored as a pending suggestion for human review rather than applied directly.
Suggest *bool `json:"suggest,omitempty"`
}
IssuesupdateJSONBodyLabels1 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyLabels1Confidence ¶
type IssuesupdateJSONBodyLabels1Confidence string
IssuesupdateJSONBodyLabels1Confidence defines parameters for Issuesupdate.
const ( IssuesupdateJSONBodyLabels1ConfidenceHigh IssuesupdateJSONBodyLabels1Confidence = "high" IssuesupdateJSONBodyLabels1ConfidenceLow IssuesupdateJSONBodyLabels1Confidence = "low" IssuesupdateJSONBodyLabels1ConfidenceMedium IssuesupdateJSONBodyLabels1Confidence = "medium" )
Defines values for IssuesupdateJSONBodyLabels1Confidence.
func (IssuesupdateJSONBodyLabels1Confidence) Valid ¶
func (e IssuesupdateJSONBodyLabels1Confidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesupdateJSONBodyLabels1Confidence enum.
type IssuesupdateJSONBodyMilestone0 ¶
type IssuesupdateJSONBodyMilestone0 = string
IssuesupdateJSONBodyMilestone0 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyMilestone1 ¶
type IssuesupdateJSONBodyMilestone1 = int
IssuesupdateJSONBodyMilestone1 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyState ¶
type IssuesupdateJSONBodyState string
IssuesupdateJSONBodyState defines parameters for Issuesupdate.
const ( IssuesupdateJSONBodyStateClosed IssuesupdateJSONBodyState = "closed" IssuesupdateJSONBodyStateOpen IssuesupdateJSONBodyState = "open" )
Defines values for IssuesupdateJSONBodyState.
func (IssuesupdateJSONBodyState) Valid ¶
func (e IssuesupdateJSONBodyState) Valid() bool
Valid indicates whether the value is a known member of the IssuesupdateJSONBodyState enum.
type IssuesupdateJSONBodyStateReason ¶
type IssuesupdateJSONBodyStateReason string
IssuesupdateJSONBodyStateReason defines parameters for Issuesupdate.
const ( IssuesupdateJSONBodyStateReasonCompleted IssuesupdateJSONBodyStateReason = "completed" IssuesupdateJSONBodyStateReasonDuplicate IssuesupdateJSONBodyStateReason = "duplicate" IssuesupdateJSONBodyStateReasonNotPlanned IssuesupdateJSONBodyStateReason = "not_planned" IssuesupdateJSONBodyStateReasonReopened IssuesupdateJSONBodyStateReason = "reopened" )
Defines values for IssuesupdateJSONBodyStateReason.
func (IssuesupdateJSONBodyStateReason) Valid ¶
func (e IssuesupdateJSONBodyStateReason) Valid() bool
Valid indicates whether the value is a known member of the IssuesupdateJSONBodyStateReason enum.
type IssuesupdateJSONBodyTitle0 ¶
type IssuesupdateJSONBodyTitle0 = string
IssuesupdateJSONBodyTitle0 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyTitle1 ¶
type IssuesupdateJSONBodyTitle1 = int
IssuesupdateJSONBodyTitle1 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyType0 ¶
type IssuesupdateJSONBodyType0 = string
IssuesupdateJSONBodyType0 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyType1 ¶
type IssuesupdateJSONBodyType1 struct {
// Confidence The confidence level for this type choice.
Confidence *IssuesupdateJSONBodyType1Confidence `json:"confidence,omitempty"`
// Rationale Optional reasoning for selecting this type.
Rationale *string `json:"rationale,omitempty"`
// Suggest If `true`, the change is stored as a pending suggestion for human review rather than applied directly.
Suggest *bool `json:"suggest,omitempty"`
// Value The name of the issue type to associate with this issue, or `null` to remove the current issue type.
Value *string `json:"value,omitempty"`
}
IssuesupdateJSONBodyType1 defines parameters for Issuesupdate.
type IssuesupdateJSONBodyType1Confidence ¶
type IssuesupdateJSONBodyType1Confidence string
IssuesupdateJSONBodyType1Confidence defines parameters for Issuesupdate.
const ( IssuesupdateJSONBodyType1ConfidenceHigh IssuesupdateJSONBodyType1Confidence = "high" IssuesupdateJSONBodyType1ConfidenceLow IssuesupdateJSONBodyType1Confidence = "low" IssuesupdateJSONBodyType1ConfidenceMedium IssuesupdateJSONBodyType1Confidence = "medium" )
Defines values for IssuesupdateJSONBodyType1Confidence.
func (IssuesupdateJSONBodyType1Confidence) Valid ¶
func (e IssuesupdateJSONBodyType1Confidence) Valid() bool
Valid indicates whether the value is a known member of the IssuesupdateJSONBodyType1Confidence enum.
type IssuesupdateJSONBody_Assignees_Item ¶
type IssuesupdateJSONBody_Assignees_Item struct {
// contains filtered or unexported fields
}
IssuesupdateJSONBody_Assignees_Item defines parameters for Issuesupdate.
func (IssuesupdateJSONBody_Assignees_Item) AsIssuesupdateJSONBodyAssignees0 ¶
func (t IssuesupdateJSONBody_Assignees_Item) AsIssuesupdateJSONBodyAssignees0() (IssuesupdateJSONBodyAssignees0, error)
AsIssuesupdateJSONBodyAssignees0 returns the union data inside the IssuesupdateJSONBody_Assignees_Item as a IssuesupdateJSONBodyAssignees0
func (IssuesupdateJSONBody_Assignees_Item) AsIssuesupdateJSONBodyAssignees1 ¶
func (t IssuesupdateJSONBody_Assignees_Item) AsIssuesupdateJSONBodyAssignees1() (IssuesupdateJSONBodyAssignees1, error)
AsIssuesupdateJSONBodyAssignees1 returns the union data inside the IssuesupdateJSONBody_Assignees_Item as a IssuesupdateJSONBodyAssignees1
func (*IssuesupdateJSONBody_Assignees_Item) FromIssuesupdateJSONBodyAssignees0 ¶
func (t *IssuesupdateJSONBody_Assignees_Item) FromIssuesupdateJSONBodyAssignees0(v IssuesupdateJSONBodyAssignees0) error
FromIssuesupdateJSONBodyAssignees0 overwrites any union data inside the IssuesupdateJSONBody_Assignees_Item as the provided IssuesupdateJSONBodyAssignees0
func (*IssuesupdateJSONBody_Assignees_Item) FromIssuesupdateJSONBodyAssignees1 ¶
func (t *IssuesupdateJSONBody_Assignees_Item) FromIssuesupdateJSONBodyAssignees1(v IssuesupdateJSONBodyAssignees1) error
FromIssuesupdateJSONBodyAssignees1 overwrites any union data inside the IssuesupdateJSONBody_Assignees_Item as the provided IssuesupdateJSONBodyAssignees1
func (IssuesupdateJSONBody_Assignees_Item) MarshalJSON ¶
func (t IssuesupdateJSONBody_Assignees_Item) MarshalJSON() ([]byte, error)
func (*IssuesupdateJSONBody_Assignees_Item) MergeIssuesupdateJSONBodyAssignees0 ¶
func (t *IssuesupdateJSONBody_Assignees_Item) MergeIssuesupdateJSONBodyAssignees0(v IssuesupdateJSONBodyAssignees0) error
MergeIssuesupdateJSONBodyAssignees0 performs a merge with any union data inside the IssuesupdateJSONBody_Assignees_Item, using the provided IssuesupdateJSONBodyAssignees0
func (*IssuesupdateJSONBody_Assignees_Item) MergeIssuesupdateJSONBodyAssignees1 ¶
func (t *IssuesupdateJSONBody_Assignees_Item) MergeIssuesupdateJSONBodyAssignees1(v IssuesupdateJSONBodyAssignees1) error
MergeIssuesupdateJSONBodyAssignees1 performs a merge with any union data inside the IssuesupdateJSONBody_Assignees_Item, using the provided IssuesupdateJSONBodyAssignees1
func (*IssuesupdateJSONBody_Assignees_Item) UnmarshalJSON ¶
func (t *IssuesupdateJSONBody_Assignees_Item) UnmarshalJSON(b []byte) error
type IssuesupdateJSONBody_IssueFieldValues_Value ¶
type IssuesupdateJSONBody_IssueFieldValues_Value struct {
// contains filtered or unexported fields
}
IssuesupdateJSONBody_IssueFieldValues_Value defines parameters for Issuesupdate.
func (IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue0 ¶
func (t IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue0() (IssuesupdateJSONBodyIssueFieldValuesValue0, error)
AsIssuesupdateJSONBodyIssueFieldValuesValue0 returns the union data inside the IssuesupdateJSONBody_IssueFieldValues_Value as a IssuesupdateJSONBodyIssueFieldValuesValue0
func (IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue1 ¶
func (t IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue1() (IssuesupdateJSONBodyIssueFieldValuesValue1, error)
AsIssuesupdateJSONBodyIssueFieldValuesValue1 returns the union data inside the IssuesupdateJSONBody_IssueFieldValues_Value as a IssuesupdateJSONBodyIssueFieldValuesValue1
func (IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue2 ¶
func (t IssuesupdateJSONBody_IssueFieldValues_Value) AsIssuesupdateJSONBodyIssueFieldValuesValue2() (IssuesupdateJSONBodyIssueFieldValuesValue2, error)
AsIssuesupdateJSONBodyIssueFieldValuesValue2 returns the union data inside the IssuesupdateJSONBody_IssueFieldValues_Value as a IssuesupdateJSONBodyIssueFieldValuesValue2
func (*IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue0 ¶
func (t *IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue0(v IssuesupdateJSONBodyIssueFieldValuesValue0) error
FromIssuesupdateJSONBodyIssueFieldValuesValue0 overwrites any union data inside the IssuesupdateJSONBody_IssueFieldValues_Value as the provided IssuesupdateJSONBodyIssueFieldValuesValue0
func (*IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue1 ¶
func (t *IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue1(v IssuesupdateJSONBodyIssueFieldValuesValue1) error
FromIssuesupdateJSONBodyIssueFieldValuesValue1 overwrites any union data inside the IssuesupdateJSONBody_IssueFieldValues_Value as the provided IssuesupdateJSONBodyIssueFieldValuesValue1
func (*IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue2 ¶
func (t *IssuesupdateJSONBody_IssueFieldValues_Value) FromIssuesupdateJSONBodyIssueFieldValuesValue2(v IssuesupdateJSONBodyIssueFieldValuesValue2) error
FromIssuesupdateJSONBodyIssueFieldValuesValue2 overwrites any union data inside the IssuesupdateJSONBody_IssueFieldValues_Value as the provided IssuesupdateJSONBodyIssueFieldValuesValue2
func (IssuesupdateJSONBody_IssueFieldValues_Value) MarshalJSON ¶
func (t IssuesupdateJSONBody_IssueFieldValues_Value) MarshalJSON() ([]byte, error)
func (*IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue0 ¶
func (t *IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue0(v IssuesupdateJSONBodyIssueFieldValuesValue0) error
MergeIssuesupdateJSONBodyIssueFieldValuesValue0 performs a merge with any union data inside the IssuesupdateJSONBody_IssueFieldValues_Value, using the provided IssuesupdateJSONBodyIssueFieldValuesValue0
func (*IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue1 ¶
func (t *IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue1(v IssuesupdateJSONBodyIssueFieldValuesValue1) error
MergeIssuesupdateJSONBodyIssueFieldValuesValue1 performs a merge with any union data inside the IssuesupdateJSONBody_IssueFieldValues_Value, using the provided IssuesupdateJSONBodyIssueFieldValuesValue1
func (*IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue2 ¶
func (t *IssuesupdateJSONBody_IssueFieldValues_Value) MergeIssuesupdateJSONBodyIssueFieldValuesValue2(v IssuesupdateJSONBodyIssueFieldValuesValue2) error
MergeIssuesupdateJSONBodyIssueFieldValuesValue2 performs a merge with any union data inside the IssuesupdateJSONBody_IssueFieldValues_Value, using the provided IssuesupdateJSONBodyIssueFieldValuesValue2
func (*IssuesupdateJSONBody_IssueFieldValues_Value) UnmarshalJSON ¶
func (t *IssuesupdateJSONBody_IssueFieldValues_Value) UnmarshalJSON(b []byte) error
type IssuesupdateJSONBody_Labels_Item ¶
type IssuesupdateJSONBody_Labels_Item struct {
// contains filtered or unexported fields
}
IssuesupdateJSONBody_Labels_Item defines parameters for Issuesupdate.
func (IssuesupdateJSONBody_Labels_Item) AsIssuesupdateJSONBodyLabels0 ¶
func (t IssuesupdateJSONBody_Labels_Item) AsIssuesupdateJSONBodyLabels0() (IssuesupdateJSONBodyLabels0, error)
AsIssuesupdateJSONBodyLabels0 returns the union data inside the IssuesupdateJSONBody_Labels_Item as a IssuesupdateJSONBodyLabels0
func (IssuesupdateJSONBody_Labels_Item) AsIssuesupdateJSONBodyLabels1 ¶
func (t IssuesupdateJSONBody_Labels_Item) AsIssuesupdateJSONBodyLabels1() (IssuesupdateJSONBodyLabels1, error)
AsIssuesupdateJSONBodyLabels1 returns the union data inside the IssuesupdateJSONBody_Labels_Item as a IssuesupdateJSONBodyLabels1
func (*IssuesupdateJSONBody_Labels_Item) FromIssuesupdateJSONBodyLabels0 ¶
func (t *IssuesupdateJSONBody_Labels_Item) FromIssuesupdateJSONBodyLabels0(v IssuesupdateJSONBodyLabels0) error
FromIssuesupdateJSONBodyLabels0 overwrites any union data inside the IssuesupdateJSONBody_Labels_Item as the provided IssuesupdateJSONBodyLabels0
func (*IssuesupdateJSONBody_Labels_Item) FromIssuesupdateJSONBodyLabels1 ¶
func (t *IssuesupdateJSONBody_Labels_Item) FromIssuesupdateJSONBodyLabels1(v IssuesupdateJSONBodyLabels1) error
FromIssuesupdateJSONBodyLabels1 overwrites any union data inside the IssuesupdateJSONBody_Labels_Item as the provided IssuesupdateJSONBodyLabels1
func (IssuesupdateJSONBody_Labels_Item) MarshalJSON ¶
func (t IssuesupdateJSONBody_Labels_Item) MarshalJSON() ([]byte, error)
func (*IssuesupdateJSONBody_Labels_Item) MergeIssuesupdateJSONBodyLabels0 ¶
func (t *IssuesupdateJSONBody_Labels_Item) MergeIssuesupdateJSONBodyLabels0(v IssuesupdateJSONBodyLabels0) error
MergeIssuesupdateJSONBodyLabels0 performs a merge with any union data inside the IssuesupdateJSONBody_Labels_Item, using the provided IssuesupdateJSONBodyLabels0
func (*IssuesupdateJSONBody_Labels_Item) MergeIssuesupdateJSONBodyLabels1 ¶
func (t *IssuesupdateJSONBody_Labels_Item) MergeIssuesupdateJSONBodyLabels1(v IssuesupdateJSONBodyLabels1) error
MergeIssuesupdateJSONBodyLabels1 performs a merge with any union data inside the IssuesupdateJSONBody_Labels_Item, using the provided IssuesupdateJSONBodyLabels1
func (*IssuesupdateJSONBody_Labels_Item) UnmarshalJSON ¶
func (t *IssuesupdateJSONBody_Labels_Item) UnmarshalJSON(b []byte) error
type IssuesupdateJSONBody_Milestone ¶
type IssuesupdateJSONBody_Milestone struct {
// contains filtered or unexported fields
}
IssuesupdateJSONBody_Milestone defines parameters for Issuesupdate.
func (IssuesupdateJSONBody_Milestone) AsIssuesupdateJSONBodyMilestone0 ¶
func (t IssuesupdateJSONBody_Milestone) AsIssuesupdateJSONBodyMilestone0() (IssuesupdateJSONBodyMilestone0, error)
AsIssuesupdateJSONBodyMilestone0 returns the union data inside the IssuesupdateJSONBody_Milestone as a IssuesupdateJSONBodyMilestone0
func (IssuesupdateJSONBody_Milestone) AsIssuesupdateJSONBodyMilestone1 ¶
func (t IssuesupdateJSONBody_Milestone) AsIssuesupdateJSONBodyMilestone1() (IssuesupdateJSONBodyMilestone1, error)
AsIssuesupdateJSONBodyMilestone1 returns the union data inside the IssuesupdateJSONBody_Milestone as a IssuesupdateJSONBodyMilestone1
func (*IssuesupdateJSONBody_Milestone) FromIssuesupdateJSONBodyMilestone0 ¶
func (t *IssuesupdateJSONBody_Milestone) FromIssuesupdateJSONBodyMilestone0(v IssuesupdateJSONBodyMilestone0) error
FromIssuesupdateJSONBodyMilestone0 overwrites any union data inside the IssuesupdateJSONBody_Milestone as the provided IssuesupdateJSONBodyMilestone0
func (*IssuesupdateJSONBody_Milestone) FromIssuesupdateJSONBodyMilestone1 ¶
func (t *IssuesupdateJSONBody_Milestone) FromIssuesupdateJSONBodyMilestone1(v IssuesupdateJSONBodyMilestone1) error
FromIssuesupdateJSONBodyMilestone1 overwrites any union data inside the IssuesupdateJSONBody_Milestone as the provided IssuesupdateJSONBodyMilestone1
func (IssuesupdateJSONBody_Milestone) MarshalJSON ¶
func (t IssuesupdateJSONBody_Milestone) MarshalJSON() ([]byte, error)
func (*IssuesupdateJSONBody_Milestone) MergeIssuesupdateJSONBodyMilestone0 ¶
func (t *IssuesupdateJSONBody_Milestone) MergeIssuesupdateJSONBodyMilestone0(v IssuesupdateJSONBodyMilestone0) error
MergeIssuesupdateJSONBodyMilestone0 performs a merge with any union data inside the IssuesupdateJSONBody_Milestone, using the provided IssuesupdateJSONBodyMilestone0
func (*IssuesupdateJSONBody_Milestone) MergeIssuesupdateJSONBodyMilestone1 ¶
func (t *IssuesupdateJSONBody_Milestone) MergeIssuesupdateJSONBodyMilestone1(v IssuesupdateJSONBodyMilestone1) error
MergeIssuesupdateJSONBodyMilestone1 performs a merge with any union data inside the IssuesupdateJSONBody_Milestone, using the provided IssuesupdateJSONBodyMilestone1
func (*IssuesupdateJSONBody_Milestone) UnmarshalJSON ¶
func (t *IssuesupdateJSONBody_Milestone) UnmarshalJSON(b []byte) error
type IssuesupdateJSONBody_Title ¶
type IssuesupdateJSONBody_Title struct {
// contains filtered or unexported fields
}
IssuesupdateJSONBody_Title defines parameters for Issuesupdate.
func (IssuesupdateJSONBody_Title) AsIssuesupdateJSONBodyTitle0 ¶
func (t IssuesupdateJSONBody_Title) AsIssuesupdateJSONBodyTitle0() (IssuesupdateJSONBodyTitle0, error)
AsIssuesupdateJSONBodyTitle0 returns the union data inside the IssuesupdateJSONBody_Title as a IssuesupdateJSONBodyTitle0
func (IssuesupdateJSONBody_Title) AsIssuesupdateJSONBodyTitle1 ¶
func (t IssuesupdateJSONBody_Title) AsIssuesupdateJSONBodyTitle1() (IssuesupdateJSONBodyTitle1, error)
AsIssuesupdateJSONBodyTitle1 returns the union data inside the IssuesupdateJSONBody_Title as a IssuesupdateJSONBodyTitle1
func (*IssuesupdateJSONBody_Title) FromIssuesupdateJSONBodyTitle0 ¶
func (t *IssuesupdateJSONBody_Title) FromIssuesupdateJSONBodyTitle0(v IssuesupdateJSONBodyTitle0) error
FromIssuesupdateJSONBodyTitle0 overwrites any union data inside the IssuesupdateJSONBody_Title as the provided IssuesupdateJSONBodyTitle0
func (*IssuesupdateJSONBody_Title) FromIssuesupdateJSONBodyTitle1 ¶
func (t *IssuesupdateJSONBody_Title) FromIssuesupdateJSONBodyTitle1(v IssuesupdateJSONBodyTitle1) error
FromIssuesupdateJSONBodyTitle1 overwrites any union data inside the IssuesupdateJSONBody_Title as the provided IssuesupdateJSONBodyTitle1
func (IssuesupdateJSONBody_Title) MarshalJSON ¶
func (t IssuesupdateJSONBody_Title) MarshalJSON() ([]byte, error)
func (*IssuesupdateJSONBody_Title) MergeIssuesupdateJSONBodyTitle0 ¶
func (t *IssuesupdateJSONBody_Title) MergeIssuesupdateJSONBodyTitle0(v IssuesupdateJSONBodyTitle0) error
MergeIssuesupdateJSONBodyTitle0 performs a merge with any union data inside the IssuesupdateJSONBody_Title, using the provided IssuesupdateJSONBodyTitle0
func (*IssuesupdateJSONBody_Title) MergeIssuesupdateJSONBodyTitle1 ¶
func (t *IssuesupdateJSONBody_Title) MergeIssuesupdateJSONBodyTitle1(v IssuesupdateJSONBodyTitle1) error
MergeIssuesupdateJSONBodyTitle1 performs a merge with any union data inside the IssuesupdateJSONBody_Title, using the provided IssuesupdateJSONBodyTitle1
func (*IssuesupdateJSONBody_Title) UnmarshalJSON ¶
func (t *IssuesupdateJSONBody_Title) UnmarshalJSON(b []byte) error
type IssuesupdateJSONBody_Type ¶
type IssuesupdateJSONBody_Type struct {
// contains filtered or unexported fields
}
IssuesupdateJSONBody_Type defines parameters for Issuesupdate.
func (IssuesupdateJSONBody_Type) AsIssuesupdateJSONBodyType0 ¶
func (t IssuesupdateJSONBody_Type) AsIssuesupdateJSONBodyType0() (IssuesupdateJSONBodyType0, error)
AsIssuesupdateJSONBodyType0 returns the union data inside the IssuesupdateJSONBody_Type as a IssuesupdateJSONBodyType0
func (IssuesupdateJSONBody_Type) AsIssuesupdateJSONBodyType1 ¶
func (t IssuesupdateJSONBody_Type) AsIssuesupdateJSONBodyType1() (IssuesupdateJSONBodyType1, error)
AsIssuesupdateJSONBodyType1 returns the union data inside the IssuesupdateJSONBody_Type as a IssuesupdateJSONBodyType1
func (*IssuesupdateJSONBody_Type) FromIssuesupdateJSONBodyType0 ¶
func (t *IssuesupdateJSONBody_Type) FromIssuesupdateJSONBodyType0(v IssuesupdateJSONBodyType0) error
FromIssuesupdateJSONBodyType0 overwrites any union data inside the IssuesupdateJSONBody_Type as the provided IssuesupdateJSONBodyType0
func (*IssuesupdateJSONBody_Type) FromIssuesupdateJSONBodyType1 ¶
func (t *IssuesupdateJSONBody_Type) FromIssuesupdateJSONBodyType1(v IssuesupdateJSONBodyType1) error
FromIssuesupdateJSONBodyType1 overwrites any union data inside the IssuesupdateJSONBody_Type as the provided IssuesupdateJSONBodyType1
func (IssuesupdateJSONBody_Type) MarshalJSON ¶
func (t IssuesupdateJSONBody_Type) MarshalJSON() ([]byte, error)
func (*IssuesupdateJSONBody_Type) MergeIssuesupdateJSONBodyType0 ¶
func (t *IssuesupdateJSONBody_Type) MergeIssuesupdateJSONBodyType0(v IssuesupdateJSONBodyType0) error
MergeIssuesupdateJSONBodyType0 performs a merge with any union data inside the IssuesupdateJSONBody_Type, using the provided IssuesupdateJSONBodyType0
func (*IssuesupdateJSONBody_Type) MergeIssuesupdateJSONBodyType1 ¶
func (t *IssuesupdateJSONBody_Type) MergeIssuesupdateJSONBodyType1(v IssuesupdateJSONBodyType1) error
MergeIssuesupdateJSONBodyType1 performs a merge with any union data inside the IssuesupdateJSONBody_Type, using the provided IssuesupdateJSONBodyType1
func (*IssuesupdateJSONBody_Type) UnmarshalJSON ¶
func (t *IssuesupdateJSONBody_Type) UnmarshalJSON(b []byte) error
type IssuesupdateJSONRequestBody ¶
type IssuesupdateJSONRequestBody IssuesupdateJSONBody
IssuesupdateJSONRequestBody defines body for Issuesupdate for application/json ContentType.
type IssuesupdateResponse ¶
type IssuesupdateResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *IssuesUpdateResult
}
func ParseIssuesupdateResponse ¶
func ParseIssuesupdateResponse(rsp *http.Response) (*IssuesupdateResponse, error)
ParseIssuesupdateResponse parses an HTTP response from a IssuesupdateWithResponse call
func (IssuesupdateResponse) ContentType ¶
func (r IssuesupdateResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (IssuesupdateResponse) GetBody ¶
func (r IssuesupdateResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (IssuesupdateResponse) GetJSON200 ¶
func (r IssuesupdateResponse) GetJSON200() *IssuesUpdateResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (IssuesupdateResponse) Status ¶
func (r IssuesupdateResponse) Status() string
Status returns HTTPResponse.Status
func (IssuesupdateResponse) StatusCode ¶
func (r IssuesupdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type NullableGitUser ¶
type NullableGitUser struct {
Date *time.Time `json:"date,omitempty"`
Email *string `json:"email,omitempty"`
Name *string `json:"name,omitempty"`
}
NullableGitUser Metaproperties for Git author/committer information.
type NullableIntegration ¶
type NullableIntegration struct {
ClientId *string `json:"client_id,omitempty"`
CreatedAt time.Time `json:"created_at"`
Description *string `json:"description"`
// Events The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
Events []string `json:"events"`
ExternalUrl string `json:"external_url"`
HtmlUrl string `json:"html_url"`
// Id Unique identifier of the GitHub app
Id int `json:"id"`
// InstallationsCount The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
InstallationsCount *int `json:"installations_count,omitempty"`
// Name The name of the GitHub app
Name string `json:"name"`
NodeId string `json:"node_id"`
Owner NullableIntegration_Owner `json:"owner"`
// Permissions The set of permissions for the GitHub app
Permissions NullableIntegration_Permissions `json:"permissions"`
// Slug The slug name of the GitHub app
Slug *string `json:"slug,omitempty"`
UpdatedAt time.Time `json:"updated_at"`
}
NullableIntegration GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
type NullableIntegration_Owner ¶
type NullableIntegration_Owner struct {
// contains filtered or unexported fields
}
NullableIntegration_Owner defines model for NullableIntegration.Owner.
func (NullableIntegration_Owner) AsEnterprise ¶
func (t NullableIntegration_Owner) AsEnterprise() (Enterprise, error)
AsEnterprise returns the union data inside the NullableIntegration_Owner as a Enterprise
func (NullableIntegration_Owner) AsSimpleUser ¶
func (t NullableIntegration_Owner) AsSimpleUser() (SimpleUser, error)
AsSimpleUser returns the union data inside the NullableIntegration_Owner as a SimpleUser
func (*NullableIntegration_Owner) FromEnterprise ¶
func (t *NullableIntegration_Owner) FromEnterprise(v Enterprise) error
FromEnterprise overwrites any union data inside the NullableIntegration_Owner as the provided Enterprise
func (*NullableIntegration_Owner) FromSimpleUser ¶
func (t *NullableIntegration_Owner) FromSimpleUser(v SimpleUser) error
FromSimpleUser overwrites any union data inside the NullableIntegration_Owner as the provided SimpleUser
func (NullableIntegration_Owner) MarshalJSON ¶
func (t NullableIntegration_Owner) MarshalJSON() ([]byte, error)
func (*NullableIntegration_Owner) MergeEnterprise ¶
func (t *NullableIntegration_Owner) MergeEnterprise(v Enterprise) error
MergeEnterprise performs a merge with any union data inside the NullableIntegration_Owner, using the provided Enterprise
func (*NullableIntegration_Owner) MergeSimpleUser ¶
func (t *NullableIntegration_Owner) MergeSimpleUser(v SimpleUser) error
MergeSimpleUser performs a merge with any union data inside the NullableIntegration_Owner, using the provided SimpleUser
func (*NullableIntegration_Owner) UnmarshalJSON ¶
func (t *NullableIntegration_Owner) UnmarshalJSON(b []byte) error
type NullableIntegration_Permissions ¶
type NullableIntegration_Permissions struct {
Checks *string `json:"checks,omitempty"`
Contents *string `json:"contents,omitempty"`
Deployments *string `json:"deployments,omitempty"`
Issues *string `json:"issues,omitempty"`
Metadata *string `json:"metadata,omitempty"`
AdditionalProperties map[string]string `json:"-"`
}
NullableIntegration_Permissions The set of permissions for the GitHub app
func (NullableIntegration_Permissions) Get ¶
func (a NullableIntegration_Permissions) Get(fieldName string) (value string, found bool)
Getter for additional properties for NullableIntegration_Permissions. Returns the specified element and whether it was found
func (NullableIntegration_Permissions) MarshalJSON ¶
func (a NullableIntegration_Permissions) MarshalJSON() ([]byte, error)
Override default JSON handling for NullableIntegration_Permissions to handle AdditionalProperties
func (*NullableIntegration_Permissions) Set ¶
func (a *NullableIntegration_Permissions) Set(fieldName string, value string)
Setter for additional properties for NullableIntegration_Permissions
func (*NullableIntegration_Permissions) UnmarshalJSON ¶
func (a *NullableIntegration_Permissions) UnmarshalJSON(b []byte) error
Override default JSON handling for NullableIntegration_Permissions to handle AdditionalProperties
type NullableIssueComment ¶
type NullableIssueComment struct {
// AuthorAssociation How the author is associated with the repository.
AuthorAssociation *AuthorAssociation `json:"author_association,omitempty"`
// Body Contents of the issue comment
Body *string `json:"body,omitempty"`
BodyHtml *string `json:"body_html,omitempty"`
BodyText *string `json:"body_text,omitempty"`
CreatedAt time.Time `json:"created_at"`
HtmlUrl string `json:"html_url"`
// Id Unique identifier of the issue comment
Id int64 `json:"id"`
IssueUrl string `json:"issue_url"`
// Minimized Details about why an issue comment was minimized.
Minimized *NullableIssueCommentMinimized `json:"minimized,omitempty"`
NodeId string `json:"node_id"`
// PerformedViaGithubApp GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
PerformedViaGithubApp *NullableIntegration `json:"performed_via_github_app,omitempty"`
// Pin Context around who pinned an issue comment and when it was pinned.
Pin *NullablePinnedIssueComment `json:"pin,omitempty"`
Reactions *ReactionRollup `json:"reactions,omitempty"`
UpdatedAt time.Time `json:"updated_at"`
// Url URL for the issue comment
Url string `json:"url"`
// User A GitHub user.
User *NullableSimpleUser `json:"user"`
}
NullableIssueComment Comments provide a way for people to collaborate on an issue.
type NullableIssueCommentMinimized ¶
type NullableIssueCommentMinimized struct {
// Reason The reason the comment was minimized.
Reason *string `json:"reason"`
}
NullableIssueCommentMinimized Details about why an issue comment was minimized.
type NullableLicenseSimple ¶
type NullableLicenseSimple struct {
HtmlUrl *string `json:"html_url,omitempty"`
Key string `json:"key"`
Name string `json:"name"`
NodeId string `json:"node_id"`
SpdxId *string `json:"spdx_id"`
Url *string `json:"url"`
}
NullableLicenseSimple License Simple
type NullableMilestone ¶
type NullableMilestone struct {
ClosedAt *time.Time `json:"closed_at"`
ClosedIssues int `json:"closed_issues"`
CreatedAt time.Time `json:"created_at"`
// Creator A GitHub user.
Creator *NullableSimpleUser `json:"creator"`
Description *string `json:"description"`
DueOn *time.Time `json:"due_on"`
HtmlUrl string `json:"html_url"`
Id int `json:"id"`
LabelsUrl string `json:"labels_url"`
NodeId string `json:"node_id"`
// Number The number of the milestone.
Number int `json:"number"`
OpenIssues int `json:"open_issues"`
// State The state of the milestone.
State NullableMilestoneState `json:"state"`
// Title The title of the milestone.
Title string `json:"title"`
UpdatedAt time.Time `json:"updated_at"`
Url string `json:"url"`
}
NullableMilestone A collection of related issues and pull requests.
type NullableMilestoneState ¶
type NullableMilestoneState string
NullableMilestoneState The state of the milestone.
const ( NullableMilestoneStateClosed NullableMilestoneState = "closed" NullableMilestoneStateOpen NullableMilestoneState = "open" )
Defines values for NullableMilestoneState.
func (NullableMilestoneState) Valid ¶
func (e NullableMilestoneState) Valid() bool
Valid indicates whether the value is a known member of the NullableMilestoneState enum.
type NullablePinnedIssueComment ¶
type NullablePinnedIssueComment struct {
PinnedAt time.Time `json:"pinned_at"`
// PinnedBy A GitHub user.
PinnedBy *NullableSimpleUser `json:"pinned_by"`
}
NullablePinnedIssueComment Context around who pinned an issue comment and when it was pinned.
type NullableSimpleUser ¶
type NullableSimpleUser struct {
AvatarUrl string `json:"avatar_url"`
Email *string `json:"email,omitempty"`
EventsUrl string `json:"events_url"`
FollowersUrl string `json:"followers_url"`
FollowingUrl string `json:"following_url"`
GistsUrl string `json:"gists_url"`
GravatarId *string `json:"gravatar_id"`
HtmlUrl string `json:"html_url"`
Id int64 `json:"id"`
Login string `json:"login"`
Name *string `json:"name,omitempty"`
NodeId string `json:"node_id"`
OrganizationsUrl string `json:"organizations_url"`
ReceivedEventsUrl string `json:"received_events_url"`
ReposUrl string `json:"repos_url"`
SiteAdmin bool `json:"site_admin"`
StarredAt *string `json:"starred_at,omitempty"`
StarredUrl string `json:"starred_url"`
SubscriptionsUrl string `json:"subscriptions_url"`
Type string `json:"type"`
Url string `json:"url"`
UserViewType *string `json:"user_view_type,omitempty"`
}
NullableSimpleUser A GitHub user.
type NullableTeamSimple ¶
type NullableTeamSimple struct {
// Description Description of the team
Description *string `json:"description"`
// EnterpriseId Unique identifier of the enterprise to which this team belongs
EnterpriseId *int `json:"enterprise_id,omitempty"`
HtmlUrl string `json:"html_url"`
// Id Unique identifier of the team
Id int `json:"id"`
// LdapDn Distinguished Name (DN) that team maps to within LDAP environment
LdapDn *string `json:"ldap_dn,omitempty"`
MembersUrl string `json:"members_url"`
// Name Name of the team
Name string `json:"name"`
NodeId string `json:"node_id"`
// NotificationSetting The notification setting the team has set
NotificationSetting *string `json:"notification_setting,omitempty"`
// OrganizationId Unique identifier of the organization to which this team belongs
OrganizationId *int `json:"organization_id,omitempty"`
// Permission Permission that the team will have for its repositories
Permission string `json:"permission"`
// Privacy The level of privacy this team should have
Privacy *string `json:"privacy,omitempty"`
RepositoriesUrl string `json:"repositories_url"`
Slug string `json:"slug"`
// Type The ownership type of the team
Type NullableTeamSimpleType `json:"type"`
// Url URL for the team
Url string `json:"url"`
}
NullableTeamSimple Groups of organization members that gives permissions on specified repositories.
type NullableTeamSimpleType ¶
type NullableTeamSimpleType string
NullableTeamSimpleType The ownership type of the team
const ( NullableTeamSimpleTypeEnterprise NullableTeamSimpleType = "enterprise" NullableTeamSimpleTypeOrganization NullableTeamSimpleType = "organization" )
Defines values for NullableTeamSimpleType.
func (NullableTeamSimpleType) Valid ¶
func (e NullableTeamSimpleType) Valid() bool
Valid indicates whether the value is a known member of the NullableTeamSimpleType enum.
type PullRequest ¶
type PullRequest struct {
UnderscoreLinks struct {
// Comments Hypermedia Link
Comments Link `json:"comments"`
// Commits Hypermedia Link
Commits Link `json:"commits"`
// Html Hypermedia Link
Html Link `json:"html"`
// Issue Hypermedia Link
Issue Link `json:"issue"`
// ReviewComment Hypermedia Link
ReviewComment Link `json:"review_comment"`
// ReviewComments Hypermedia Link
ReviewComments Link `json:"review_comments"`
// Self Hypermedia Link
Self Link `json:"self"`
// Statuses Hypermedia Link
Statuses Link `json:"statuses"`
} `json:"_links"`
ActiveLockReason *string `json:"active_lock_reason,omitempty"`
Additions int `json:"additions"`
Assignees *[]SimpleUser `json:"assignees,omitempty"`
// AuthorAssociation How the author is associated with the repository.
AuthorAssociation AuthorAssociation `json:"author_association"`
// AutoMerge The status of auto merging a pull request.
AutoMerge *AutoMerge `json:"auto_merge"`
Base struct {
Label string `json:"label"`
Ref string `json:"ref"`
// Repo A repository on GitHub.
Repo Repository `json:"repo"`
Sha string `json:"sha"`
// User A GitHub user.
User SimpleUser `json:"user"`
} `json:"base"`
Body *string `json:"body"`
ChangedFiles int `json:"changed_files"`
ClosedAt *time.Time `json:"closed_at"`
Comments int `json:"comments"`
CommentsUrl string `json:"comments_url"`
Commits int `json:"commits"`
CommitsUrl string `json:"commits_url"`
CreatedAt time.Time `json:"created_at"`
Deletions int `json:"deletions"`
DiffUrl string `json:"diff_url"`
// Draft Indicates whether or not the pull request is a draft.
Draft *bool `json:"draft,omitempty"`
Head struct {
Label string `json:"label"`
Ref string `json:"ref"`
// Repo A repository on GitHub.
Repo Repository `json:"repo"`
Sha string `json:"sha"`
// User A GitHub user.
User SimpleUser `json:"user"`
} `json:"head"`
HtmlUrl string `json:"html_url"`
Id int64 `json:"id"`
IssueUrl string `json:"issue_url"`
Labels []struct {
// ArchivedBy The user who archived the label, or `null` if it has not been archived.
ArchivedBy *SimpleUser `json:"archived_by"`
Color string `json:"color"`
Default bool `json:"default"`
Description *string `json:"description"`
Id int64 `json:"id"`
Name string `json:"name"`
NodeId string `json:"node_id"`
Url string `json:"url"`
} `json:"labels"`
Locked bool `json:"locked"`
// MaintainerCanModify Indicates whether maintainers can modify the pull request.
MaintainerCanModify bool `json:"maintainer_can_modify"`
Mergeable *bool `json:"mergeable"`
MergeableState string `json:"mergeable_state"`
Merged bool `json:"merged"`
MergedAt *time.Time `json:"merged_at"`
// MergedBy A GitHub user.
MergedBy *NullableSimpleUser `json:"merged_by"`
// Milestone A collection of related issues and pull requests.
Milestone *NullableMilestone `json:"milestone"`
NodeId string `json:"node_id"`
// Number Number uniquely identifying the pull request within its repository.
Number int `json:"number"`
PatchUrl string `json:"patch_url"`
Rebaseable *bool `json:"rebaseable,omitempty"`
RequestedReviewers *[]SimpleUser `json:"requested_reviewers,omitempty"`
RequestedTeams *[]TeamSimple `json:"requested_teams,omitempty"`
ReviewCommentUrl string `json:"review_comment_url"`
ReviewComments int `json:"review_comments"`
ReviewCommentsUrl string `json:"review_comments_url"`
// Stack The stack information associated with a pull request.
Stack *PullRequestStack `json:"stack,omitempty"`
// State State of this Pull Request. Either `open` or `closed`.
State PullRequestState `json:"state"`
StatusesUrl string `json:"statuses_url"`
// Title The title of the pull request.
Title string `json:"title"`
UpdatedAt time.Time `json:"updated_at"`
Url string `json:"url"`
// User A GitHub user.
User SimpleUser `json:"user"`
}
PullRequest Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
type PullRequestMergeResult ¶
type PullRequestMergeResult struct {
Merged bool `json:"merged"`
Message string `json:"message"`
Sha string `json:"sha"`
}
PullRequestMergeResult Pull Request Merge Result
type PullRequestMinimal ¶
type PullRequestMinimal struct {
Base struct {
Ref string `json:"ref"`
Repo struct {
Id int64 `json:"id"`
Name string `json:"name"`
Url string `json:"url"`
} `json:"repo"`
Sha string `json:"sha"`
} `json:"base"`
Head struct {
Ref string `json:"ref"`
Repo struct {
Id int64 `json:"id"`
Name string `json:"name"`
Url string `json:"url"`
} `json:"repo"`
Sha string `json:"sha"`
} `json:"head"`
Id int64 `json:"id"`
Number int `json:"number"`
Url string `json:"url"`
}
PullRequestMinimal defines model for pull-request-minimal.
type PullRequestSimple ¶
type PullRequestSimple struct {
UnderscoreLinks struct {
// Comments Hypermedia Link
Comments Link `json:"comments"`
// Commits Hypermedia Link
Commits Link `json:"commits"`
// Html Hypermedia Link
Html Link `json:"html"`
// Issue Hypermedia Link
Issue Link `json:"issue"`
// ReviewComment Hypermedia Link
ReviewComment Link `json:"review_comment"`
// ReviewComments Hypermedia Link
ReviewComments Link `json:"review_comments"`
// Self Hypermedia Link
Self Link `json:"self"`
// Statuses Hypermedia Link
Statuses Link `json:"statuses"`
} `json:"_links"`
ActiveLockReason *string `json:"active_lock_reason,omitempty"`
Assignees *[]SimpleUser `json:"assignees,omitempty"`
// AuthorAssociation How the author is associated with the repository.
AuthorAssociation AuthorAssociation `json:"author_association"`
// AutoMerge The status of auto merging a pull request.
AutoMerge *AutoMerge `json:"auto_merge"`
Base struct {
Label string `json:"label"`
Ref string `json:"ref"`
// Repo A repository on GitHub.
Repo Repository `json:"repo"`
Sha string `json:"sha"`
// User A GitHub user.
User *NullableSimpleUser `json:"user"`
} `json:"base"`
Body *string `json:"body"`
ClosedAt *time.Time `json:"closed_at"`
CommentsUrl string `json:"comments_url"`
CommitsUrl string `json:"commits_url"`
CreatedAt time.Time `json:"created_at"`
DiffUrl string `json:"diff_url"`
// Draft Indicates whether or not the pull request is a draft.
Draft *bool `json:"draft,omitempty"`
Head struct {
Label string `json:"label"`
Ref string `json:"ref"`
// Repo A repository on GitHub.
Repo Repository `json:"repo"`
Sha string `json:"sha"`
// User A GitHub user.
User *NullableSimpleUser `json:"user"`
} `json:"head"`
HtmlUrl string `json:"html_url"`
Id int64 `json:"id"`
IssueUrl string `json:"issue_url"`
Labels []struct {
// ArchivedBy The user who archived the label, or `null` if it has not been archived.
ArchivedBy *SimpleUser `json:"archived_by"`
Color string `json:"color"`
Default bool `json:"default"`
Description string `json:"description"`
Id int64 `json:"id"`
Name string `json:"name"`
NodeId string `json:"node_id"`
Url string `json:"url"`
} `json:"labels"`
Locked bool `json:"locked"`
MergedAt *time.Time `json:"merged_at"`
// Milestone A collection of related issues and pull requests.
Milestone *NullableMilestone `json:"milestone"`
NodeId string `json:"node_id"`
Number int `json:"number"`
PatchUrl string `json:"patch_url"`
RequestedReviewers *[]SimpleUser `json:"requested_reviewers,omitempty"`
RequestedTeams *[]Team `json:"requested_teams,omitempty"`
ReviewCommentUrl string `json:"review_comment_url"`
ReviewCommentsUrl string `json:"review_comments_url"`
// Stack The stack information associated with a pull request.
Stack *PullRequestStack `json:"stack,omitempty"`
State string `json:"state"`
StatusesUrl string `json:"statuses_url"`
Title string `json:"title"`
UpdatedAt time.Time `json:"updated_at"`
Url string `json:"url"`
// User A GitHub user.
User *NullableSimpleUser `json:"user"`
}
PullRequestSimple Pull Request Simple
type PullRequestStack ¶
type PullRequestStack struct {
Base struct {
// Ref The base ref of the stack this pull request belongs to.
Ref string `json:"ref"`
// Sha The base SHA of the stack this pull request belongs to.
Sha string `json:"sha"`
} `json:"base"`
// Id The ID of the stack that this pull request belongs to.
Id *int `json:"id,omitempty"`
// Number The number of the stack that this pull request belongs to.
Number *int `json:"number,omitempty"`
// Position The one-based position of this pull request within the stack, where 1 is the bottom of the stack.
Position *int `json:"position,omitempty"`
// Size The total number of pull requests in the stack.
Size *int `json:"size,omitempty"`
}
PullRequestStack The stack information associated with a pull request.
type PullRequestState ¶
type PullRequestState string
PullRequestState State of this Pull Request. Either `open` or `closed`.
const ( PullRequestStateClosed PullRequestState = "closed" PullRequestStateOpen PullRequestState = "open" )
Defines values for PullRequestState.
func (PullRequestState) Valid ¶
func (e PullRequestState) Valid() bool
Valid indicates whether the value is a known member of the PullRequestState enum.
type PullsListResult ¶
type PullsListResult = []PullRequestSimple
PullsListResult defines model for pulls-list-result.
type PullscreateJSONBody ¶
type PullscreateJSONBody struct {
// Base The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
Base string `json:"base"`
// Body The contents of the pull request.
Body *string `json:"body,omitempty"`
// Draft Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more.
Draft *bool `json:"draft,omitempty"`
// Head The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.
Head string `json:"head"`
// HeadRepo The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.
HeadRepo *string `json:"head_repo,omitempty"`
// Issue An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.
Issue *int64 `json:"issue,omitempty"`
// MaintainerCanModify Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.
MaintainerCanModify *bool `json:"maintainer_can_modify,omitempty"`
// Title The title of the new pull request. Required unless `issue` is specified.
Title *string `json:"title,omitempty"`
}
PullscreateJSONBody defines parameters for Pullscreate.
type PullscreateJSONRequestBody ¶
type PullscreateJSONRequestBody PullscreateJSONBody
PullscreateJSONRequestBody defines body for Pullscreate for application/json ContentType.
type PullscreateResponse ¶
type PullscreateResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *PullRequest
// Headers201 the parsed response headers for an HTTP 201 response
Headers201 *PullscreateResponse201Headers
}
func ParsePullscreateResponse ¶
func ParsePullscreateResponse(rsp *http.Response) (*PullscreateResponse, error)
ParsePullscreateResponse parses an HTTP response from a PullscreateWithResponse call
func (PullscreateResponse) ContentType ¶
func (r PullscreateResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PullscreateResponse) GetBody ¶
func (r PullscreateResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PullscreateResponse) GetJSON201 ¶
func (r PullscreateResponse) GetJSON201() *PullRequest
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (PullscreateResponse) Status ¶
func (r PullscreateResponse) Status() string
Status returns HTTPResponse.Status
func (PullscreateResponse) StatusCode ¶
func (r PullscreateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PullscreateResponse201Headers ¶
type PullscreateResponse201Headers struct {
Location *string
}
PullscreateResponse201Headers the declared response headers of an HTTP 201 response for Pullscreate
type PullsgetResponse ¶
type PullsgetResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *PullRequest
}
func ParsePullsgetResponse ¶
func ParsePullsgetResponse(rsp *http.Response) (*PullsgetResponse, error)
ParsePullsgetResponse parses an HTTP response from a PullsgetWithResponse call
func (PullsgetResponse) ContentType ¶
func (r PullsgetResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PullsgetResponse) GetBody ¶
func (r PullsgetResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PullsgetResponse) GetJSON200 ¶
func (r PullsgetResponse) GetJSON200() *PullRequest
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PullsgetResponse) Status ¶
func (r PullsgetResponse) Status() string
Status returns HTTPResponse.Status
func (PullsgetResponse) StatusCode ¶
func (r PullsgetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PullslistParams ¶
type PullslistParams struct {
// State Either `open`, `closed`, or `all` to filter by state.
State *PullslistParamsState `form:"state,omitempty" json:"state,omitempty"`
// Head Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.
Head *string `form:"head,omitempty" json:"head,omitempty"`
// Base Filter pulls by base branch name. Example: `gh-pages`.
Base *string `form:"base,omitempty" json:"base,omitempty"`
// Sort What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.
Sort *PullslistParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
// Direction The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.
Direction *PullslistParamsDirection `form:"direction,omitempty" json:"direction,omitempty"`
// PerPage The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
PerPage *PerPage `form:"per_page,omitempty" json:"per_page,omitempty"`
// Page The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Page *Page `form:"page,omitempty" json:"page,omitempty"`
}
PullslistParams defines parameters for Pullslist.
type PullslistParamsDirection ¶
type PullslistParamsDirection string
PullslistParamsDirection defines parameters for Pullslist.
const ( PullslistParamsDirectionAsc PullslistParamsDirection = "asc" PullslistParamsDirectionDesc PullslistParamsDirection = "desc" )
Defines values for PullslistParamsDirection.
func (PullslistParamsDirection) Valid ¶
func (e PullslistParamsDirection) Valid() bool
Valid indicates whether the value is a known member of the PullslistParamsDirection enum.
type PullslistParamsSort ¶
type PullslistParamsSort string
PullslistParamsSort defines parameters for Pullslist.
const ( PullslistParamsSortCreated PullslistParamsSort = "created" PullslistParamsSortLongRunning PullslistParamsSort = "long-running" PullslistParamsSortPopularity PullslistParamsSort = "popularity" PullslistParamsSortUpdated PullslistParamsSort = "updated" )
Defines values for PullslistParamsSort.
func (PullslistParamsSort) Valid ¶
func (e PullslistParamsSort) Valid() bool
Valid indicates whether the value is a known member of the PullslistParamsSort enum.
type PullslistParamsState ¶
type PullslistParamsState string
PullslistParamsState defines parameters for Pullslist.
const ( PullslistParamsStateAll PullslistParamsState = "all" PullslistParamsStateClosed PullslistParamsState = "closed" PullslistParamsStateOpen PullslistParamsState = "open" )
Defines values for PullslistParamsState.
func (PullslistParamsState) Valid ¶
func (e PullslistParamsState) Valid() bool
Valid indicates whether the value is a known member of the PullslistParamsState enum.
type PullslistResponse ¶
type PullslistResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *PullsListResult
// Headers200 the parsed response headers for an HTTP 200 response
Headers200 *PullslistResponse200Headers
}
func ParsePullslistResponse ¶
func ParsePullslistResponse(rsp *http.Response) (*PullslistResponse, error)
ParsePullslistResponse parses an HTTP response from a PullslistWithResponse call
func (PullslistResponse) ContentType ¶
func (r PullslistResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PullslistResponse) GetBody ¶
func (r PullslistResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PullslistResponse) GetJSON200 ¶
func (r PullslistResponse) GetJSON200() *PullsListResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PullslistResponse) Status ¶
func (r PullslistResponse) Status() string
Status returns HTTPResponse.Status
func (PullslistResponse) StatusCode ¶
func (r PullslistResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PullslistResponse200Headers ¶
type PullslistResponse200Headers struct {
Link *string
}
PullslistResponse200Headers the declared response headers of an HTTP 200 response for Pullslist
type PullsmergeJSONBody ¶
type PullsmergeJSONBody struct {
// CommitMessage Extra detail to append to automatic commit message.
CommitMessage *string `json:"commit_message,omitempty"`
// CommitTitle Title for the automatic commit message.
CommitTitle *string `json:"commit_title,omitempty"`
// MergeMethod The merge method to use.
MergeMethod *PullsmergeJSONBodyMergeMethod `json:"merge_method,omitempty"`
// Sha SHA that pull request head must match to allow merge.
Sha *string `json:"sha,omitempty"`
}
PullsmergeJSONBody defines parameters for Pullsmerge.
type PullsmergeJSONBodyMergeMethod ¶
type PullsmergeJSONBodyMergeMethod string
PullsmergeJSONBodyMergeMethod defines parameters for Pullsmerge.
const ( PullsmergeJSONBodyMergeMethodMerge PullsmergeJSONBodyMergeMethod = "merge" PullsmergeJSONBodyMergeMethodRebase PullsmergeJSONBodyMergeMethod = "rebase" PullsmergeJSONBodyMergeMethodSquash PullsmergeJSONBodyMergeMethod = "squash" )
Defines values for PullsmergeJSONBodyMergeMethod.
func (PullsmergeJSONBodyMergeMethod) Valid ¶
func (e PullsmergeJSONBodyMergeMethod) Valid() bool
Valid indicates whether the value is a known member of the PullsmergeJSONBodyMergeMethod enum.
type PullsmergeJSONRequestBody ¶
type PullsmergeJSONRequestBody PullsmergeJSONBody
PullsmergeJSONRequestBody defines body for Pullsmerge for application/json ContentType.
type PullsmergeResponse ¶
type PullsmergeResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *PullRequestMergeResult
}
func ParsePullsmergeResponse ¶
func ParsePullsmergeResponse(rsp *http.Response) (*PullsmergeResponse, error)
ParsePullsmergeResponse parses an HTTP response from a PullsmergeWithResponse call
func (PullsmergeResponse) ContentType ¶
func (r PullsmergeResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PullsmergeResponse) GetBody ¶
func (r PullsmergeResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PullsmergeResponse) GetJSON200 ¶
func (r PullsmergeResponse) GetJSON200() *PullRequestMergeResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PullsmergeResponse) Status ¶
func (r PullsmergeResponse) Status() string
Status returns HTTPResponse.Status
func (PullsmergeResponse) StatusCode ¶
func (r PullsmergeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PullsupdateJSONBody ¶
type PullsupdateJSONBody struct {
// Base The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
Base *string `json:"base,omitempty"`
// Body The contents of the pull request.
Body *string `json:"body,omitempty"`
// MaintainerCanModify Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.
MaintainerCanModify *bool `json:"maintainer_can_modify,omitempty"`
// State State of this Pull Request. Either `open` or `closed`.
State *PullsupdateJSONBodyState `json:"state,omitempty"`
// Title The title of the pull request.
Title *string `json:"title,omitempty"`
}
PullsupdateJSONBody defines parameters for Pullsupdate.
type PullsupdateJSONBodyState ¶
type PullsupdateJSONBodyState string
PullsupdateJSONBodyState defines parameters for Pullsupdate.
const ( PullsupdateJSONBodyStateClosed PullsupdateJSONBodyState = "closed" PullsupdateJSONBodyStateOpen PullsupdateJSONBodyState = "open" )
Defines values for PullsupdateJSONBodyState.
func (PullsupdateJSONBodyState) Valid ¶
func (e PullsupdateJSONBodyState) Valid() bool
Valid indicates whether the value is a known member of the PullsupdateJSONBodyState enum.
type PullsupdateJSONRequestBody ¶
type PullsupdateJSONRequestBody PullsupdateJSONBody
PullsupdateJSONRequestBody defines body for Pullsupdate for application/json ContentType.
type PullsupdateResponse ¶
type PullsupdateResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *PullRequest
}
func ParsePullsupdateResponse ¶
func ParsePullsupdateResponse(rsp *http.Response) (*PullsupdateResponse, error)
ParsePullsupdateResponse parses an HTTP response from a PullsupdateWithResponse call
func (PullsupdateResponse) ContentType ¶
func (r PullsupdateResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PullsupdateResponse) GetBody ¶
func (r PullsupdateResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PullsupdateResponse) GetJSON200 ¶
func (r PullsupdateResponse) GetJSON200() *PullRequest
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PullsupdateResponse) Status ¶
func (r PullsupdateResponse) Status() string
Status returns HTTPResponse.Status
func (PullsupdateResponse) StatusCode ¶
func (r PullsupdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RateLimit ¶
type RateLimit struct {
Limit int `json:"limit"`
Remaining int `json:"remaining"`
Reset time.Time `json:"reset"`
}
RateLimit is the core rate limit a response reported.
func RateLimitOf ¶
RateLimitOf reads the rate limit a response's headers carry; zero when they carry none.
type ReactionRollup ¶
type ReactionRollup struct {
Plus1 int `json:"+1"`
Minus1 int `json:"-1"`
Confused int `json:"confused"`
Eyes int `json:"eyes"`
Heart int `json:"heart"`
Hooray int `json:"hooray"`
Laugh int `json:"laugh"`
Rocket int `json:"rocket"`
TotalCount int `json:"total_count"`
Url string `json:"url"`
}
ReactionRollup defines model for reaction-rollup.
type ReadyPullRequest ¶
type ReadyPullRequest struct {
Number int `json:"number"`
URL string `json:"url"`
Draft bool `json:"draft"`
}
ReadyPullRequest is a pull request after MarkPullRequestReady.
type Remote ¶
Remote is one repository on github.com, as its operations' owner and repo parameters name it.
func ParseRemote ¶
ParseRemote reads a git remote's URL (https or SSH, with or without .git) or owner/name.
type ReposListWebhookDeliveriesResult ¶
type ReposListWebhookDeliveriesResult = []HookDeliveryItem
ReposListWebhookDeliveriesResult defines model for repos-list-webhook-deliveries-result.
type ReposListWebhooksResult ¶
type ReposListWebhooksResult = []Hook
ReposListWebhooksResult defines model for repos-list-webhooks-result.
type ReposgetCommitParams ¶
type ReposgetCommitParams struct {
// Page The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Page *Page `form:"page,omitempty" json:"page,omitempty"`
// PerPage The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
PerPage *PerPage `form:"per_page,omitempty" json:"per_page,omitempty"`
}
ReposgetCommitParams defines parameters for ReposgetCommit.
type ReposgetCommitResponse ¶
type ReposgetCommitResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *Commit
}
func ParseReposgetCommitResponse ¶
func ParseReposgetCommitResponse(rsp *http.Response) (*ReposgetCommitResponse, error)
ParseReposgetCommitResponse parses an HTTP response from a ReposgetCommitWithResponse call
func (ReposgetCommitResponse) ContentType ¶
func (r ReposgetCommitResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ReposgetCommitResponse) GetBody ¶
func (r ReposgetCommitResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ReposgetCommitResponse) GetJSON200 ¶
func (r ReposgetCommitResponse) GetJSON200() *Commit
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ReposgetCommitResponse) Status ¶
func (r ReposgetCommitResponse) Status() string
Status returns HTTPResponse.Status
func (ReposgetCommitResponse) StatusCode ¶
func (r ReposgetCommitResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Repository ¶
type Repository struct {
// AllowAutoMerge Whether to allow Auto-merge to be used on pull requests.
AllowAutoMerge *bool `json:"allow_auto_merge,omitempty"`
// AllowForking Whether to allow forking this repo
AllowForking *bool `json:"allow_forking,omitempty"`
// AllowMergeCommit Whether to allow merge commits for pull requests.
AllowMergeCommit *bool `json:"allow_merge_commit,omitempty"`
// AllowRebaseMerge Whether to allow rebase merges for pull requests.
AllowRebaseMerge *bool `json:"allow_rebase_merge,omitempty"`
// AllowSquashMerge Whether to allow squash merges for pull requests.
AllowSquashMerge *bool `json:"allow_squash_merge,omitempty"`
// AllowUpdateBranch Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
AllowUpdateBranch *bool `json:"allow_update_branch,omitempty"`
// AnonymousAccessEnabled Whether anonymous git access is enabled for this repository
AnonymousAccessEnabled *bool `json:"anonymous_access_enabled,omitempty"`
ArchiveUrl string `json:"archive_url"`
// Archived Whether the repository is archived.
Archived bool `json:"archived"`
AssigneesUrl string `json:"assignees_url"`
BlobsUrl string `json:"blobs_url"`
BranchesUrl string `json:"branches_url"`
CloneUrl string `json:"clone_url"`
// CodeSearchIndexStatus The status of the code search index for this repository
CodeSearchIndexStatus *struct {
LexicalCommitSha *string `json:"lexical_commit_sha,omitempty"`
LexicalSearchOk *bool `json:"lexical_search_ok,omitempty"`
} `json:"code_search_index_status,omitempty"`
CollaboratorsUrl string `json:"collaborators_url"`
CommentsUrl string `json:"comments_url"`
CommitsUrl string `json:"commits_url"`
CompareUrl string `json:"compare_url"`
ContentsUrl string `json:"contents_url"`
ContributorsUrl string `json:"contributors_url"`
CreatedAt *time.Time `json:"created_at"`
// DefaultBranch The default branch of the repository.
DefaultBranch string `json:"default_branch"`
// DeleteBranchOnMerge Whether to delete head branches when pull requests are merged
DeleteBranchOnMerge *bool `json:"delete_branch_on_merge,omitempty"`
DeploymentsUrl string `json:"deployments_url"`
Description *string `json:"description"`
// Disabled Returns whether or not this repository disabled.
Disabled bool `json:"disabled"`
DownloadsUrl string `json:"downloads_url"`
EventsUrl string `json:"events_url"`
Fork bool `json:"fork"`
Forks int `json:"forks"`
ForksCount int `json:"forks_count"`
ForksUrl string `json:"forks_url"`
FullName string `json:"full_name"`
GitCommitsUrl string `json:"git_commits_url"`
GitRefsUrl string `json:"git_refs_url"`
GitTagsUrl string `json:"git_tags_url"`
GitUrl string `json:"git_url"`
// HasDiscussions Whether discussions are enabled.
HasDiscussions *bool `json:"has_discussions,omitempty"`
// HasIssues Whether issues are enabled.
HasIssues bool `json:"has_issues"`
HasPages bool `json:"has_pages"`
// HasProjects Whether projects are enabled.
HasProjects bool `json:"has_projects"`
// HasPullRequests Whether pull requests are enabled.
HasPullRequests *bool `json:"has_pull_requests,omitempty"`
// HasWiki Whether the wiki is enabled.
HasWiki bool `json:"has_wiki"`
Homepage *string `json:"homepage"`
HooksUrl string `json:"hooks_url"`
HtmlUrl string `json:"html_url"`
// Id Unique identifier of the repository
Id int64 `json:"id"`
// IsTemplate Whether this repository acts as a template that can be used to generate new repositories.
IsTemplate *bool `json:"is_template,omitempty"`
IssueCommentUrl string `json:"issue_comment_url"`
IssueEventsUrl string `json:"issue_events_url"`
IssuesUrl string `json:"issues_url"`
KeysUrl string `json:"keys_url"`
LabelsUrl string `json:"labels_url"`
Language *string `json:"language"`
LanguagesUrl string `json:"languages_url"`
// License License Simple
License *NullableLicenseSimple `json:"license"`
// MergeCommitMessage The default value for a merge commit message.
//
// - `PR_TITLE` - default to the pull request's title.
// - `PR_BODY` - default to the pull request's body.
// - `BLANK` - default to a blank commit message.
MergeCommitMessage *RepositoryMergeCommitMessage `json:"merge_commit_message,omitempty"`
// MergeCommitTitle The default value for a merge commit title.
//
// - `PR_TITLE` - default to the pull request's title.
// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
MergeCommitTitle *RepositoryMergeCommitTitle `json:"merge_commit_title,omitempty"`
MergesUrl string `json:"merges_url"`
MilestonesUrl string `json:"milestones_url"`
MirrorUrl *string `json:"mirror_url"`
// Name The name of the repository.
Name string `json:"name"`
NodeId string `json:"node_id"`
NotificationsUrl string `json:"notifications_url"`
OpenIssues int `json:"open_issues"`
OpenIssuesCount int `json:"open_issues_count"`
// Owner A GitHub user.
Owner SimpleUser `json:"owner"`
Permissions *struct {
Admin bool `json:"admin"`
Maintain *bool `json:"maintain,omitempty"`
Pull bool `json:"pull"`
Push bool `json:"push"`
Triage *bool `json:"triage,omitempty"`
} `json:"permissions,omitempty"`
// Private Whether the repository is private or public.
Private bool `json:"private"`
// PullRequestCreationPolicy The policy controlling who can create pull requests: all or collaborators_only.
PullRequestCreationPolicy *RepositoryPullRequestCreationPolicy `json:"pull_request_creation_policy,omitempty"`
PullsUrl string `json:"pulls_url"`
PushedAt *time.Time `json:"pushed_at"`
ReleasesUrl string `json:"releases_url"`
// Size The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
Size int `json:"size"`
// SquashMergeCommitMessage The default value for a squash merge commit message:
//
// - `PR_BODY` - default to the pull request's body.
// - `COMMIT_MESSAGES` - default to the branch's commit messages.
// - `BLANK` - default to a blank commit message.
SquashMergeCommitMessage *RepositorySquashMergeCommitMessage `json:"squash_merge_commit_message,omitempty"`
// SquashMergeCommitTitle The default value for a squash merge commit title:
//
// - `PR_TITLE` - default to the pull request's title.
// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
SquashMergeCommitTitle *RepositorySquashMergeCommitTitle `json:"squash_merge_commit_title,omitempty"`
SshUrl string `json:"ssh_url"`
StargazersCount int `json:"stargazers_count"`
StargazersUrl string `json:"stargazers_url"`
StarredAt *string `json:"starred_at,omitempty"`
StatusesUrl string `json:"statuses_url"`
SubscribersUrl string `json:"subscribers_url"`
SubscriptionUrl string `json:"subscription_url"`
SvnUrl string `json:"svn_url"`
TagsUrl string `json:"tags_url"`
TeamsUrl string `json:"teams_url"`
TempCloneToken *string `json:"temp_clone_token,omitempty"`
Topics *[]string `json:"topics,omitempty"`
TreesUrl string `json:"trees_url"`
UpdatedAt *time.Time `json:"updated_at"`
Url string `json:"url"`
// Visibility The repository visibility: public, private, or internal.
Visibility *string `json:"visibility,omitempty"`
Watchers int `json:"watchers"`
WatchersCount int `json:"watchers_count"`
// WebCommitSignoffRequired Whether to require contributors to sign off on web-based commits
WebCommitSignoffRequired *bool `json:"web_commit_signoff_required,omitempty"`
}
Repository A repository on GitHub.
type RepositoryMergeCommitMessage ¶
type RepositoryMergeCommitMessage string
RepositoryMergeCommitMessage The default value for a merge commit message.
- `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message.
const ( RepositoryMergeCommitMessageBLANK RepositoryMergeCommitMessage = "BLANK" RepositoryMergeCommitMessagePRBODY RepositoryMergeCommitMessage = "PR_BODY" RepositoryMergeCommitMessagePRTITLE RepositoryMergeCommitMessage = "PR_TITLE" )
Defines values for RepositoryMergeCommitMessage.
func (RepositoryMergeCommitMessage) Valid ¶
func (e RepositoryMergeCommitMessage) Valid() bool
Valid indicates whether the value is a known member of the RepositoryMergeCommitMessage enum.
type RepositoryMergeCommitTitle ¶
type RepositoryMergeCommitTitle string
RepositoryMergeCommitTitle The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
const ( RepositoryMergeCommitTitleMERGEMESSAGE RepositoryMergeCommitTitle = "MERGE_MESSAGE" RepositoryMergeCommitTitlePRTITLE RepositoryMergeCommitTitle = "PR_TITLE" )
Defines values for RepositoryMergeCommitTitle.
func (RepositoryMergeCommitTitle) Valid ¶
func (e RepositoryMergeCommitTitle) Valid() bool
Valid indicates whether the value is a known member of the RepositoryMergeCommitTitle enum.
type RepositoryPullRequestCreationPolicy ¶
type RepositoryPullRequestCreationPolicy string
RepositoryPullRequestCreationPolicy The policy controlling who can create pull requests: all or collaborators_only.
const ( RepositoryPullRequestCreationPolicyAll RepositoryPullRequestCreationPolicy = "all" RepositoryPullRequestCreationPolicyCollaboratorsOnly RepositoryPullRequestCreationPolicy = "collaborators_only" )
Defines values for RepositoryPullRequestCreationPolicy.
func (RepositoryPullRequestCreationPolicy) Valid ¶
func (e RepositoryPullRequestCreationPolicy) Valid() bool
Valid indicates whether the value is a known member of the RepositoryPullRequestCreationPolicy enum.
type RepositorySquashMergeCommitMessage ¶
type RepositorySquashMergeCommitMessage string
RepositorySquashMergeCommitMessage The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message.
const ( RepositorySquashMergeCommitMessageBLANK RepositorySquashMergeCommitMessage = "BLANK" RepositorySquashMergeCommitMessageCOMMITMESSAGES RepositorySquashMergeCommitMessage = "COMMIT_MESSAGES" RepositorySquashMergeCommitMessagePRBODY RepositorySquashMergeCommitMessage = "PR_BODY" )
Defines values for RepositorySquashMergeCommitMessage.
func (RepositorySquashMergeCommitMessage) Valid ¶
func (e RepositorySquashMergeCommitMessage) Valid() bool
Valid indicates whether the value is a known member of the RepositorySquashMergeCommitMessage enum.
type RepositorySquashMergeCommitTitle ¶
type RepositorySquashMergeCommitTitle string
RepositorySquashMergeCommitTitle The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
const ( RepositorySquashMergeCommitTitleCOMMITORPRTITLE RepositorySquashMergeCommitTitle = "COMMIT_OR_PR_TITLE" RepositorySquashMergeCommitTitlePRTITLE RepositorySquashMergeCommitTitle = "PR_TITLE" )
Defines values for RepositorySquashMergeCommitTitle.
func (RepositorySquashMergeCommitTitle) Valid ¶
func (e RepositorySquashMergeCommitTitle) Valid() bool
Valid indicates whether the value is a known member of the RepositorySquashMergeCommitTitle enum.
type ReposlistWebhookDeliveriesParams ¶
type ReposlistWebhookDeliveriesParams struct {
// PerPage The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
PerPage *PerPage `form:"per_page,omitempty" json:"per_page,omitempty"`
// Cursor Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.
Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`
// Status Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).
Status *ReposlistWebhookDeliveriesParamsStatus `form:"status,omitempty" json:"status,omitempty"`
}
ReposlistWebhookDeliveriesParams defines parameters for ReposlistWebhookDeliveries.
type ReposlistWebhookDeliveriesParamsStatus ¶
type ReposlistWebhookDeliveriesParamsStatus string
ReposlistWebhookDeliveriesParamsStatus defines parameters for ReposlistWebhookDeliveries.
const ( ReposlistWebhookDeliveriesParamsStatusFailure ReposlistWebhookDeliveriesParamsStatus = "failure" ReposlistWebhookDeliveriesParamsStatusSuccess ReposlistWebhookDeliveriesParamsStatus = "success" )
Defines values for ReposlistWebhookDeliveriesParamsStatus.
func (ReposlistWebhookDeliveriesParamsStatus) Valid ¶
func (e ReposlistWebhookDeliveriesParamsStatus) Valid() bool
Valid indicates whether the value is a known member of the ReposlistWebhookDeliveriesParamsStatus enum.
type ReposlistWebhookDeliveriesResponse ¶
type ReposlistWebhookDeliveriesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *ReposListWebhookDeliveriesResult
}
func ParseReposlistWebhookDeliveriesResponse ¶
func ParseReposlistWebhookDeliveriesResponse(rsp *http.Response) (*ReposlistWebhookDeliveriesResponse, error)
ParseReposlistWebhookDeliveriesResponse parses an HTTP response from a ReposlistWebhookDeliveriesWithResponse call
func (ReposlistWebhookDeliveriesResponse) ContentType ¶
func (r ReposlistWebhookDeliveriesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ReposlistWebhookDeliveriesResponse) GetBody ¶
func (r ReposlistWebhookDeliveriesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ReposlistWebhookDeliveriesResponse) GetJSON200 ¶
func (r ReposlistWebhookDeliveriesResponse) GetJSON200() *ReposListWebhookDeliveriesResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ReposlistWebhookDeliveriesResponse) Status ¶
func (r ReposlistWebhookDeliveriesResponse) Status() string
Status returns HTTPResponse.Status
func (ReposlistWebhookDeliveriesResponse) StatusCode ¶
func (r ReposlistWebhookDeliveriesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ReposlistWebhooksParams ¶
type ReposlistWebhooksParams struct {
// PerPage The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
PerPage *PerPage `form:"per_page,omitempty" json:"per_page,omitempty"`
// Page The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Page *Page `form:"page,omitempty" json:"page,omitempty"`
}
ReposlistWebhooksParams defines parameters for ReposlistWebhooks.
type ReposlistWebhooksResponse ¶
type ReposlistWebhooksResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *ReposListWebhooksResult
// Headers200 the parsed response headers for an HTTP 200 response
Headers200 *ReposlistWebhooksResponse200Headers
}
func ParseReposlistWebhooksResponse ¶
func ParseReposlistWebhooksResponse(rsp *http.Response) (*ReposlistWebhooksResponse, error)
ParseReposlistWebhooksResponse parses an HTTP response from a ReposlistWebhooksWithResponse call
func (ReposlistWebhooksResponse) ContentType ¶
func (r ReposlistWebhooksResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ReposlistWebhooksResponse) GetBody ¶
func (r ReposlistWebhooksResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ReposlistWebhooksResponse) GetJSON200 ¶
func (r ReposlistWebhooksResponse) GetJSON200() *ReposListWebhooksResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ReposlistWebhooksResponse) Status ¶
func (r ReposlistWebhooksResponse) Status() string
Status returns HTTPResponse.Status
func (ReposlistWebhooksResponse) StatusCode ¶
func (r ReposlistWebhooksResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ReposlistWebhooksResponse200Headers ¶
type ReposlistWebhooksResponse200Headers struct {
Link *string
}
ReposlistWebhooksResponse200Headers the declared response headers of an HTTP 200 response for ReposlistWebhooks
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type SimpleUser ¶
type SimpleUser struct {
AvatarUrl string `json:"avatar_url"`
Email *string `json:"email,omitempty"`
EventsUrl string `json:"events_url"`
FollowersUrl string `json:"followers_url"`
FollowingUrl string `json:"following_url"`
GistsUrl string `json:"gists_url"`
GravatarId *string `json:"gravatar_id"`
HtmlUrl string `json:"html_url"`
Id int64 `json:"id"`
Login string `json:"login"`
Name *string `json:"name,omitempty"`
NodeId string `json:"node_id"`
OrganizationsUrl string `json:"organizations_url"`
ReceivedEventsUrl string `json:"received_events_url"`
ReposUrl string `json:"repos_url"`
SiteAdmin bool `json:"site_admin"`
StarredAt *string `json:"starred_at,omitempty"`
StarredUrl string `json:"starred_url"`
SubscriptionsUrl string `json:"subscriptions_url"`
Type string `json:"type"`
Url string `json:"url"`
UserViewType *string `json:"user_view_type,omitempty"`
}
SimpleUser A GitHub user.
type Status ¶
type Status string
Status defines model for status.
type StatusError ¶
StatusError is a response GitHub answered with a status the operation does not succeed with; Message is GitHub's own body.
func (*StatusError) Error ¶
func (failure *StatusError) Error() string
type SubIssuesSummary ¶
type SubIssuesSummary struct {
Completed int `json:"completed"`
PercentCompleted int `json:"percent_completed"`
Total int `json:"total"`
}
SubIssuesSummary defines model for sub-issues-summary.
type Team ¶
type Team struct {
// AccessSource How the team's access to the repository was granted. This property is only
// present when the team is returned in a repository context, such as
// `GET /repos/{owner}/{repo}/teams`.
AccessSource *TeamAccessSource `json:"access_source,omitempty"`
Description *string `json:"description"`
// EnterpriseId Unique identifier of the enterprise to which this team belongs
EnterpriseId *int `json:"enterprise_id,omitempty"`
HtmlUrl string `json:"html_url"`
Id int `json:"id"`
MembersUrl string `json:"members_url"`
Name string `json:"name"`
NodeId string `json:"node_id"`
NotificationSetting *string `json:"notification_setting,omitempty"`
// OrganizationId Unique identifier of the organization to which this team belongs
OrganizationId *int `json:"organization_id,omitempty"`
// Parent Groups of organization members that gives permissions on specified repositories.
Parent *NullableTeamSimple `json:"parent"`
Permission string `json:"permission"`
Permissions *struct {
Admin bool `json:"admin"`
Maintain bool `json:"maintain"`
Pull bool `json:"pull"`
Push bool `json:"push"`
Triage bool `json:"triage"`
} `json:"permissions,omitempty"`
Privacy *string `json:"privacy,omitempty"`
RepositoriesUrl string `json:"repositories_url"`
Slug string `json:"slug"`
// Type The ownership type of the team
Type TeamType `json:"type"`
Url string `json:"url"`
}
Team Groups of organization members that gives permissions on specified repositories.
type TeamAccessSource ¶
type TeamAccessSource string
TeamAccessSource How the team's access to the repository was granted. This property is only present when the team is returned in a repository context, such as `GET /repos/{owner}/{repo}/teams`.
const ( TeamAccessSourceDirect TeamAccessSource = "direct" TeamAccessSourceEnterprise TeamAccessSource = "enterprise" TeamAccessSourceOrganization TeamAccessSource = "organization" )
Defines values for TeamAccessSource.
func (TeamAccessSource) Valid ¶
func (e TeamAccessSource) Valid() bool
Valid indicates whether the value is a known member of the TeamAccessSource enum.
type TeamSimple ¶
type TeamSimple struct {
// Description Description of the team
Description *string `json:"description"`
// EnterpriseId Unique identifier of the enterprise to which this team belongs
EnterpriseId *int `json:"enterprise_id,omitempty"`
HtmlUrl string `json:"html_url"`
// Id Unique identifier of the team
Id int `json:"id"`
// LdapDn Distinguished Name (DN) that team maps to within LDAP environment
LdapDn *string `json:"ldap_dn,omitempty"`
MembersUrl string `json:"members_url"`
// Name Name of the team
Name string `json:"name"`
NodeId string `json:"node_id"`
// NotificationSetting The notification setting the team has set
NotificationSetting *string `json:"notification_setting,omitempty"`
// OrganizationId Unique identifier of the organization to which this team belongs
OrganizationId *int `json:"organization_id,omitempty"`
// Permission Permission that the team will have for its repositories
Permission string `json:"permission"`
// Privacy The level of privacy this team should have
Privacy *string `json:"privacy,omitempty"`
RepositoriesUrl string `json:"repositories_url"`
Slug string `json:"slug"`
// Type The ownership type of the team
Type TeamSimpleType `json:"type"`
// Url URL for the team
Url string `json:"url"`
}
TeamSimple Groups of organization members that gives permissions on specified repositories.
type TeamSimpleType ¶
type TeamSimpleType string
TeamSimpleType The ownership type of the team
const ( TeamSimpleTypeEnterprise TeamSimpleType = "enterprise" TeamSimpleTypeOrganization TeamSimpleType = "organization" )
Defines values for TeamSimpleType.
func (TeamSimpleType) Valid ¶
func (e TeamSimpleType) Valid() bool
Valid indicates whether the value is a known member of the TeamSimpleType enum.
type TeamType ¶
type TeamType string
TeamType The ownership type of the team
Defines values for TeamType.
type Verification ¶
type Verification struct {
Payload *string `json:"payload"`
Reason string `json:"reason"`
Signature *string `json:"signature"`
Verified bool `json:"verified"`
VerifiedAt *string `json:"verified_at"`
}
Verification defines model for verification.
type WebhookConfig ¶
type WebhookConfig struct {
// ContentType The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
ContentType *WebhookConfigContentType `json:"content_type,omitempty"`
InsecureSsl *WebhookConfigInsecureSsl `json:"insecure_ssl,omitempty"`
// Secret If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
Secret *WebhookConfigSecret `json:"secret,omitempty"`
// Url The URL to which the payloads will be delivered.
Url *WebhookConfigUrl `json:"url,omitempty"`
}
WebhookConfig Configuration object of the webhook
type WebhookConfigContentType ¶
type WebhookConfigContentType = string
WebhookConfigContentType The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
type WebhookConfigInsecureSsl ¶
type WebhookConfigInsecureSsl struct {
// contains filtered or unexported fields
}
WebhookConfigInsecureSsl defines model for webhook-config-insecure-ssl.
func (WebhookConfigInsecureSsl) AsWebhookConfigInsecureSsl0 ¶
func (t WebhookConfigInsecureSsl) AsWebhookConfigInsecureSsl0() (WebhookConfigInsecureSsl0, error)
AsWebhookConfigInsecureSsl0 returns the union data inside the WebhookConfigInsecureSsl as a WebhookConfigInsecureSsl0
func (WebhookConfigInsecureSsl) AsWebhookConfigInsecureSsl1 ¶
func (t WebhookConfigInsecureSsl) AsWebhookConfigInsecureSsl1() (WebhookConfigInsecureSsl1, error)
AsWebhookConfigInsecureSsl1 returns the union data inside the WebhookConfigInsecureSsl as a WebhookConfigInsecureSsl1
func (*WebhookConfigInsecureSsl) FromWebhookConfigInsecureSsl0 ¶
func (t *WebhookConfigInsecureSsl) FromWebhookConfigInsecureSsl0(v WebhookConfigInsecureSsl0) error
FromWebhookConfigInsecureSsl0 overwrites any union data inside the WebhookConfigInsecureSsl as the provided WebhookConfigInsecureSsl0
func (*WebhookConfigInsecureSsl) FromWebhookConfigInsecureSsl1 ¶
func (t *WebhookConfigInsecureSsl) FromWebhookConfigInsecureSsl1(v WebhookConfigInsecureSsl1) error
FromWebhookConfigInsecureSsl1 overwrites any union data inside the WebhookConfigInsecureSsl as the provided WebhookConfigInsecureSsl1
func (WebhookConfigInsecureSsl) MarshalJSON ¶
func (t WebhookConfigInsecureSsl) MarshalJSON() ([]byte, error)
func (*WebhookConfigInsecureSsl) MergeWebhookConfigInsecureSsl0 ¶
func (t *WebhookConfigInsecureSsl) MergeWebhookConfigInsecureSsl0(v WebhookConfigInsecureSsl0) error
MergeWebhookConfigInsecureSsl0 performs a merge with any union data inside the WebhookConfigInsecureSsl, using the provided WebhookConfigInsecureSsl0
func (*WebhookConfigInsecureSsl) MergeWebhookConfigInsecureSsl1 ¶
func (t *WebhookConfigInsecureSsl) MergeWebhookConfigInsecureSsl1(v WebhookConfigInsecureSsl1) error
MergeWebhookConfigInsecureSsl1 performs a merge with any union data inside the WebhookConfigInsecureSsl, using the provided WebhookConfigInsecureSsl1
func (*WebhookConfigInsecureSsl) UnmarshalJSON ¶
func (t *WebhookConfigInsecureSsl) UnmarshalJSON(b []byte) error
type WebhookConfigInsecureSsl0 ¶
type WebhookConfigInsecureSsl0 = string
WebhookConfigInsecureSsl0 Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**
type WebhookConfigInsecureSsl1 ¶
type WebhookConfigInsecureSsl1 = float32
WebhookConfigInsecureSsl1 defines model for WebhookConfigInsecureSsl.1.
type WebhookConfigSecret ¶
type WebhookConfigSecret = string
WebhookConfigSecret If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
type WebhookConfigUrl ¶
type WebhookConfigUrl = string
WebhookConfigUrl The URL to which the payloads will be delivered.
type WebhookDeliveryStatus ¶
type WebhookDeliveryStatus string
WebhookDeliveryStatus defines model for webhook-delivery-status.
const ( WebhookDeliveryStatusFailure WebhookDeliveryStatus = "failure" WebhookDeliveryStatusSuccess WebhookDeliveryStatus = "success" )
Defines values for WebhookDeliveryStatus.
func (WebhookDeliveryStatus) Valid ¶
func (e WebhookDeliveryStatus) Valid() bool
Valid indicates whether the value is a known member of the WebhookDeliveryStatus enum.