Documentation ¶
Index ¶
- type ConduitConnectRequest
- type ConduitMetadata
- type DifferentialDiffSearchAttachments
- type DifferentialDiffSearchConstraints
- type DifferentialDiffSearchRequest
- type DifferentialGetCommitMessageRequest
- type DifferentialGetCommitPathsRequest
- type DifferentialQueryDiffsRequest
- type DifferentialQueryRequest
- type DifferentialRevisionSearchAttachments
- type DifferentialRevisionSearchConstraints
- type DifferentialRevisionSearchRequest
- type DiffusionQueryCommitsRequest
- type DiffusionRepositorySearchAttachments
- type DiffusionRepositorySearchConstraints
- type DiffusionRepositorySearchRequest
- type EdgeSearchRequest
- type FileDownloadRequest
- type HarbormasterBuildSearchConstraints
- type HarbormasterBuildSearchRequest
- type HarbormasterBuildableSearchConstraints
- type HarbormasterBuildableSearchRequest
- type MacroCreateMemeRequest
- type ManiphestCreateTaskRequest
- type ManiphestGetTaskTransactions
- type ManiphestQueryRequest
- type ManiphestRequestSearchOrder
- type ManiphestSearchAttachments
- type ManiphestSearchConstraints
- type ManiphestSearchRequest
- type PHIDLookupRequest
- type PHIDQueryRequest
- type PasteCreateRequest
- type PasteQueryRequest
- type PhrictionInfoRequest
- type ProjectQueryRequest
- type ProjectSearchAttachments
- type ProjectSearchConstraints
- type ProjectSearchRequest
- type RemarkupProcessRequest
- type RepositoryQueryRequest
- type Request
- type RequestInterface
- type TransactionSearchConstraints
- type TransactionSearchRequest
- type UserQueryRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConduitConnectRequest ¶
type ConduitConnectRequest struct { Client string `json:"client"` ClientVersion string `json:"clientVersion"` ClientDescription string `json:"clientDescription"` Host string `json:"host"` User string `json:"user"` AuthToken string `json:"authToken"` AuthSignature string `json:"authSignature"` }
ConduitConnectRequest represents a request to conduit.connect.
type ConduitMetadata ¶ added in v0.2.0
type ConduitMetadata struct { Scope string `json:"scope,omitempty"` ConnectionID string `json:"connectionID,omitempty"` AuthType string `json:"auth.type,omitempty"` AuthHost string `json:"auth.host,omitempty"` AuthKey string `json:"auth.key,omitempty"` AuthUser string `json:"auth.user,omitempty"` AuthSignature string `json:"auth.signature,omitempty"` Token string `json:"token,omitempty"` AccessToken string `json:"access_token,omitempty"` SessionKey string `json:"sessionKey,omitempty"` }
ConduitMetadata contains auth/API metadata included on Conduit requests.
type DifferentialDiffSearchAttachments ¶ added in v0.11.0
type DifferentialDiffSearchAttachments struct { // Get the local commits (if any) for each diff. Commits bool `json:"commits,omitempty"` }
DifferentialDiffSearchAttachments contains fields that specify what additional data should be returned with search results.
type DifferentialDiffSearchConstraints ¶ added in v0.11.0
type DifferentialDiffSearchConstraints struct { IDs []int `json:"ids,omitempty"` PHIDs []string `json:"phids,omitempty"` RevisionPHIDs []string `json:"revisionPHIDs,omitempty"` }
DifferentialDiffSearchConstraints describes search criteria for request.
type DifferentialDiffSearchRequest ¶ added in v0.11.0
type DifferentialDiffSearchRequest struct { // QueryKey is builtin or saved query to use. It is optional and sets // initial constraints. QueryKey string `json:"queryKey,omitempty"` // Constraints contains additional filters for results. Applied on top of // query if provided. Constraints *DifferentialDiffSearchConstraints `json:"constraints,omitempty"` // Attachments specified what additional data should be returned with each // result. Attachments *DifferentialDiffSearchAttachments `json:"attachments,omitempty"` *entities.Cursor Request }
DifferentialDiffSearchRequest represents a request to differential.diff.search API method.
type DifferentialGetCommitMessageRequest ¶ added in v0.5.0
type DifferentialGetCommitMessageRequest struct { RevisionID uint64 `json:"revision_id"` Fields []string `json:"fields"` Edit constants.DifferentialGetCommitMessageEditType `json:"edit"` Request }
DifferentialGetCommitMessageRequest represents a request to the differential.getcommitmessage call.
type DifferentialGetCommitPathsRequest ¶ added in v0.4.1
DifferentialGetCommitPathsRequest represents a request to the differential.getcommitpaths call.
type DifferentialQueryDiffsRequest ¶ added in v0.4.0
type DifferentialQueryDiffsRequest struct { IDs []uint64 `json:"ids"` RevisionIDs []uint64 `json:"revisionIDs"` Request }
DifferentialQueryDiffsRequest represents a request to the differential.querydiffs call.
type DifferentialQueryRequest ¶
type DifferentialQueryRequest struct { Authors []string `json:"authors"` CCs []string `json:"ccs"` Reviewers []string `json:"reviewers"` Paths [][]string `json:"paths"` CommitHashes [][]string `json:"commitHashes"` Status constants.DifferentialStatusLegacy `json:"status"` Order constants.DifferentialQueryOrder `json:"order"` Limit uint64 `json:"limit"` Offset uint64 `json:"offset"` IDs []uint64 `json:"ids"` PHIDs []string `json:"phids"` Subscribers []string `json:"subscribers"` ResponsibleUsers []string `json:"responsibleUsers"` Branches []string `json:"branches"` Request }
DifferentialQueryRequest represents a request to the differential.query call.
type DifferentialRevisionSearchAttachments ¶ added in v0.7.0
type DifferentialRevisionSearchAttachments struct { // Reviewers requests to get the reviewers for each revision. Reviewers bool `json:"reviewers,omitempty"` // Subscribers if true instructs server to return subscribers list for each task. Subscribers bool `json:"subscribers,omitempty"` // Projects requests to get information about projects. Projects bool `json:"projects,omitempty"` }
DifferentialRevisionSearchAttachments contains fields that specify what additional data should be returned with search results.
type DifferentialRevisionSearchConstraints ¶ added in v0.7.0
type DifferentialRevisionSearchConstraints struct { IDs []int `json:"ids,omitempty"` PHIDs []string `json:"phids,omitempty"` ResponsiblePHIDs []string `json:"responsiblePHIDs,omitempty"` AuthorPHIDs []string `json:"authorPHIDs,omitempty"` ReviewerPHIDs []string `json:"reviewerPHIDs,omitempty"` RepositoryPHIDs []string `json:"repositoryPHIDs,omitempty"` Statuses []string `json:"statuses,omitempty"` CreatedStart *util.UnixTimestamp `json:"createdStart,omitempty"` CreatedEnd *util.UnixTimestamp `json:"createdEnd,omitempty"` ModifiedStart *util.UnixTimestamp `json:"modifiedStart,omitempty"` ModifiedEnd *util.UnixTimestamp `json:"modifiedEnd,omitempty"` Query string `json:"query,omitempty"` Subscribers []string `json:"subscribers,omitempty"` Projects []string `json:"projects,omitempty"` }
DifferentialRevisionSearchConstraints describes search criteria for request.
type DifferentialRevisionSearchRequest ¶ added in v0.7.0
type DifferentialRevisionSearchRequest struct { // QueryKey is builtin or saved query to use. It is optional and sets // initial constraints. QueryKey string `json:"queryKey,omitempty"` // Constraints contains additional filters for results. Applied on top of // query if provided. Constraints *DifferentialRevisionSearchConstraints `json:"constraints,omitempty"` // Attachments specified what additional data should be returned with each // result. Attachments *DifferentialRevisionSearchAttachments `json:"attachments,omitempty"` *entities.Cursor Request }
DifferentialRevisionSearchRequest represents a request to differential.revision.search API method.
type DiffusionQueryCommitsRequest ¶
type DiffusionQueryCommitsRequest struct { IDs []uint64 `json:"ids"` PHIDs []string `json:"phids"` Names []string `json:"names"` RepositoryPHID string `json:"repositoryPHID"` NeedMessages bool `json:"needMessages"` BypassCache bool `json:"bypassCache"` Before string `json:"before"` After string `json:"after"` Limit uint64 `json:"limit"` Request }
DiffusionQueryCommitsRequest represents a request to the diffusion.querycommits call.
type DiffusionRepositorySearchAttachments ¶ added in v0.9.0
type DiffusionRepositorySearchAttachments struct { // URIs returns a list of associated URIs for each repository. URIs bool `json:"uris,omitempty"` // Metrics returns commit count, most recent commit and other metrics // for each repository. Metrics bool `json:"metrics,omitempty"` // Projects requests to get information about projects. Projects bool `json:"projects,omitempty"` }
DiffusionRepositorySearchAttachments contains fields that specify what additional data should be returned with search results.
type DiffusionRepositorySearchConstraints ¶ added in v0.9.0
type DiffusionRepositorySearchConstraints struct { IDs []int `json:"ids,omitempty"` PHIDs []string `json:"phids,omitempty"` Callsigns []string `json:"callsigns,omitempty"` ShortNames []string `json:"shortnames,omitempty"` Status string `json:"status,omitempty"` Hosted string `json:"hosted,omitempty"` Types []string `json:"types,omitempty"` URIs []string `json:"uris,omitempty"` Projects []string `json:"projects,omitempty"` Owners []string `json:"owners,omitempty"` Spaces []string `json:"spaces,omitempty"` }
DiffusionRepositorySearchConstraints describes search criteria for request.
type DiffusionRepositorySearchRequest ¶ added in v0.9.0
type DiffusionRepositorySearchRequest struct { // QueryKey is builtin or saved query to use. It is optional and sets // initial constraints. QueryKey string `json:"queryKey,omitempty"` // Constraints contains additional filters for results. Applied on top of // query if provided. Constraints *DiffusionRepositorySearchConstraints `json:"constraints,omitempty"` // Attachments specified what additional data should be returned with each // result. Attachments *DiffusionRepositorySearchAttachments `json:"attachments,omitempty"` *entities.Cursor Request }
DiffusionRepositorySearchRequest represents a request to diffusion.repository.search API method.
type EdgeSearchRequest ¶ added in v0.10.0
type EdgeSearchRequest struct { SourcePHIDs []string `json:"sourcePHIDs"` Types []entities.EdgeType `json:"types"` DestinationPHIDs []string `json:"destinationPHIDs"` *entities.Cursor Request }
EdgeSearchRequest represents a request to the edge.search call.
type FileDownloadRequest ¶
FileDownloadRequest represents a call to file.download.
type HarbormasterBuildSearchConstraints ¶ added in v0.13.0
type HarbormasterBuildSearchConstraints struct { IDs []int `json:"ids,omitempty"` PHIDs []string `json:"phids,omitempty"` Plans []string `json:"plans,omitempty"` Buildables []string `json:"buildables,omitempty"` Statuses []entities.BuildStatus `json:"statuses,omitempty"` Initiators []string `json:"initiators,omitempty"` }
HarbormasterBuildSearchConstraints describes search criteria for request.
type HarbormasterBuildSearchRequest ¶ added in v0.13.0
type HarbormasterBuildSearchRequest struct { // QueryKey is builtin or saved query to use. It is optional and sets // initial constraints. QueryKey string `json:"queryKey,omitempty"` // Constraints contains additional filters for results. Applied on top of // query if provided. Constraints *HarbormasterBuildSearchConstraints `json:"constraints,omitempty"` *entities.Cursor Request }
HarbormasterBuildSearchRequest represents a request to harbormaster.build.search API method.
type HarbormasterBuildableSearchConstraints ¶ added in v0.9.0
type HarbormasterBuildableSearchConstraints struct { IDs []int `json:"ids,omitempty"` PHIDs []string `json:"phids,omitempty"` ObjectPHIDs []string `json:"objectPHIDs,omitempty"` ContainerPHIDs []string `json:"containerPHIDs,omitempty"` Statuses []entities.BuildableStatus `json:"statuses,omitempty"` Manual bool `json:"manual,omitempty"` }
HarbormasterBuildableSearchConstraints describes search criteria for request.
type HarbormasterBuildableSearchRequest ¶ added in v0.9.0
type HarbormasterBuildableSearchRequest struct { // QueryKey is builtin or saved query to use. It is optional and sets // initial constraints. QueryKey string `json:"queryKey,omitempty"` // Constraints contains additional filters for results. Applied on top of // query if provided. Constraints *HarbormasterBuildableSearchConstraints `json:"constraints,omitempty"` *entities.Cursor Request }
HarbormasterBuildableSearchRequest represents a request to harbormaster.buildable.search API method.
type MacroCreateMemeRequest ¶
type MacroCreateMemeRequest struct { MacroName string `json:"macroName"` UpperText string `json:"upperText"` LowerText string `json:"lowerText"` Request }
MacroCreateMemeRequest represents a call to macro.creatememe.
type ManiphestCreateTaskRequest ¶ added in v0.2.0
type ManiphestCreateTaskRequest struct { Title string `json:"title"` Description string `json:"description"` OwnerPHID string `json:"ownerPHID"` ViewPolicy string `json:"viewPolicy"` EditPolicy string `json:"editPolicy"` CCPHIDs []string `json:"ccPHIDs"` Priority int `json:"priority"` ProjectPHIDs []string `json:"projectPHIDs"` Request }
ManiphestCreateTaskRequest represents a request to maniphest.createtask.
type ManiphestGetTaskTransactions ¶ added in v0.3.0
ManiphestGetTaskTransactions represents a request to maniphest.gettasktransactions.
type ManiphestQueryRequest ¶
type ManiphestQueryRequest struct { IDs []string `json:"ids"` PHIDs []string `json:"phids"` OwnerPHIDs []string `json:"ownerPHIDs"` AuthorPHIDs []string `json:"authorPHIDs"` ProjectPHIDs []string `json:"projectPHIDs"` CCPHIDs []string `json:"ccPHIDs"` FullText string `json:"fullText"` Status constants.ManiphestTaskStatus `json:"status"` Order constants.ManiphestQueryOrder `json:"order"` Limit uint64 `json:"limit"` Offset uint64 `json:"offset"` Request }
ManiphestQueryRequest represents a request to maniphest.query.
type ManiphestRequestSearchOrder ¶ added in v0.3.3
type ManiphestRequestSearchOrder struct { // Builtin is the name of predefined order to use. Builtin string // Order is list of columns to use for sorting, e.g. ["color", "-name", "id"], Order []string }
ManiphestRequestSearchOrder describers how results should be ordered.
func (*ManiphestRequestSearchOrder) MarshalJSON ¶ added in v0.3.3
func (o *ManiphestRequestSearchOrder) MarshalJSON() ([]byte, error)
MarshalJSON creates JSON our of ManiphestRequestSearchOrder instance.
func (*ManiphestRequestSearchOrder) UnmarshalJSON ¶ added in v0.3.3
func (o *ManiphestRequestSearchOrder) UnmarshalJSON(data []byte) error
UnmarshalJSON parses JSON into an instance of ManiphestRequestSearchOrder type.
type ManiphestSearchAttachments ¶ added in v0.3.3
type ManiphestSearchAttachments struct { // Subscribers if true instructs server to return subscribers list for each task. Subscribers bool `json:"subscribers,omitempty"` // Columns requests to get the workboard columns where an object appears. Columns bool `json:"columns,omitempty"` // Projects requests to get information about projects. Projects bool `json:"projects,omitempty"` }
ManiphestSearchAttachments contains fields that specify what additional data should be returned with search results.
type ManiphestSearchConstraints ¶ added in v0.3.3
type ManiphestSearchConstraints struct { // IDs - search for objects with specific IDs. IDs []int `json:"ids,omitempty"` // PHIDs - search for objects with specific PHIDs. PHIDs []string `json:"phids,omitempty"` // AssignedTo - search for tasks owned by a user from a list. AssignedTo []string `json:"assigned,omitempty"` // Authors - search for tasks with given authors. Authors []string `json:"authorPHIDs,omitempty"` // Statuses - search for tasks with given statuses. Statuses []string `json:"statuses,omitempty"` // Priorities - search for tasks with given priorities. Priorities []int `json:"priorities,omitempty"` // Subtypes - search for tasks with given subtypes. Subtypes []string `json:"subtypes,omitempty"` // Column PHIDs ??? - no doc on phab site. ColumnPHIDs []string `json:"columnPHIDs,omitempty"` // OpenParents - search for tasks that have parents in open state. OpenParents *bool `json:"hasParents,omitempty"` // OpenSubtasks - search for tasks that have child tasks in open state. OpenSubtasks *bool `json:"hasSubtasks,omitempty"` // ParentIDs - search for children of these parents. ParentIDs []int `json:"parentIDs,omitempty"` // SubtaskIDs - Search for tasks that have these children. SubtaskIDs []int `json:"subtaskIDs,omitempty"` // CreatedAfter - search for tasks created after given date. CreatedAfter *util.UnixTimestamp `json:"createdStart,omitempty"` // CreatedBefore - search for tasks created before given date. CreatedBefore *util.UnixTimestamp `json:"createdEnd,omitempty"` // ModifiedAfter - search for tasks modified after given date. ModifiedAfter *util.UnixTimestamp `json:"modifiedStart,omitempty"` // ModifiedBefore - search for tasks modified before given date. ModifiedBefore *util.UnixTimestamp `json:"modifiedEnd,omitempty"` // ClosedAfter - search for tasks closed after given date. ClosedAfter *util.UnixTimestamp `json:"closedStart,omitempty"` // ClosedBefore - search for tasks closed before given date. ClosedBefore *util.UnixTimestamp `json:"closedEnd,omitempty"` // ClosedBy - search for tasks closed by people with given PHIDs. ClosedBy []string `json:"closerPHIDs,omitempty"` // Query - find objects matching a fulltext search query. Query string `json:"query,omitempty"` // Subscribers - search for objects with certain subscribers. Subscribers []string `json:"subscribers,omitempty"` // Projects - search for objects tagged with given projects. Projects []string `json:"projects,omitempty"` // Spaces - search for objects in certain spaces. Spaces []string `json:"spaces,omitempty"` }
ManiphestSearchConstraints describes search criteria for request.
type ManiphestSearchRequest ¶ added in v0.3.3
type ManiphestSearchRequest struct { // QueryKey is builtin or saved query to use. It is optional and sets initial constraints. QueryKey string `json:"queryKey,omitempty"` // Constraints contains additional filters for results. Applied on top of query if provided. Constraints *ManiphestSearchConstraints `json:"constraints,omitempty"` // Attachments specified what additional data should be returned with each result. Attachments *ManiphestSearchAttachments `json:"attachments,omitempty"` *entities.Cursor Request }
ManiphestSearchRequest represents a request to maniphest.search API method.
type PHIDLookupRequest ¶
PHIDLookupRequest represents a request to phid.lookup.
type PHIDQueryRequest ¶
PHIDQueryRequest represents a request to phid.query.
type PasteCreateRequest ¶
type PasteCreateRequest struct { Content string `json:"content"` // required Title string `json:"title"` // optional Language string `json:"language"` // optional Request }
PasteCreateRequest represents a request to paste.create.
type PasteQueryRequest ¶
type PasteQueryRequest struct { IDs []uint64 `json:"ids"` // optional PHIDs []string `json:"phids"` // optional AuthorPHIDs []string `json:"authorPHIDs"` // optional Offset uint64 `json:"after"` // optional Limit uint64 `json:"limit"` // optional Request }
PasteQueryRequest represents a request to paste.query.
type PhrictionInfoRequest ¶ added in v0.3.0
type ProjectQueryRequest ¶
type ProjectQueryRequest struct { IDs []string `json:"ids"` Names []string `json:"names"` PHIDs []string `json:"phids"` Slugs []string `json:"slugs"` Icons []string `json:"icons"` Colors []string `json:"colors"` Status constants.ProjectStatus `json:"status"` Members []string `json:"members"` Limit uint64 `json:"limit"` Offset uint64 `json:"offset"` Request }
ProjectQueryRequest represents a request to project.query.
type ProjectSearchAttachments ¶ added in v0.12.0
type ProjectSearchAttachments struct { // Members requests to get the member list for the project. Members bool `json:"members,omitempty"` // Watchers requests to get the watcher list for the project. Watchers bool `json:"watchers,omitempty"` // Ancestors requests to get the full ancestor list for each project. Ancestors bool `json:"ancestors,omitempty"` }
ProjectSearchAttachments contains fields that specify what additional data should be returned with search results.
type ProjectSearchConstraints ¶ added in v0.12.0
type ProjectSearchConstraints struct { IDs []int `json:"ids,omitempty"` PHIDs []string `json:"phids,omitempty"` Name string `json:"name,omitempty"` Slugs []string `json:"slugs,omitempty"` // use phids Members []string `json:"members,omitempty"` // use phids Watchers []string `json:"watchers,omitempty"` IsMilestone bool `json:"isMilestone,omitempty"` IsRoot bool `json:"isRoot,omitempty"` MinDepth int `json:"minDepth,omitempty"` MaxDepth int `json:"maxDepth,omitempty"` Subtypes []string `json:"subtypes,omitempty"` Icons []string `json:"icons,omitempty"` Colors []string `json:"colors,omitempty"` Parents []string `json:"parents,omitempty"` Ancestors []string `json:"ancestors,omitempty"` Query string `json:"query,omitempty"` Spaces []string `json:"spaces,omitempty"` }
ProjectSearchConstraints describes search criteria for request.
type ProjectSearchRequest ¶ added in v0.12.0
type ProjectSearchRequest struct { // QueryKey is builtin or saved query to use. It is optional and sets // initial constraints. QueryKey string `json:"queryKey,omitempty"` // Constraints contains additional filters for results. Applied on top of // query if provided. Constraints *ProjectSearchConstraints `json:"constraints,omitempty"` // Attachments specified what additional data should be returned with each // result. Attachments *ProjectSearchAttachments `json:"attachments,omitempty"` *entities.Cursor Request }
ProjectSearchRequest represents a request to project.search API method.
type RemarkupProcessRequest ¶ added in v0.3.0
type RemarkupProcessRequest struct { Context constants.RemarkupProcessContextType `json:"context"` Contents []string `json:"contents"` Request }
RemarkupProcessQuery represents a request to project.query.
type RepositoryQueryRequest ¶
type RepositoryQueryRequest struct { IDs []uint64 `json:"ids"` PHIDs []string `json:"phids"` Callsigns []string `json:"callsigns"` VCSTypes []string `json:"vcsTypes"` RemoteURIs []string `json:"remoteURIs"` UUIDs []string `json:"uuids"` Order string `json:"order"` Before string `json:"before"` After string `json:"after"` Limit uint64 `json:"limit"` Request }
RepositoryQueryRequest represents a request to the repository.query call.
type Request ¶
type Request struct {
Metadata *ConduitMetadata `json:"__conduit__,omitempty"`
}
Request is the base request struct.
func (*Request) GetMetadata ¶ added in v0.2.0
func (r *Request) GetMetadata() *ConduitMetadata
GetMetadata gets the inner Conduit metadata.
func (*Request) SetMetadata ¶ added in v0.2.0
func (r *Request) SetMetadata(metadata *ConduitMetadata)
SetMetadata sets the inner Conduit metadata.
type RequestInterface ¶ added in v0.2.0
type RequestInterface interface { GetMetadata() *ConduitMetadata SetMetadata(*ConduitMetadata) }
RequestInterface describes a base Conduit request
type TransactionSearchConstraints ¶ added in v0.11.0
type TransactionSearchConstraints struct { PHIDs []string `json:"phids,omitempty"` AuthorPHIDs []string `json:"authorPHIDs,omitempty"` }
TransactionSearchConstraints describes search criteria for request.
type TransactionSearchRequest ¶ added in v0.11.0
type TransactionSearchRequest struct { ObjectIdentifier string `json:"objectIdentifier"` // Constraints contains additional filters for results. Applied on top of // query if provided. Constraints *TransactionSearchConstraints `json:"constraints,omitempty"` *entities.Cursor Request }
TransactionSearchRequest represents a request to transaction.search API method.
type UserQueryRequest ¶ added in v0.3.0
type UserQueryRequest struct { Usernames []string `json:"usernames"` Emails []string `json:"emails"` RealNames []string `json:"realnames"` PHIDs []string `json:"phids"` IDs []string `json:"ids"` Offset int `json:"offset"` Limit int `json:"limit"` Request }
UserQueryRequest represents a request to user.query.